pulumi-azuredevops 3.6.0a1737523387__py3-none-any.whl → 3.7.0a1738589303__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. pulumi_azuredevops/__init__.py +64 -0
  2. pulumi_azuredevops/_inputs.py +120 -117
  3. pulumi_azuredevops/area_permissions.py +49 -49
  4. pulumi_azuredevops/branch_policy_auto_reviewers.py +7 -7
  5. pulumi_azuredevops/branch_policy_build_validation.py +7 -7
  6. pulumi_azuredevops/branch_policy_comment_resolution.py +7 -7
  7. pulumi_azuredevops/branch_policy_merge_types.py +7 -7
  8. pulumi_azuredevops/branch_policy_status_check.py +7 -7
  9. pulumi_azuredevops/branch_policy_work_item_linking.py +7 -7
  10. pulumi_azuredevops/build_definition.py +7 -7
  11. pulumi_azuredevops/check_branch_control.py +7 -7
  12. pulumi_azuredevops/check_business_hours.py +7 -7
  13. pulumi_azuredevops/check_exclusive_lock.py +7 -7
  14. pulumi_azuredevops/check_rest_api.py +986 -0
  15. pulumi_azuredevops/feed.py +8 -8
  16. pulumi_azuredevops/feed_permission.py +9 -9
  17. pulumi_azuredevops/feed_retention_policy.py +422 -0
  18. pulumi_azuredevops/get_agent_queue.py +2 -2
  19. pulumi_azuredevops/get_area.py +1 -1
  20. pulumi_azuredevops/get_client_config.py +3 -0
  21. pulumi_azuredevops/get_feed.py +4 -4
  22. pulumi_azuredevops/get_git_repository.py +8 -8
  23. pulumi_azuredevops/get_group.py +4 -4
  24. pulumi_azuredevops/get_groups.py +3 -3
  25. pulumi_azuredevops/get_identity_group.py +3 -0
  26. pulumi_azuredevops/get_identity_groups.py +1 -1
  27. pulumi_azuredevops/get_identity_users.py +5 -5
  28. pulumi_azuredevops/get_pool.py +14 -2
  29. pulumi_azuredevops/get_pools.py +3 -3
  30. pulumi_azuredevops/get_project.py +32 -0
  31. pulumi_azuredevops/get_projects.py +4 -4
  32. pulumi_azuredevops/get_repositories.py +7 -3
  33. pulumi_azuredevops/get_securityrole_definitions.py +4 -4
  34. pulumi_azuredevops/get_service_endpoint_azure_rm.py +5 -5
  35. pulumi_azuredevops/get_service_endpoint_github.py +6 -6
  36. pulumi_azuredevops/get_service_principal.py +153 -0
  37. pulumi_azuredevops/get_serviceendpoint_azurecr.py +1 -1
  38. pulumi_azuredevops/get_serviceendpoint_bitbucket.py +6 -6
  39. pulumi_azuredevops/get_serviceendpoint_npm.py +3 -3
  40. pulumi_azuredevops/get_serviceendpoint_sonarcloud.py +2 -2
  41. pulumi_azuredevops/get_team.py +4 -3
  42. pulumi_azuredevops/get_teams.py +2 -3
  43. pulumi_azuredevops/get_users.py +5 -9
  44. pulumi_azuredevops/git.py +7 -7
  45. pulumi_azuredevops/git_permissions.py +14 -21
  46. pulumi_azuredevops/git_repository_file.py +7 -14
  47. pulumi_azuredevops/group.py +21 -7
  48. pulumi_azuredevops/group_entitlement.py +16 -20
  49. pulumi_azuredevops/group_membership.py +35 -50
  50. pulumi_azuredevops/iterative_permissions.py +34 -34
  51. pulumi_azuredevops/library_permissions.py +75 -75
  52. pulumi_azuredevops/outputs.py +129 -102
  53. pulumi_azuredevops/pipeline_authorization.py +7 -7
  54. pulumi_azuredevops/pool.py +4 -4
  55. pulumi_azuredevops/project.py +114 -63
  56. pulumi_azuredevops/project_features.py +87 -45
  57. pulumi_azuredevops/project_permissions.py +7 -7
  58. pulumi_azuredevops/project_pipeline_settings.py +28 -35
  59. pulumi_azuredevops/project_tags.py +263 -0
  60. pulumi_azuredevops/pulumi-plugin.json +1 -1
  61. pulumi_azuredevops/queue.py +7 -14
  62. pulumi_azuredevops/repository_policy_author_email_pattern.py +21 -14
  63. pulumi_azuredevops/repository_policy_max_file_size.py +7 -7
  64. pulumi_azuredevops/resource_authorization.py +35 -35
  65. pulumi_azuredevops/service_endpoint_artifactory.py +24 -18
  66. pulumi_azuredevops/service_endpoint_aws.py +2 -2
  67. pulumi_azuredevops/service_endpoint_azure_ecr.py +13 -15
  68. pulumi_azuredevops/service_endpoint_azure_rm.py +25 -25
  69. pulumi_azuredevops/service_endpoint_bit_bucket.py +2 -2
  70. pulumi_azuredevops/service_endpoint_docker_registry.py +2 -2
  71. pulumi_azuredevops/service_endpoint_generic.py +2 -2
  72. pulumi_azuredevops/service_endpoint_generic_git.py +4 -8
  73. pulumi_azuredevops/service_endpoint_git_hub.py +15 -2
  74. pulumi_azuredevops/service_endpoint_git_hub_enterprise.py +15 -2
  75. pulumi_azuredevops/service_endpoint_kubernetes.py +23 -23
  76. pulumi_azuredevops/service_endpoint_npm.py +4 -4
  77. pulumi_azuredevops/service_endpoint_pipeline.py +4 -4
  78. pulumi_azuredevops/service_endpoint_service_fabric.py +48 -9
  79. pulumi_azuredevops/service_endpoint_sonar_cloud.py +11 -11
  80. pulumi_azuredevops/service_endpoint_sonar_qube.py +11 -11
  81. pulumi_azuredevops/service_endpoint_ssh.py +2 -6
  82. pulumi_azuredevops/service_principal_entitlement.py +386 -0
  83. pulumi_azuredevops/serviceendpoint_argocd.py +2 -2
  84. pulumi_azuredevops/serviceendpoint_azure_service_bus.py +2 -2
  85. pulumi_azuredevops/serviceendpoint_checkmarx_one.py +627 -0
  86. pulumi_azuredevops/serviceendpoint_checkmarx_sast.py +575 -0
  87. pulumi_azuredevops/serviceendpoint_checkmarx_sca.py +674 -0
  88. pulumi_azuredevops/serviceendpoint_dynamics_lifecycle_services.py +2 -2
  89. pulumi_azuredevops/serviceendpoint_externaltfs.py +63 -11
  90. pulumi_azuredevops/serviceendpoint_gcp_terraform.py +2 -2
  91. pulumi_azuredevops/serviceendpoint_incomingwebhook.py +2 -2
  92. pulumi_azuredevops/serviceendpoint_jenkins.py +2 -2
  93. pulumi_azuredevops/serviceendpoint_jfrog_artifactory_v2.py +18 -18
  94. pulumi_azuredevops/serviceendpoint_jfrog_distribution_v2.py +18 -18
  95. pulumi_azuredevops/serviceendpoint_jfrog_platform_v2.py +18 -18
  96. pulumi_azuredevops/serviceendpoint_jfrog_xray_v2.py +18 -18
  97. pulumi_azuredevops/serviceendpoint_maven.py +2 -2
  98. pulumi_azuredevops/serviceendpoint_nexus.py +2 -2
  99. pulumi_azuredevops/serviceendpoint_nuget.py +2 -2
  100. pulumi_azuredevops/serviceendpoint_octopusdeploy.py +2 -2
  101. pulumi_azuredevops/serviceendpoint_permissions.py +40 -40
  102. pulumi_azuredevops/serviceendpoint_snyk.py +2 -2
  103. pulumi_azuredevops/serviceendpoint_visualstudiomarketplace.py +4 -6
  104. pulumi_azuredevops/servicehook_permissions.py +51 -51
  105. pulumi_azuredevops/servicehook_storage_queue_pipelines.py +4 -4
  106. pulumi_azuredevops/tagging_permissions.py +49 -49
  107. pulumi_azuredevops/team.py +76 -56
  108. pulumi_azuredevops/team_administrators.py +83 -56
  109. pulumi_azuredevops/team_members.py +56 -49
  110. pulumi_azuredevops/variable_group.py +4 -2
  111. pulumi_azuredevops/variable_group_permissions.py +75 -75
  112. pulumi_azuredevops/wiki.py +15 -2
  113. pulumi_azuredevops/wiki_page.py +2 -2
  114. pulumi_azuredevops/work_item_query_permissions.py +7 -7
  115. {pulumi_azuredevops-3.6.0a1737523387.dist-info → pulumi_azuredevops-3.7.0a1738589303.dist-info}/METADATA +1 -1
  116. pulumi_azuredevops-3.7.0a1738589303.dist-info/RECORD +148 -0
  117. pulumi_azuredevops-3.6.0a1737523387.dist-info/RECORD +0 -140
  118. {pulumi_azuredevops-3.6.0a1737523387.dist-info → pulumi_azuredevops-3.7.0a1738589303.dist-info}/WHEEL +0 -0
  119. {pulumi_azuredevops-3.6.0a1737523387.dist-info → pulumi_azuredevops-3.7.0a1738589303.dist-info}/top_level.txt +0 -0
@@ -73,7 +73,7 @@ class GetGitRepositoryResult:
73
73
  @pulumi.getter
74
74
  def disabled(self) -> bool:
75
75
  """
76
- Is the repository disabled?
76
+ Indicates whether the repository is disabled.
77
77
  """
78
78
  return pulumi.get(self, "disabled")
79
79
 
@@ -94,7 +94,7 @@ class GetGitRepositoryResult:
94
94
  @pulumi.getter
95
95
  def name(self) -> str:
96
96
  """
97
- Git repository name.
97
+ The name of the Git repository.
98
98
  """
99
99
  return pulumi.get(self, "name")
100
100
 
@@ -134,7 +134,7 @@ class GetGitRepositoryResult:
134
134
  @pulumi.getter
135
135
  def url(self) -> str:
136
136
  """
137
- Details REST API endpoint for the Git Repository.
137
+ The details REST API endpoint for the Git Repository.
138
138
  """
139
139
  return pulumi.get(self, "url")
140
140
 
@@ -142,7 +142,7 @@ class GetGitRepositoryResult:
142
142
  @pulumi.getter(name="webUrl")
143
143
  def web_url(self) -> str:
144
144
  """
145
- Url of the Git repository web view
145
+ The Url of the Git repository web view
146
146
  """
147
147
  return pulumi.get(self, "web_url")
148
148
 
@@ -190,8 +190,8 @@ def get_git_repository(name: Optional[str] = None,
190
190
  - [Azure DevOps Service REST API 7.0 - Git API](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/?view=azure-devops-rest-7.0)
191
191
 
192
192
 
193
- :param str name: Name of the Git repository to retrieve
194
- :param str project_id: ID of project to list Git repositories
193
+ :param str name: The Name of the Git repository to retrieve
194
+ :param str project_id: The ID of project to list Git repositories
195
195
  """
196
196
  __args__ = dict()
197
197
  __args__['name'] = name
@@ -235,8 +235,8 @@ def get_git_repository_output(name: Optional[pulumi.Input[str]] = None,
235
235
  - [Azure DevOps Service REST API 7.0 - Git API](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/?view=azure-devops-rest-7.0)
236
236
 
237
237
 
238
- :param str name: Name of the Git repository to retrieve
239
- :param str project_id: ID of project to list Git repositories
238
+ :param str name: The Name of the Git repository to retrieve
239
+ :param str project_id: The ID of project to list Git repositories
240
240
  """
241
241
  __args__ = dict()
242
242
  __args__['name'] = name
@@ -147,8 +147,8 @@ def get_group(name: Optional[str] = None,
147
147
  - **Work Items**: Read
148
148
 
149
149
 
150
- :param str name: The Group Name.
151
- :param str project_id: The Project ID. If no project ID is specified the project collection groups will be searched.
150
+ :param str name: The Name of the Group.
151
+ :param str project_id: The ID of the Project. If `project_id` is not specified the project collection groups will be searched.
152
152
  """
153
153
  __args__ = dict()
154
154
  __args__['name'] = name
@@ -196,8 +196,8 @@ def get_group_output(name: Optional[pulumi.Input[str]] = None,
196
196
  - **Work Items**: Read
197
197
 
198
198
 
199
- :param str name: The Group Name.
200
- :param str project_id: The Project ID. If no project ID is specified the project collection groups will be searched.
199
+ :param str name: The Name of the Group.
200
+ :param str project_id: The ID of the Project. If `project_id` is not specified the project collection groups will be searched.
201
201
  """
202
202
  __args__ = dict()
203
203
  __args__['name'] = name
@@ -42,7 +42,7 @@ class GetGroupsResult:
42
42
  @pulumi.getter
43
43
  def groups(self) -> Sequence['outputs.GetGroupsGroupResult']:
44
44
  """
45
- A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:
45
+ A `groups` blocks as documented below. A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:
46
46
  """
47
47
  return pulumi.get(self, "groups")
48
48
 
@@ -94,7 +94,7 @@ def get_groups(project_id: Optional[str] = None,
94
94
  - [Azure DevOps Service REST API 7.0 - Groups - List](https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups/list?view=azure-devops-rest-7.0)
95
95
 
96
96
 
97
- :param str project_id: The Project ID. If no project ID is specified all groups of an organization will be returned
97
+ :param str project_id: The ID of the Project. If no project ID is specified all groups of an organization will be returned
98
98
  """
99
99
  __args__ = dict()
100
100
  __args__['projectId'] = project_id
@@ -128,7 +128,7 @@ def get_groups_output(project_id: Optional[pulumi.Input[Optional[str]]] = None,
128
128
  - [Azure DevOps Service REST API 7.0 - Groups - List](https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups/list?view=azure-devops-rest-7.0)
129
129
 
130
130
 
131
- :param str project_id: The Project ID. If no project ID is specified all groups of an organization will be returned
131
+ :param str project_id: The ID of the Project. If no project ID is specified all groups of an organization will be returned
132
132
  """
133
133
  __args__ = dict()
134
134
  __args__['projectId'] = project_id
@@ -43,6 +43,9 @@ class GetIdentityGroupResult:
43
43
  @property
44
44
  @pulumi.getter
45
45
  def descriptor(self) -> str:
46
+ """
47
+ The descriptor of the identity group.
48
+ """
46
49
  return pulumi.get(self, "descriptor")
47
50
 
48
51
  @property
@@ -42,7 +42,7 @@ class GetIdentityGroupsResult:
42
42
  @pulumi.getter
43
43
  def groups(self) -> Sequence['outputs.GetIdentityGroupsGroupResult']:
44
44
  """
45
- A set of existing groups in your Azure DevOps Organization or project with details about every single group which includes:
45
+ A `groups` blocks as documented below. A set of existing groups in your Azure DevOps Organization or project with details about every single group.
46
46
  """
47
47
  return pulumi.get(self, "groups")
48
48
 
@@ -43,6 +43,9 @@ class GetIdentityUsersResult:
43
43
  @property
44
44
  @pulumi.getter
45
45
  def descriptor(self) -> str:
46
+ """
47
+ The descriptor of the user.
48
+ """
46
49
  return pulumi.get(self, "descriptor")
47
50
 
48
51
  @property
@@ -56,9 +59,6 @@ class GetIdentityUsersResult:
56
59
  @property
57
60
  @pulumi.getter
58
61
  def name(self) -> str:
59
- """
60
- This is the PrincipalName of this identity member from the source provider. The source provider may change this field over time and it is not guaranteed to be immutable for the life of the identity member.
61
- """
62
62
  return pulumi.get(self, "name")
63
63
 
64
64
  @property
@@ -87,7 +87,7 @@ def get_identity_users(name: Optional[str] = None,
87
87
 
88
88
 
89
89
  :param str name: The PrincipalName of this identity member from the source provider.
90
- :param str search_filter: The type of search to perform. Default is `General`. Possible values are `AccountName`, `DisplayName`, and `MailAddress`.
90
+ :param str search_filter: The type of search to perform. Possible values are: `AccountName`, `DisplayName`, and `MailAddress`. Default is `General`.
91
91
  """
92
92
  __args__ = dict()
93
93
  __args__['name'] = name
@@ -108,7 +108,7 @@ def get_identity_users_output(name: Optional[pulumi.Input[str]] = None,
108
108
 
109
109
 
110
110
  :param str name: The PrincipalName of this identity member from the source provider.
111
- :param str search_filter: The type of search to perform. Default is `General`. Possible values are `AccountName`, `DisplayName`, and `MailAddress`.
111
+ :param str search_filter: The type of search to perform. Possible values are: `AccountName`, `DisplayName`, and `MailAddress`. Default is `General`.
112
112
  """
113
113
  __args__ = dict()
114
114
  __args__['name'] = name
@@ -46,11 +46,17 @@ class GetPoolResult:
46
46
  @property
47
47
  @pulumi.getter(name="autoProvision")
48
48
  def auto_provision(self) -> bool:
49
+ """
50
+ Specifies whether a queue should be automatically provisioned for each project collection.
51
+ """
49
52
  return pulumi.get(self, "auto_provision")
50
53
 
51
54
  @property
52
55
  @pulumi.getter(name="autoUpdate")
53
56
  def auto_update(self) -> bool:
57
+ """
58
+ Specifies whether or not agents within the pool should be automatically updated.
59
+ """
54
60
  return pulumi.get(self, "auto_update")
55
61
 
56
62
  @property
@@ -64,11 +70,17 @@ class GetPoolResult:
64
70
  @property
65
71
  @pulumi.getter
66
72
  def name(self) -> str:
73
+ """
74
+ The name of the agent pool
75
+ """
67
76
  return pulumi.get(self, "name")
68
77
 
69
78
  @property
70
79
  @pulumi.getter(name="poolType")
71
80
  def pool_type(self) -> str:
81
+ """
82
+ Specifies whether the agent pool type is Automation or Deployment.
83
+ """
72
84
  return pulumi.get(self, "pool_type")
73
85
 
74
86
 
@@ -105,7 +117,7 @@ def get_pool(name: Optional[str] = None,
105
117
 
106
118
  ## Relevant Links
107
119
 
108
- - [Azure DevOps Service REST API 7.0 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.0)
120
+ - [Azure DevOps Service REST API 7.1 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.1)
109
121
 
110
122
 
111
123
  :param str name: Name of the Agent Pool.
@@ -141,7 +153,7 @@ def get_pool_output(name: Optional[pulumi.Input[str]] = None,
141
153
 
142
154
  ## Relevant Links
143
155
 
144
- - [Azure DevOps Service REST API 7.0 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.0)
156
+ - [Azure DevOps Service REST API 7.1 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.1)
145
157
 
146
158
 
147
159
  :param str name: Name of the Agent Pool.
@@ -39,7 +39,7 @@ class GetPoolsResult:
39
39
  @pulumi.getter(name="agentPools")
40
40
  def agent_pools(self) -> Sequence['outputs.GetPoolsAgentPoolResult']:
41
41
  """
42
- A list of existing agent pools in your Azure DevOps Organization with the following details about every agent pool:
42
+ An `agent_pools` blocks as documented below. A list of existing agent pools in your Azure DevOps Organization with the following details about every agent pool:
43
43
  """
44
44
  return pulumi.get(self, "agent_pools")
45
45
 
@@ -81,7 +81,7 @@ def get_pools(opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetPoolsR
81
81
 
82
82
  ## Relevant Links
83
83
 
84
- - [Azure DevOps Service REST API 7.0 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.0)
84
+ - [Azure DevOps Service REST API 7.1 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.1)
85
85
  """
86
86
  __args__ = dict()
87
87
  opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -109,7 +109,7 @@ def get_pools_output(opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOut
109
109
 
110
110
  ## Relevant Links
111
111
 
112
- - [Azure DevOps Service REST API 7.0 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.0)
112
+ - [Azure DevOps Service REST API 7.1 - Agent Pools - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-7.1)
113
113
  """
114
114
  __args__ = dict()
115
115
  opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
@@ -58,6 +58,9 @@ class GetProjectResult:
58
58
  @property
59
59
  @pulumi.getter
60
60
  def description(self) -> str:
61
+ """
62
+ The description of the project.
63
+ """
61
64
  return pulumi.get(self, "description")
62
65
 
63
66
  @property
@@ -76,11 +79,17 @@ class GetProjectResult:
76
79
  @property
77
80
  @pulumi.getter
78
81
  def name(self) -> Optional[str]:
82
+ """
83
+ The name of the project.
84
+ """
79
85
  return pulumi.get(self, "name")
80
86
 
81
87
  @property
82
88
  @pulumi.getter(name="processTemplateId")
83
89
  def process_template_id(self) -> str:
90
+ """
91
+ The process template ID for the project.
92
+ """
84
93
  return pulumi.get(self, "process_template_id")
85
94
 
86
95
  @property
@@ -91,16 +100,25 @@ class GetProjectResult:
91
100
  @property
92
101
  @pulumi.getter(name="versionControl")
93
102
  def version_control(self) -> str:
103
+ """
104
+ The version control of the project.
105
+ """
94
106
  return pulumi.get(self, "version_control")
95
107
 
96
108
  @property
97
109
  @pulumi.getter
98
110
  def visibility(self) -> str:
111
+ """
112
+ The visibility of the project.
113
+ """
99
114
  return pulumi.get(self, "visibility")
100
115
 
101
116
  @property
102
117
  @pulumi.getter(name="workItemTemplate")
103
118
  def work_item_template(self) -> str:
119
+ """
120
+ The work item template for the project.
121
+ """
104
122
  return pulumi.get(self, "work_item_template")
105
123
 
106
124
 
@@ -141,9 +159,16 @@ def get_project(name: Optional[str] = None,
141
159
 
142
160
  - [Azure DevOps Service REST API 7.0 - Projects - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/get?view=azure-devops-rest-7.0)
143
161
 
162
+ ## PAT Permissions Required
163
+
164
+ - **Project & Team**: Read
165
+ - **Work Items**: Read
166
+
144
167
 
145
168
  :param str name: Name of the Project.
146
169
  :param str project_id: ID of the Project.
170
+
171
+ > **NOTE:** One of either `project_id` or `name` must be specified.
147
172
  """
148
173
  __args__ = dict()
149
174
  __args__['name'] = name
@@ -181,9 +206,16 @@ def get_project_output(name: Optional[pulumi.Input[Optional[str]]] = None,
181
206
 
182
207
  - [Azure DevOps Service REST API 7.0 - Projects - Get](https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/get?view=azure-devops-rest-7.0)
183
208
 
209
+ ## PAT Permissions Required
210
+
211
+ - **Project & Team**: Read
212
+ - **Work Items**: Read
213
+
184
214
 
185
215
  :param str name: Name of the Project.
186
216
  :param str project_id: ID of the Project.
217
+
218
+ > **NOTE:** One of either `project_id` or `name` must be specified.
187
219
  """
188
220
  __args__ = dict()
189
221
  __args__['name'] = name
@@ -61,7 +61,7 @@ class GetProjectsResult:
61
61
  @pulumi.getter
62
62
  def projects(self) -> Sequence['outputs.GetProjectsProjectResult']:
63
63
  """
64
- A list of existing projects in your Azure DevOps Organization with details about every project which includes:
64
+ A list of `projects` blocks as documented below. A list of existing projects in your Azure DevOps Organization with details about every project which includes:
65
65
  """
66
66
  return pulumi.get(self, "projects")
67
67
 
@@ -69,7 +69,7 @@ class GetProjectsResult:
69
69
  @pulumi.getter
70
70
  def state(self) -> Optional[str]:
71
71
  """
72
- Project state.
72
+ The state of the Project.
73
73
  """
74
74
  return pulumi.get(self, "state")
75
75
 
@@ -114,7 +114,7 @@ def get_projects(name: Optional[str] = None,
114
114
  :param str name: Name of the Project, if not specified all projects will be returned.
115
115
  :param str state: State of the Project, if not specified all projects will be returned. Valid values are `all`, `deleting`, `new`, `wellFormed`, `createPending`, `unchanged`,`deleted`.
116
116
 
117
- DataSource without specifying any arguments will return all projects.
117
+ > **NOTE:** DataSource without specifying any arguments will return all projects.
118
118
  """
119
119
  __args__ = dict()
120
120
  __args__['name'] = name
@@ -155,7 +155,7 @@ def get_projects_output(name: Optional[pulumi.Input[Optional[str]]] = None,
155
155
  :param str name: Name of the Project, if not specified all projects will be returned.
156
156
  :param str state: State of the Project, if not specified all projects will be returned. Valid values are `all`, `deleting`, `new`, `wellFormed`, `createPending`, `unchanged`,`deleted`.
157
157
 
158
- DataSource without specifying any arguments will return all projects.
158
+ > **NOTE:** DataSource without specifying any arguments will return all projects.
159
159
  """
160
160
  __args__ = dict()
161
161
  __args__['name'] = name
@@ -77,7 +77,7 @@ class GetRepositoriesResult:
77
77
  @pulumi.getter
78
78
  def repositories(self) -> Sequence['outputs.GetRepositoriesRepositoryResult']:
79
79
  """
80
- A list of existing projects in your Azure DevOps Organization with details about every project which includes:
80
+ A `repositories` blocks as documented below. A list of existing projects in your Azure DevOps Organization with details about every project.
81
81
  """
82
82
  return pulumi.get(self, "repositories")
83
83
 
@@ -123,7 +123,9 @@ def get_repositories(include_hidden: Optional[bool] = None,
123
123
  - [Azure DevOps Service REST API 7.0 - Git API](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/?view=azure-devops-rest-7.0)
124
124
 
125
125
 
126
- :param bool include_hidden: DataSource without specifying any arguments will return all Git repositories of an organization.
126
+ :param bool include_hidden: Defaults to `false`.
127
+
128
+ DataSource without specifying any arguments will return all Git repositories of an organization.
127
129
  :param str name: Name of the Git repository to retrieve; requires `project_id` to be specified as well
128
130
  :param str project_id: ID of project to list Git repositories
129
131
  """
@@ -168,7 +170,9 @@ def get_repositories_output(include_hidden: Optional[pulumi.Input[Optional[bool]
168
170
  - [Azure DevOps Service REST API 7.0 - Git API](https://docs.microsoft.com/en-us/rest/api/azure/devops/git/?view=azure-devops-rest-7.0)
169
171
 
170
172
 
171
- :param bool include_hidden: DataSource without specifying any arguments will return all Git repositories of an organization.
173
+ :param bool include_hidden: Defaults to `false`.
174
+
175
+ DataSource without specifying any arguments will return all Git repositories of an organization.
172
176
  :param str name: Name of the Git repository to retrieve; requires `project_id` to be specified as well
173
177
  :param str project_id: ID of project to list Git repositories
174
178
  """
@@ -91,12 +91,12 @@ def get_securityrole_definitions(scope: Optional[str] = None,
91
91
 
92
92
  ## Relevant Links
93
93
 
94
- - [Azure DevOps Service REST API 7.0 - Roledefinitions - List](https://learn.microsoft.com/en-us/rest/api/azure/devops/securityroles/roledefinitions/list?view=azure-devops-rest-7.1)
94
+ - [Azure DevOps Service REST API 7.0 - Role Definitions - List](https://learn.microsoft.com/en-us/rest/api/azure/devops/securityroles/roledefinitions/list?view=azure-devops-rest-7.1)
95
95
 
96
96
 
97
97
  :param str scope: Name of the Scope for which Security Role Definitions will be returned.
98
98
 
99
- DataSource without specifying any arguments will return all projects.
99
+ > **NOTE:** DataSource without specifying any arguments will return all projects.
100
100
  """
101
101
  __args__ = dict()
102
102
  __args__['scope'] = scope
@@ -124,12 +124,12 @@ def get_securityrole_definitions_output(scope: Optional[pulumi.Input[str]] = Non
124
124
 
125
125
  ## Relevant Links
126
126
 
127
- - [Azure DevOps Service REST API 7.0 - Roledefinitions - List](https://learn.microsoft.com/en-us/rest/api/azure/devops/securityroles/roledefinitions/list?view=azure-devops-rest-7.1)
127
+ - [Azure DevOps Service REST API 7.0 - Role Definitions - List](https://learn.microsoft.com/en-us/rest/api/azure/devops/securityroles/roledefinitions/list?view=azure-devops-rest-7.1)
128
128
 
129
129
 
130
130
  :param str scope: Name of the Scope for which Security Role Definitions will be returned.
131
131
 
132
- DataSource without specifying any arguments will return all projects.
132
+ > **NOTE:** DataSource without specifying any arguments will return all projects.
133
133
  """
134
134
  __args__ = dict()
135
135
  __args__['scope'] = scope
@@ -86,7 +86,7 @@ class GetServiceEndpointAzureRMResult:
86
86
  @pulumi.getter
87
87
  def authorization(self) -> Mapping[str, str]:
88
88
  """
89
- The Authorization Scheme Map.
89
+ The Authorization scheme.
90
90
  """
91
91
  return pulumi.get(self, "authorization")
92
92
 
@@ -282,8 +282,8 @@ def get_service_endpoint_azure_rm(project_id: Optional[str] = None,
282
282
  :param str service_endpoint_id: the ID of the Service Endpoint.
283
283
  :param str service_endpoint_name: the Name of the Service Endpoint.
284
284
 
285
- > **NOTE:** One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
286
- > **NOTE:** When supplying `service_endpoint_name`, take care to ensure that this is a unique name.
285
+ > **NOTE:** 1. One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
286
+ <br>2. When supplying `service_endpoint_name`, take care to ensure that this is a unique name.
287
287
  """
288
288
  __args__ = dict()
289
289
  __args__['projectId'] = project_id
@@ -349,8 +349,8 @@ def get_service_endpoint_azure_rm_output(project_id: Optional[pulumi.Input[str]]
349
349
  :param str service_endpoint_id: the ID of the Service Endpoint.
350
350
  :param str service_endpoint_name: the Name of the Service Endpoint.
351
351
 
352
- > **NOTE:** One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
353
- > **NOTE:** When supplying `service_endpoint_name`, take care to ensure that this is a unique name.
352
+ > **NOTE:** 1. One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
353
+ <br>2. When supplying `service_endpoint_name`, take care to ensure that this is a unique name.
354
354
  """
355
355
  __args__ = dict()
356
356
  __args__['projectId'] = project_id
@@ -50,7 +50,7 @@ class GetServiceEndpointGithubResult:
50
50
  @pulumi.getter
51
51
  def authorization(self) -> Mapping[str, str]:
52
52
  """
53
- Specifies the Authorization Scheme Map.
53
+ The Authorization scheme.
54
54
  """
55
55
  return pulumi.get(self, "authorization")
56
56
 
@@ -58,7 +58,7 @@ class GetServiceEndpointGithubResult:
58
58
  @pulumi.getter
59
59
  def description(self) -> str:
60
60
  """
61
- Specifies the description of the Service Endpoint.
61
+ The description of the Service Endpoint.
62
62
  """
63
63
  return pulumi.get(self, "description")
64
64
 
@@ -138,8 +138,8 @@ def get_service_endpoint_github(project_id: Optional[str] = None,
138
138
  :param str service_endpoint_id: the ID of the Service Endpoint.
139
139
  :param str service_endpoint_name: the Name of the Service Endpoint.
140
140
 
141
- > **NOTE:** One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
142
- > **NOTE:** When supplying `service_endpoint_name`, take care to ensure that this is a unique name.
141
+ > **NOTE:** 1. One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
142
+ <br>2. When supplying `service_endpoint_name`, take care to ensure that this is a unique name.
143
143
  """
144
144
  __args__ = dict()
145
145
  __args__['projectId'] = project_id
@@ -193,8 +193,8 @@ def get_service_endpoint_github_output(project_id: Optional[pulumi.Input[str]] =
193
193
  :param str service_endpoint_id: the ID of the Service Endpoint.
194
194
  :param str service_endpoint_name: the Name of the Service Endpoint.
195
195
 
196
- > **NOTE:** One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
197
- > **NOTE:** When supplying `service_endpoint_name`, take care to ensure that this is a unique name.
196
+ > **NOTE:** 1. One of either `service_endpoint_id` or `service_endpoint_name` must be specified.
197
+ <br>2. When supplying `service_endpoint_name`, take care to ensure that this is a unique name.
198
198
  """
199
199
  __args__ = dict()
200
200
  __args__['projectId'] = project_id
@@ -0,0 +1,153 @@
1
+ # coding=utf-8
2
+ # *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
3
+ # *** Do not edit by hand unless you're certain you know what you are doing! ***
4
+
5
+ import copy
6
+ import warnings
7
+ import sys
8
+ import pulumi
9
+ import pulumi.runtime
10
+ from typing import Any, Mapping, Optional, Sequence, Union, overload
11
+ if sys.version_info >= (3, 11):
12
+ from typing import NotRequired, TypedDict, TypeAlias
13
+ else:
14
+ from typing_extensions import NotRequired, TypedDict, TypeAlias
15
+ from . import _utilities
16
+
17
+ __all__ = [
18
+ 'GetServicePrincipalResult',
19
+ 'AwaitableGetServicePrincipalResult',
20
+ 'get_service_principal',
21
+ 'get_service_principal_output',
22
+ ]
23
+
24
+ @pulumi.output_type
25
+ class GetServicePrincipalResult:
26
+ """
27
+ A collection of values returned by getServicePrincipal.
28
+ """
29
+ def __init__(__self__, descriptor=None, display_name=None, id=None, origin=None, origin_id=None):
30
+ if descriptor and not isinstance(descriptor, str):
31
+ raise TypeError("Expected argument 'descriptor' to be a str")
32
+ pulumi.set(__self__, "descriptor", descriptor)
33
+ if display_name and not isinstance(display_name, str):
34
+ raise TypeError("Expected argument 'display_name' to be a str")
35
+ pulumi.set(__self__, "display_name", display_name)
36
+ if id and not isinstance(id, str):
37
+ raise TypeError("Expected argument 'id' to be a str")
38
+ pulumi.set(__self__, "id", id)
39
+ if origin and not isinstance(origin, str):
40
+ raise TypeError("Expected argument 'origin' to be a str")
41
+ pulumi.set(__self__, "origin", origin)
42
+ if origin_id and not isinstance(origin_id, str):
43
+ raise TypeError("Expected argument 'origin_id' to be a str")
44
+ pulumi.set(__self__, "origin_id", origin_id)
45
+
46
+ @property
47
+ @pulumi.getter
48
+ def descriptor(self) -> str:
49
+ """
50
+ The descriptor of the Service Principal.
51
+ """
52
+ return pulumi.get(self, "descriptor")
53
+
54
+ @property
55
+ @pulumi.getter(name="displayName")
56
+ def display_name(self) -> str:
57
+ return pulumi.get(self, "display_name")
58
+
59
+ @property
60
+ @pulumi.getter
61
+ def id(self) -> str:
62
+ """
63
+ The provider-assigned unique ID for this managed resource.
64
+ """
65
+ return pulumi.get(self, "id")
66
+
67
+ @property
68
+ @pulumi.getter
69
+ def origin(self) -> str:
70
+ """
71
+ The origin of the Service Principal.
72
+ """
73
+ return pulumi.get(self, "origin")
74
+
75
+ @property
76
+ @pulumi.getter(name="originId")
77
+ def origin_id(self) -> str:
78
+ """
79
+ The origin ID of the Service Principal..
80
+ """
81
+ return pulumi.get(self, "origin_id")
82
+
83
+
84
+ class AwaitableGetServicePrincipalResult(GetServicePrincipalResult):
85
+ # pylint: disable=using-constant-test
86
+ def __await__(self):
87
+ if False:
88
+ yield self
89
+ return GetServicePrincipalResult(
90
+ descriptor=self.descriptor,
91
+ display_name=self.display_name,
92
+ id=self.id,
93
+ origin=self.origin,
94
+ origin_id=self.origin_id)
95
+
96
+
97
+ def get_service_principal(display_name: Optional[str] = None,
98
+ opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetServicePrincipalResult:
99
+ """
100
+ Use this data source to access information about an existing Service Principal.
101
+
102
+ ## Example Usage
103
+
104
+ ```python
105
+ import pulumi
106
+ import pulumi_azuredevops as azuredevops
107
+
108
+ example = azuredevops.get_service_principal(display_name="existing")
109
+ pulumi.export("id", example.id)
110
+ ```
111
+
112
+
113
+ :param str display_name: The Display Name of the Service Principal. Changing this forces a new Service Principal to be created.
114
+ """
115
+ __args__ = dict()
116
+ __args__['displayName'] = display_name
117
+ opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
118
+ __ret__ = pulumi.runtime.invoke('azuredevops:index/getServicePrincipal:getServicePrincipal', __args__, opts=opts, typ=GetServicePrincipalResult).value
119
+
120
+ return AwaitableGetServicePrincipalResult(
121
+ descriptor=pulumi.get(__ret__, 'descriptor'),
122
+ display_name=pulumi.get(__ret__, 'display_name'),
123
+ id=pulumi.get(__ret__, 'id'),
124
+ origin=pulumi.get(__ret__, 'origin'),
125
+ origin_id=pulumi.get(__ret__, 'origin_id'))
126
+ def get_service_principal_output(display_name: Optional[pulumi.Input[str]] = None,
127
+ opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetServicePrincipalResult]:
128
+ """
129
+ Use this data source to access information about an existing Service Principal.
130
+
131
+ ## Example Usage
132
+
133
+ ```python
134
+ import pulumi
135
+ import pulumi_azuredevops as azuredevops
136
+
137
+ example = azuredevops.get_service_principal(display_name="existing")
138
+ pulumi.export("id", example.id)
139
+ ```
140
+
141
+
142
+ :param str display_name: The Display Name of the Service Principal. Changing this forces a new Service Principal to be created.
143
+ """
144
+ __args__ = dict()
145
+ __args__['displayName'] = display_name
146
+ opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
147
+ __ret__ = pulumi.runtime.invoke_output('azuredevops:index/getServicePrincipal:getServicePrincipal', __args__, opts=opts, typ=GetServicePrincipalResult)
148
+ return __ret__.apply(lambda __response__: GetServicePrincipalResult(
149
+ descriptor=pulumi.get(__response__, 'descriptor'),
150
+ display_name=pulumi.get(__response__, 'display_name'),
151
+ id=pulumi.get(__response__, 'id'),
152
+ origin=pulumi.get(__response__, 'origin'),
153
+ origin_id=pulumi.get(__response__, 'origin_id')))