pulumi-azuredevops 3.6.0a1737523387__py3-none-any.whl → 3.6.0a1737710622__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.6.0a1737710622.dist-info}/METADATA +1 -1
  116. pulumi_azuredevops-3.6.0a1737710622.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.6.0a1737710622.dist-info}/WHEEL +0 -0
  119. {pulumi_azuredevops-3.6.0a1737523387.dist-info → pulumi_azuredevops-3.6.0a1737710622.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,986 @@
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__ = ['CheckRestApiArgs', 'CheckRestApi']
18
+
19
+ @pulumi.input_type
20
+ class CheckRestApiArgs:
21
+ def __init__(__self__, *,
22
+ connected_service_name: pulumi.Input[str],
23
+ connected_service_name_selector: pulumi.Input[str],
24
+ display_name: pulumi.Input[str],
25
+ method: pulumi.Input[str],
26
+ project_id: pulumi.Input[str],
27
+ target_resource_id: pulumi.Input[str],
28
+ target_resource_type: pulumi.Input[str],
29
+ body: Optional[pulumi.Input[str]] = None,
30
+ completion_event: Optional[pulumi.Input[str]] = None,
31
+ headers: Optional[pulumi.Input[str]] = None,
32
+ retry_interval: Optional[pulumi.Input[int]] = None,
33
+ success_criteria: Optional[pulumi.Input[str]] = None,
34
+ timeout: Optional[pulumi.Input[int]] = None,
35
+ url_suffix: Optional[pulumi.Input[str]] = None,
36
+ variable_group_name: Optional[pulumi.Input[str]] = None):
37
+ """
38
+ The set of arguments for constructing a CheckRestApi resource.
39
+ :param pulumi.Input[str] connected_service_name: The name of the Service Connection.
40
+ :param pulumi.Input[str] connected_service_name_selector: The type of the Service Connection used to invoke the REST API. Possible values: `connectedServiceName`(**Generic** type service connection) and `connectedServiceNameARM`(**Azure Resource Manager** type service connection).
41
+ :param pulumi.Input[str] display_name: The Name of the Rest API check.
42
+ :param pulumi.Input[str] method: The HTTP method of the request. Possible values: `OPTIONS`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `TRACE`, `PATCH`
43
+ :param pulumi.Input[str] project_id: The ID of the project. Changing this forces a new resource to be created.
44
+ :param pulumi.Input[str] target_resource_id: The ID of the resource being protected by the check. Changing this forces a new resource to be created
45
+ :param pulumi.Input[str] target_resource_type: The type of resource being protected by the check. Possible values: `endpoint`, `environment`, `queue`, `repository`, `securefile`, `variablegroup`. Changing this forces a new resource to be created.
46
+ :param pulumi.Input[str] body: The Rest API request body.
47
+ :param pulumi.Input[str] completion_event: The completion event of the Rest API call. Possible values: `Callback`, `ApiResponse`. Defaults to `Callback`.
48
+ :param pulumi.Input[str] headers: The headers of the request in JSON format.
49
+ :param pulumi.Input[int] retry_interval: The time between evaluations (minutes).
50
+
51
+ ~>**NOTE** 1. The retry times should less them 10 based on the timeout. For example: `timeout` is `4000` then `retry_interval` should be `0` or no less then `400`.
52
+ <br>2. `retry_interval` is not required when `completion_event=Callback`.
53
+ :param pulumi.Input[str] success_criteria: The Criteria which defines when to pass the task. No criteria means response content does not influence the result.
54
+
55
+ ~>**NOTE** `success_criteria` is used when `completion_event=ApiResponse`
56
+ :param pulumi.Input[int] timeout: The timeout in minutes for the Rest API check. Defaults to `1440`.
57
+ :param pulumi.Input[str] url_suffix: The URL suffix and parameters.
58
+ :param pulumi.Input[str] variable_group_name: The name of the Variable Group.
59
+ """
60
+ pulumi.set(__self__, "connected_service_name", connected_service_name)
61
+ pulumi.set(__self__, "connected_service_name_selector", connected_service_name_selector)
62
+ pulumi.set(__self__, "display_name", display_name)
63
+ pulumi.set(__self__, "method", method)
64
+ pulumi.set(__self__, "project_id", project_id)
65
+ pulumi.set(__self__, "target_resource_id", target_resource_id)
66
+ pulumi.set(__self__, "target_resource_type", target_resource_type)
67
+ if body is not None:
68
+ pulumi.set(__self__, "body", body)
69
+ if completion_event is not None:
70
+ pulumi.set(__self__, "completion_event", completion_event)
71
+ if headers is not None:
72
+ pulumi.set(__self__, "headers", headers)
73
+ if retry_interval is not None:
74
+ pulumi.set(__self__, "retry_interval", retry_interval)
75
+ if success_criteria is not None:
76
+ pulumi.set(__self__, "success_criteria", success_criteria)
77
+ if timeout is not None:
78
+ pulumi.set(__self__, "timeout", timeout)
79
+ if url_suffix is not None:
80
+ pulumi.set(__self__, "url_suffix", url_suffix)
81
+ if variable_group_name is not None:
82
+ pulumi.set(__self__, "variable_group_name", variable_group_name)
83
+
84
+ @property
85
+ @pulumi.getter(name="connectedServiceName")
86
+ def connected_service_name(self) -> pulumi.Input[str]:
87
+ """
88
+ The name of the Service Connection.
89
+ """
90
+ return pulumi.get(self, "connected_service_name")
91
+
92
+ @connected_service_name.setter
93
+ def connected_service_name(self, value: pulumi.Input[str]):
94
+ pulumi.set(self, "connected_service_name", value)
95
+
96
+ @property
97
+ @pulumi.getter(name="connectedServiceNameSelector")
98
+ def connected_service_name_selector(self) -> pulumi.Input[str]:
99
+ """
100
+ The type of the Service Connection used to invoke the REST API. Possible values: `connectedServiceName`(**Generic** type service connection) and `connectedServiceNameARM`(**Azure Resource Manager** type service connection).
101
+ """
102
+ return pulumi.get(self, "connected_service_name_selector")
103
+
104
+ @connected_service_name_selector.setter
105
+ def connected_service_name_selector(self, value: pulumi.Input[str]):
106
+ pulumi.set(self, "connected_service_name_selector", value)
107
+
108
+ @property
109
+ @pulumi.getter(name="displayName")
110
+ def display_name(self) -> pulumi.Input[str]:
111
+ """
112
+ The Name of the Rest API check.
113
+ """
114
+ return pulumi.get(self, "display_name")
115
+
116
+ @display_name.setter
117
+ def display_name(self, value: pulumi.Input[str]):
118
+ pulumi.set(self, "display_name", value)
119
+
120
+ @property
121
+ @pulumi.getter
122
+ def method(self) -> pulumi.Input[str]:
123
+ """
124
+ The HTTP method of the request. Possible values: `OPTIONS`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `TRACE`, `PATCH`
125
+ """
126
+ return pulumi.get(self, "method")
127
+
128
+ @method.setter
129
+ def method(self, value: pulumi.Input[str]):
130
+ pulumi.set(self, "method", value)
131
+
132
+ @property
133
+ @pulumi.getter(name="projectId")
134
+ def project_id(self) -> pulumi.Input[str]:
135
+ """
136
+ The ID of the project. Changing this forces a new resource to be created.
137
+ """
138
+ return pulumi.get(self, "project_id")
139
+
140
+ @project_id.setter
141
+ def project_id(self, value: pulumi.Input[str]):
142
+ pulumi.set(self, "project_id", value)
143
+
144
+ @property
145
+ @pulumi.getter(name="targetResourceId")
146
+ def target_resource_id(self) -> pulumi.Input[str]:
147
+ """
148
+ The ID of the resource being protected by the check. Changing this forces a new resource to be created
149
+ """
150
+ return pulumi.get(self, "target_resource_id")
151
+
152
+ @target_resource_id.setter
153
+ def target_resource_id(self, value: pulumi.Input[str]):
154
+ pulumi.set(self, "target_resource_id", value)
155
+
156
+ @property
157
+ @pulumi.getter(name="targetResourceType")
158
+ def target_resource_type(self) -> pulumi.Input[str]:
159
+ """
160
+ The type of resource being protected by the check. Possible values: `endpoint`, `environment`, `queue`, `repository`, `securefile`, `variablegroup`. Changing this forces a new resource to be created.
161
+ """
162
+ return pulumi.get(self, "target_resource_type")
163
+
164
+ @target_resource_type.setter
165
+ def target_resource_type(self, value: pulumi.Input[str]):
166
+ pulumi.set(self, "target_resource_type", value)
167
+
168
+ @property
169
+ @pulumi.getter
170
+ def body(self) -> Optional[pulumi.Input[str]]:
171
+ """
172
+ The Rest API request body.
173
+ """
174
+ return pulumi.get(self, "body")
175
+
176
+ @body.setter
177
+ def body(self, value: Optional[pulumi.Input[str]]):
178
+ pulumi.set(self, "body", value)
179
+
180
+ @property
181
+ @pulumi.getter(name="completionEvent")
182
+ def completion_event(self) -> Optional[pulumi.Input[str]]:
183
+ """
184
+ The completion event of the Rest API call. Possible values: `Callback`, `ApiResponse`. Defaults to `Callback`.
185
+ """
186
+ return pulumi.get(self, "completion_event")
187
+
188
+ @completion_event.setter
189
+ def completion_event(self, value: Optional[pulumi.Input[str]]):
190
+ pulumi.set(self, "completion_event", value)
191
+
192
+ @property
193
+ @pulumi.getter
194
+ def headers(self) -> Optional[pulumi.Input[str]]:
195
+ """
196
+ The headers of the request in JSON format.
197
+ """
198
+ return pulumi.get(self, "headers")
199
+
200
+ @headers.setter
201
+ def headers(self, value: Optional[pulumi.Input[str]]):
202
+ pulumi.set(self, "headers", value)
203
+
204
+ @property
205
+ @pulumi.getter(name="retryInterval")
206
+ def retry_interval(self) -> Optional[pulumi.Input[int]]:
207
+ """
208
+ The time between evaluations (minutes).
209
+
210
+ ~>**NOTE** 1. The retry times should less them 10 based on the timeout. For example: `timeout` is `4000` then `retry_interval` should be `0` or no less then `400`.
211
+ <br>2. `retry_interval` is not required when `completion_event=Callback`.
212
+ """
213
+ return pulumi.get(self, "retry_interval")
214
+
215
+ @retry_interval.setter
216
+ def retry_interval(self, value: Optional[pulumi.Input[int]]):
217
+ pulumi.set(self, "retry_interval", value)
218
+
219
+ @property
220
+ @pulumi.getter(name="successCriteria")
221
+ def success_criteria(self) -> Optional[pulumi.Input[str]]:
222
+ """
223
+ The Criteria which defines when to pass the task. No criteria means response content does not influence the result.
224
+
225
+ ~>**NOTE** `success_criteria` is used when `completion_event=ApiResponse`
226
+ """
227
+ return pulumi.get(self, "success_criteria")
228
+
229
+ @success_criteria.setter
230
+ def success_criteria(self, value: Optional[pulumi.Input[str]]):
231
+ pulumi.set(self, "success_criteria", value)
232
+
233
+ @property
234
+ @pulumi.getter
235
+ def timeout(self) -> Optional[pulumi.Input[int]]:
236
+ """
237
+ The timeout in minutes for the Rest API check. Defaults to `1440`.
238
+ """
239
+ return pulumi.get(self, "timeout")
240
+
241
+ @timeout.setter
242
+ def timeout(self, value: Optional[pulumi.Input[int]]):
243
+ pulumi.set(self, "timeout", value)
244
+
245
+ @property
246
+ @pulumi.getter(name="urlSuffix")
247
+ def url_suffix(self) -> Optional[pulumi.Input[str]]:
248
+ """
249
+ The URL suffix and parameters.
250
+ """
251
+ return pulumi.get(self, "url_suffix")
252
+
253
+ @url_suffix.setter
254
+ def url_suffix(self, value: Optional[pulumi.Input[str]]):
255
+ pulumi.set(self, "url_suffix", value)
256
+
257
+ @property
258
+ @pulumi.getter(name="variableGroupName")
259
+ def variable_group_name(self) -> Optional[pulumi.Input[str]]:
260
+ """
261
+ The name of the Variable Group.
262
+ """
263
+ return pulumi.get(self, "variable_group_name")
264
+
265
+ @variable_group_name.setter
266
+ def variable_group_name(self, value: Optional[pulumi.Input[str]]):
267
+ pulumi.set(self, "variable_group_name", value)
268
+
269
+
270
+ @pulumi.input_type
271
+ class _CheckRestApiState:
272
+ def __init__(__self__, *,
273
+ body: Optional[pulumi.Input[str]] = None,
274
+ completion_event: Optional[pulumi.Input[str]] = None,
275
+ connected_service_name: Optional[pulumi.Input[str]] = None,
276
+ connected_service_name_selector: Optional[pulumi.Input[str]] = None,
277
+ display_name: Optional[pulumi.Input[str]] = None,
278
+ headers: Optional[pulumi.Input[str]] = None,
279
+ method: Optional[pulumi.Input[str]] = None,
280
+ project_id: Optional[pulumi.Input[str]] = None,
281
+ retry_interval: Optional[pulumi.Input[int]] = None,
282
+ success_criteria: Optional[pulumi.Input[str]] = None,
283
+ target_resource_id: Optional[pulumi.Input[str]] = None,
284
+ target_resource_type: Optional[pulumi.Input[str]] = None,
285
+ timeout: Optional[pulumi.Input[int]] = None,
286
+ url_suffix: Optional[pulumi.Input[str]] = None,
287
+ variable_group_name: Optional[pulumi.Input[str]] = None,
288
+ version: Optional[pulumi.Input[int]] = None):
289
+ """
290
+ Input properties used for looking up and filtering CheckRestApi resources.
291
+ :param pulumi.Input[str] body: The Rest API request body.
292
+ :param pulumi.Input[str] completion_event: The completion event of the Rest API call. Possible values: `Callback`, `ApiResponse`. Defaults to `Callback`.
293
+ :param pulumi.Input[str] connected_service_name: The name of the Service Connection.
294
+ :param pulumi.Input[str] connected_service_name_selector: The type of the Service Connection used to invoke the REST API. Possible values: `connectedServiceName`(**Generic** type service connection) and `connectedServiceNameARM`(**Azure Resource Manager** type service connection).
295
+ :param pulumi.Input[str] display_name: The Name of the Rest API check.
296
+ :param pulumi.Input[str] headers: The headers of the request in JSON format.
297
+ :param pulumi.Input[str] method: The HTTP method of the request. Possible values: `OPTIONS`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `TRACE`, `PATCH`
298
+ :param pulumi.Input[str] project_id: The ID of the project. Changing this forces a new resource to be created.
299
+ :param pulumi.Input[int] retry_interval: The time between evaluations (minutes).
300
+
301
+ ~>**NOTE** 1. The retry times should less them 10 based on the timeout. For example: `timeout` is `4000` then `retry_interval` should be `0` or no less then `400`.
302
+ <br>2. `retry_interval` is not required when `completion_event=Callback`.
303
+ :param pulumi.Input[str] success_criteria: The Criteria which defines when to pass the task. No criteria means response content does not influence the result.
304
+
305
+ ~>**NOTE** `success_criteria` is used when `completion_event=ApiResponse`
306
+ :param pulumi.Input[str] target_resource_id: The ID of the resource being protected by the check. Changing this forces a new resource to be created
307
+ :param pulumi.Input[str] target_resource_type: The type of resource being protected by the check. Possible values: `endpoint`, `environment`, `queue`, `repository`, `securefile`, `variablegroup`. Changing this forces a new resource to be created.
308
+ :param pulumi.Input[int] timeout: The timeout in minutes for the Rest API check. Defaults to `1440`.
309
+ :param pulumi.Input[str] url_suffix: The URL suffix and parameters.
310
+ :param pulumi.Input[str] variable_group_name: The name of the Variable Group.
311
+ :param pulumi.Input[int] version: The version of the Rest API check.
312
+ """
313
+ if body is not None:
314
+ pulumi.set(__self__, "body", body)
315
+ if completion_event is not None:
316
+ pulumi.set(__self__, "completion_event", completion_event)
317
+ if connected_service_name is not None:
318
+ pulumi.set(__self__, "connected_service_name", connected_service_name)
319
+ if connected_service_name_selector is not None:
320
+ pulumi.set(__self__, "connected_service_name_selector", connected_service_name_selector)
321
+ if display_name is not None:
322
+ pulumi.set(__self__, "display_name", display_name)
323
+ if headers is not None:
324
+ pulumi.set(__self__, "headers", headers)
325
+ if method is not None:
326
+ pulumi.set(__self__, "method", method)
327
+ if project_id is not None:
328
+ pulumi.set(__self__, "project_id", project_id)
329
+ if retry_interval is not None:
330
+ pulumi.set(__self__, "retry_interval", retry_interval)
331
+ if success_criteria is not None:
332
+ pulumi.set(__self__, "success_criteria", success_criteria)
333
+ if target_resource_id is not None:
334
+ pulumi.set(__self__, "target_resource_id", target_resource_id)
335
+ if target_resource_type is not None:
336
+ pulumi.set(__self__, "target_resource_type", target_resource_type)
337
+ if timeout is not None:
338
+ pulumi.set(__self__, "timeout", timeout)
339
+ if url_suffix is not None:
340
+ pulumi.set(__self__, "url_suffix", url_suffix)
341
+ if variable_group_name is not None:
342
+ pulumi.set(__self__, "variable_group_name", variable_group_name)
343
+ if version is not None:
344
+ pulumi.set(__self__, "version", version)
345
+
346
+ @property
347
+ @pulumi.getter
348
+ def body(self) -> Optional[pulumi.Input[str]]:
349
+ """
350
+ The Rest API request body.
351
+ """
352
+ return pulumi.get(self, "body")
353
+
354
+ @body.setter
355
+ def body(self, value: Optional[pulumi.Input[str]]):
356
+ pulumi.set(self, "body", value)
357
+
358
+ @property
359
+ @pulumi.getter(name="completionEvent")
360
+ def completion_event(self) -> Optional[pulumi.Input[str]]:
361
+ """
362
+ The completion event of the Rest API call. Possible values: `Callback`, `ApiResponse`. Defaults to `Callback`.
363
+ """
364
+ return pulumi.get(self, "completion_event")
365
+
366
+ @completion_event.setter
367
+ def completion_event(self, value: Optional[pulumi.Input[str]]):
368
+ pulumi.set(self, "completion_event", value)
369
+
370
+ @property
371
+ @pulumi.getter(name="connectedServiceName")
372
+ def connected_service_name(self) -> Optional[pulumi.Input[str]]:
373
+ """
374
+ The name of the Service Connection.
375
+ """
376
+ return pulumi.get(self, "connected_service_name")
377
+
378
+ @connected_service_name.setter
379
+ def connected_service_name(self, value: Optional[pulumi.Input[str]]):
380
+ pulumi.set(self, "connected_service_name", value)
381
+
382
+ @property
383
+ @pulumi.getter(name="connectedServiceNameSelector")
384
+ def connected_service_name_selector(self) -> Optional[pulumi.Input[str]]:
385
+ """
386
+ The type of the Service Connection used to invoke the REST API. Possible values: `connectedServiceName`(**Generic** type service connection) and `connectedServiceNameARM`(**Azure Resource Manager** type service connection).
387
+ """
388
+ return pulumi.get(self, "connected_service_name_selector")
389
+
390
+ @connected_service_name_selector.setter
391
+ def connected_service_name_selector(self, value: Optional[pulumi.Input[str]]):
392
+ pulumi.set(self, "connected_service_name_selector", value)
393
+
394
+ @property
395
+ @pulumi.getter(name="displayName")
396
+ def display_name(self) -> Optional[pulumi.Input[str]]:
397
+ """
398
+ The Name of the Rest API check.
399
+ """
400
+ return pulumi.get(self, "display_name")
401
+
402
+ @display_name.setter
403
+ def display_name(self, value: Optional[pulumi.Input[str]]):
404
+ pulumi.set(self, "display_name", value)
405
+
406
+ @property
407
+ @pulumi.getter
408
+ def headers(self) -> Optional[pulumi.Input[str]]:
409
+ """
410
+ The headers of the request in JSON format.
411
+ """
412
+ return pulumi.get(self, "headers")
413
+
414
+ @headers.setter
415
+ def headers(self, value: Optional[pulumi.Input[str]]):
416
+ pulumi.set(self, "headers", value)
417
+
418
+ @property
419
+ @pulumi.getter
420
+ def method(self) -> Optional[pulumi.Input[str]]:
421
+ """
422
+ The HTTP method of the request. Possible values: `OPTIONS`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `TRACE`, `PATCH`
423
+ """
424
+ return pulumi.get(self, "method")
425
+
426
+ @method.setter
427
+ def method(self, value: Optional[pulumi.Input[str]]):
428
+ pulumi.set(self, "method", value)
429
+
430
+ @property
431
+ @pulumi.getter(name="projectId")
432
+ def project_id(self) -> Optional[pulumi.Input[str]]:
433
+ """
434
+ The ID of the project. Changing this forces a new resource to be created.
435
+ """
436
+ return pulumi.get(self, "project_id")
437
+
438
+ @project_id.setter
439
+ def project_id(self, value: Optional[pulumi.Input[str]]):
440
+ pulumi.set(self, "project_id", value)
441
+
442
+ @property
443
+ @pulumi.getter(name="retryInterval")
444
+ def retry_interval(self) -> Optional[pulumi.Input[int]]:
445
+ """
446
+ The time between evaluations (minutes).
447
+
448
+ ~>**NOTE** 1. The retry times should less them 10 based on the timeout. For example: `timeout` is `4000` then `retry_interval` should be `0` or no less then `400`.
449
+ <br>2. `retry_interval` is not required when `completion_event=Callback`.
450
+ """
451
+ return pulumi.get(self, "retry_interval")
452
+
453
+ @retry_interval.setter
454
+ def retry_interval(self, value: Optional[pulumi.Input[int]]):
455
+ pulumi.set(self, "retry_interval", value)
456
+
457
+ @property
458
+ @pulumi.getter(name="successCriteria")
459
+ def success_criteria(self) -> Optional[pulumi.Input[str]]:
460
+ """
461
+ The Criteria which defines when to pass the task. No criteria means response content does not influence the result.
462
+
463
+ ~>**NOTE** `success_criteria` is used when `completion_event=ApiResponse`
464
+ """
465
+ return pulumi.get(self, "success_criteria")
466
+
467
+ @success_criteria.setter
468
+ def success_criteria(self, value: Optional[pulumi.Input[str]]):
469
+ pulumi.set(self, "success_criteria", value)
470
+
471
+ @property
472
+ @pulumi.getter(name="targetResourceId")
473
+ def target_resource_id(self) -> Optional[pulumi.Input[str]]:
474
+ """
475
+ The ID of the resource being protected by the check. Changing this forces a new resource to be created
476
+ """
477
+ return pulumi.get(self, "target_resource_id")
478
+
479
+ @target_resource_id.setter
480
+ def target_resource_id(self, value: Optional[pulumi.Input[str]]):
481
+ pulumi.set(self, "target_resource_id", value)
482
+
483
+ @property
484
+ @pulumi.getter(name="targetResourceType")
485
+ def target_resource_type(self) -> Optional[pulumi.Input[str]]:
486
+ """
487
+ The type of resource being protected by the check. Possible values: `endpoint`, `environment`, `queue`, `repository`, `securefile`, `variablegroup`. Changing this forces a new resource to be created.
488
+ """
489
+ return pulumi.get(self, "target_resource_type")
490
+
491
+ @target_resource_type.setter
492
+ def target_resource_type(self, value: Optional[pulumi.Input[str]]):
493
+ pulumi.set(self, "target_resource_type", value)
494
+
495
+ @property
496
+ @pulumi.getter
497
+ def timeout(self) -> Optional[pulumi.Input[int]]:
498
+ """
499
+ The timeout in minutes for the Rest API check. Defaults to `1440`.
500
+ """
501
+ return pulumi.get(self, "timeout")
502
+
503
+ @timeout.setter
504
+ def timeout(self, value: Optional[pulumi.Input[int]]):
505
+ pulumi.set(self, "timeout", value)
506
+
507
+ @property
508
+ @pulumi.getter(name="urlSuffix")
509
+ def url_suffix(self) -> Optional[pulumi.Input[str]]:
510
+ """
511
+ The URL suffix and parameters.
512
+ """
513
+ return pulumi.get(self, "url_suffix")
514
+
515
+ @url_suffix.setter
516
+ def url_suffix(self, value: Optional[pulumi.Input[str]]):
517
+ pulumi.set(self, "url_suffix", value)
518
+
519
+ @property
520
+ @pulumi.getter(name="variableGroupName")
521
+ def variable_group_name(self) -> Optional[pulumi.Input[str]]:
522
+ """
523
+ The name of the Variable Group.
524
+ """
525
+ return pulumi.get(self, "variable_group_name")
526
+
527
+ @variable_group_name.setter
528
+ def variable_group_name(self, value: Optional[pulumi.Input[str]]):
529
+ pulumi.set(self, "variable_group_name", value)
530
+
531
+ @property
532
+ @pulumi.getter
533
+ def version(self) -> Optional[pulumi.Input[int]]:
534
+ """
535
+ The version of the Rest API check.
536
+ """
537
+ return pulumi.get(self, "version")
538
+
539
+ @version.setter
540
+ def version(self, value: Optional[pulumi.Input[int]]):
541
+ pulumi.set(self, "version", value)
542
+
543
+
544
+ class CheckRestApi(pulumi.CustomResource):
545
+ @overload
546
+ def __init__(__self__,
547
+ resource_name: str,
548
+ opts: Optional[pulumi.ResourceOptions] = None,
549
+ body: Optional[pulumi.Input[str]] = None,
550
+ completion_event: Optional[pulumi.Input[str]] = None,
551
+ connected_service_name: Optional[pulumi.Input[str]] = None,
552
+ connected_service_name_selector: Optional[pulumi.Input[str]] = None,
553
+ display_name: Optional[pulumi.Input[str]] = None,
554
+ headers: Optional[pulumi.Input[str]] = None,
555
+ method: Optional[pulumi.Input[str]] = None,
556
+ project_id: Optional[pulumi.Input[str]] = None,
557
+ retry_interval: Optional[pulumi.Input[int]] = None,
558
+ success_criteria: Optional[pulumi.Input[str]] = None,
559
+ target_resource_id: Optional[pulumi.Input[str]] = None,
560
+ target_resource_type: Optional[pulumi.Input[str]] = None,
561
+ timeout: Optional[pulumi.Input[int]] = None,
562
+ url_suffix: Optional[pulumi.Input[str]] = None,
563
+ variable_group_name: Optional[pulumi.Input[str]] = None,
564
+ __props__=None):
565
+ """
566
+ Manages a Rest API check on a resource within Azure DevOps.
567
+
568
+ ## Example Usage
569
+
570
+ ```python
571
+ import pulumi
572
+ import pulumi_azuredevops as azuredevops
573
+
574
+ example = azuredevops.Project("example", name="Example Project")
575
+ example_service_endpoint_generic = azuredevops.ServiceEndpointGeneric("example",
576
+ project_id=example.id,
577
+ server_url="https://some-server.example.com",
578
+ service_endpoint_name="Example Generic",
579
+ username="username",
580
+ password="password",
581
+ description="Managed by Pulumi")
582
+ example_azure = azuredevops.ServiceEndpointGeneric("example_azure",
583
+ project_id=example.id,
584
+ server_url="https://dev.azure.com/",
585
+ service_endpoint_name="Example Generic Azure",
586
+ username="username",
587
+ password="dummy")
588
+ example_variable_group = azuredevops.VariableGroup("example",
589
+ project_id=example.id,
590
+ name="Example Variable Group",
591
+ allow_access=True,
592
+ variables=[{
593
+ "name": "FOO",
594
+ "value": "BAR",
595
+ }])
596
+ example_check_rest_api = azuredevops.CheckRestApi("example",
597
+ project_id=example.id,
598
+ target_resource_id=example_service_endpoint_generic.id,
599
+ target_resource_type="endpoint",
600
+ display_name="Example REST API Check",
601
+ connected_service_name_selector="connectedServiceName",
602
+ connected_service_name=example_azure.service_endpoint_name,
603
+ method="POST",
604
+ headers="{\\"contentType\\":\\"application/json\\"}",
605
+ body="{\\"params\\":\\"value\\"}",
606
+ completion_event="ApiResponse",
607
+ success_criteria="eq(root['status'], '200')",
608
+ url_suffix="user/1",
609
+ retry_interval=4000,
610
+ variable_group_name=example_variable_group.name,
611
+ timeout=40000)
612
+ ```
613
+
614
+ ## Relevant Links
615
+
616
+ - [Define approvals and checks](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/approvals?view=azure-devops&tabs=check-pass)
617
+
618
+ ## Import
619
+
620
+ Importing this resource is not supported.
621
+
622
+ :param str resource_name: The name of the resource.
623
+ :param pulumi.ResourceOptions opts: Options for the resource.
624
+ :param pulumi.Input[str] body: The Rest API request body.
625
+ :param pulumi.Input[str] completion_event: The completion event of the Rest API call. Possible values: `Callback`, `ApiResponse`. Defaults to `Callback`.
626
+ :param pulumi.Input[str] connected_service_name: The name of the Service Connection.
627
+ :param pulumi.Input[str] connected_service_name_selector: The type of the Service Connection used to invoke the REST API. Possible values: `connectedServiceName`(**Generic** type service connection) and `connectedServiceNameARM`(**Azure Resource Manager** type service connection).
628
+ :param pulumi.Input[str] display_name: The Name of the Rest API check.
629
+ :param pulumi.Input[str] headers: The headers of the request in JSON format.
630
+ :param pulumi.Input[str] method: The HTTP method of the request. Possible values: `OPTIONS`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `TRACE`, `PATCH`
631
+ :param pulumi.Input[str] project_id: The ID of the project. Changing this forces a new resource to be created.
632
+ :param pulumi.Input[int] retry_interval: The time between evaluations (minutes).
633
+
634
+ ~>**NOTE** 1. The retry times should less them 10 based on the timeout. For example: `timeout` is `4000` then `retry_interval` should be `0` or no less then `400`.
635
+ <br>2. `retry_interval` is not required when `completion_event=Callback`.
636
+ :param pulumi.Input[str] success_criteria: The Criteria which defines when to pass the task. No criteria means response content does not influence the result.
637
+
638
+ ~>**NOTE** `success_criteria` is used when `completion_event=ApiResponse`
639
+ :param pulumi.Input[str] target_resource_id: The ID of the resource being protected by the check. Changing this forces a new resource to be created
640
+ :param pulumi.Input[str] target_resource_type: The type of resource being protected by the check. Possible values: `endpoint`, `environment`, `queue`, `repository`, `securefile`, `variablegroup`. Changing this forces a new resource to be created.
641
+ :param pulumi.Input[int] timeout: The timeout in minutes for the Rest API check. Defaults to `1440`.
642
+ :param pulumi.Input[str] url_suffix: The URL suffix and parameters.
643
+ :param pulumi.Input[str] variable_group_name: The name of the Variable Group.
644
+ """
645
+ ...
646
+ @overload
647
+ def __init__(__self__,
648
+ resource_name: str,
649
+ args: CheckRestApiArgs,
650
+ opts: Optional[pulumi.ResourceOptions] = None):
651
+ """
652
+ Manages a Rest API check on a resource within Azure DevOps.
653
+
654
+ ## Example Usage
655
+
656
+ ```python
657
+ import pulumi
658
+ import pulumi_azuredevops as azuredevops
659
+
660
+ example = azuredevops.Project("example", name="Example Project")
661
+ example_service_endpoint_generic = azuredevops.ServiceEndpointGeneric("example",
662
+ project_id=example.id,
663
+ server_url="https://some-server.example.com",
664
+ service_endpoint_name="Example Generic",
665
+ username="username",
666
+ password="password",
667
+ description="Managed by Pulumi")
668
+ example_azure = azuredevops.ServiceEndpointGeneric("example_azure",
669
+ project_id=example.id,
670
+ server_url="https://dev.azure.com/",
671
+ service_endpoint_name="Example Generic Azure",
672
+ username="username",
673
+ password="dummy")
674
+ example_variable_group = azuredevops.VariableGroup("example",
675
+ project_id=example.id,
676
+ name="Example Variable Group",
677
+ allow_access=True,
678
+ variables=[{
679
+ "name": "FOO",
680
+ "value": "BAR",
681
+ }])
682
+ example_check_rest_api = azuredevops.CheckRestApi("example",
683
+ project_id=example.id,
684
+ target_resource_id=example_service_endpoint_generic.id,
685
+ target_resource_type="endpoint",
686
+ display_name="Example REST API Check",
687
+ connected_service_name_selector="connectedServiceName",
688
+ connected_service_name=example_azure.service_endpoint_name,
689
+ method="POST",
690
+ headers="{\\"contentType\\":\\"application/json\\"}",
691
+ body="{\\"params\\":\\"value\\"}",
692
+ completion_event="ApiResponse",
693
+ success_criteria="eq(root['status'], '200')",
694
+ url_suffix="user/1",
695
+ retry_interval=4000,
696
+ variable_group_name=example_variable_group.name,
697
+ timeout=40000)
698
+ ```
699
+
700
+ ## Relevant Links
701
+
702
+ - [Define approvals and checks](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/approvals?view=azure-devops&tabs=check-pass)
703
+
704
+ ## Import
705
+
706
+ Importing this resource is not supported.
707
+
708
+ :param str resource_name: The name of the resource.
709
+ :param CheckRestApiArgs args: The arguments to use to populate this resource's properties.
710
+ :param pulumi.ResourceOptions opts: Options for the resource.
711
+ """
712
+ ...
713
+ def __init__(__self__, resource_name: str, *args, **kwargs):
714
+ resource_args, opts = _utilities.get_resource_args_opts(CheckRestApiArgs, pulumi.ResourceOptions, *args, **kwargs)
715
+ if resource_args is not None:
716
+ __self__._internal_init(resource_name, opts, **resource_args.__dict__)
717
+ else:
718
+ __self__._internal_init(resource_name, *args, **kwargs)
719
+
720
+ def _internal_init(__self__,
721
+ resource_name: str,
722
+ opts: Optional[pulumi.ResourceOptions] = None,
723
+ body: Optional[pulumi.Input[str]] = None,
724
+ completion_event: Optional[pulumi.Input[str]] = None,
725
+ connected_service_name: Optional[pulumi.Input[str]] = None,
726
+ connected_service_name_selector: Optional[pulumi.Input[str]] = None,
727
+ display_name: Optional[pulumi.Input[str]] = None,
728
+ headers: Optional[pulumi.Input[str]] = None,
729
+ method: Optional[pulumi.Input[str]] = None,
730
+ project_id: Optional[pulumi.Input[str]] = None,
731
+ retry_interval: Optional[pulumi.Input[int]] = None,
732
+ success_criteria: Optional[pulumi.Input[str]] = None,
733
+ target_resource_id: Optional[pulumi.Input[str]] = None,
734
+ target_resource_type: Optional[pulumi.Input[str]] = None,
735
+ timeout: Optional[pulumi.Input[int]] = None,
736
+ url_suffix: Optional[pulumi.Input[str]] = None,
737
+ variable_group_name: Optional[pulumi.Input[str]] = None,
738
+ __props__=None):
739
+ opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
740
+ if not isinstance(opts, pulumi.ResourceOptions):
741
+ raise TypeError('Expected resource options to be a ResourceOptions instance')
742
+ if opts.id is None:
743
+ if __props__ is not None:
744
+ raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
745
+ __props__ = CheckRestApiArgs.__new__(CheckRestApiArgs)
746
+
747
+ __props__.__dict__["body"] = body
748
+ __props__.__dict__["completion_event"] = completion_event
749
+ if connected_service_name is None and not opts.urn:
750
+ raise TypeError("Missing required property 'connected_service_name'")
751
+ __props__.__dict__["connected_service_name"] = connected_service_name
752
+ if connected_service_name_selector is None and not opts.urn:
753
+ raise TypeError("Missing required property 'connected_service_name_selector'")
754
+ __props__.__dict__["connected_service_name_selector"] = connected_service_name_selector
755
+ if display_name is None and not opts.urn:
756
+ raise TypeError("Missing required property 'display_name'")
757
+ __props__.__dict__["display_name"] = display_name
758
+ __props__.__dict__["headers"] = headers
759
+ if method is None and not opts.urn:
760
+ raise TypeError("Missing required property 'method'")
761
+ __props__.__dict__["method"] = method
762
+ if project_id is None and not opts.urn:
763
+ raise TypeError("Missing required property 'project_id'")
764
+ __props__.__dict__["project_id"] = project_id
765
+ __props__.__dict__["retry_interval"] = retry_interval
766
+ __props__.__dict__["success_criteria"] = success_criteria
767
+ if target_resource_id is None and not opts.urn:
768
+ raise TypeError("Missing required property 'target_resource_id'")
769
+ __props__.__dict__["target_resource_id"] = target_resource_id
770
+ if target_resource_type is None and not opts.urn:
771
+ raise TypeError("Missing required property 'target_resource_type'")
772
+ __props__.__dict__["target_resource_type"] = target_resource_type
773
+ __props__.__dict__["timeout"] = timeout
774
+ __props__.__dict__["url_suffix"] = url_suffix
775
+ __props__.__dict__["variable_group_name"] = variable_group_name
776
+ __props__.__dict__["version"] = None
777
+ super(CheckRestApi, __self__).__init__(
778
+ 'azuredevops:index/checkRestApi:CheckRestApi',
779
+ resource_name,
780
+ __props__,
781
+ opts)
782
+
783
+ @staticmethod
784
+ def get(resource_name: str,
785
+ id: pulumi.Input[str],
786
+ opts: Optional[pulumi.ResourceOptions] = None,
787
+ body: Optional[pulumi.Input[str]] = None,
788
+ completion_event: Optional[pulumi.Input[str]] = None,
789
+ connected_service_name: Optional[pulumi.Input[str]] = None,
790
+ connected_service_name_selector: Optional[pulumi.Input[str]] = None,
791
+ display_name: Optional[pulumi.Input[str]] = None,
792
+ headers: Optional[pulumi.Input[str]] = None,
793
+ method: Optional[pulumi.Input[str]] = None,
794
+ project_id: Optional[pulumi.Input[str]] = None,
795
+ retry_interval: Optional[pulumi.Input[int]] = None,
796
+ success_criteria: Optional[pulumi.Input[str]] = None,
797
+ target_resource_id: Optional[pulumi.Input[str]] = None,
798
+ target_resource_type: Optional[pulumi.Input[str]] = None,
799
+ timeout: Optional[pulumi.Input[int]] = None,
800
+ url_suffix: Optional[pulumi.Input[str]] = None,
801
+ variable_group_name: Optional[pulumi.Input[str]] = None,
802
+ version: Optional[pulumi.Input[int]] = None) -> 'CheckRestApi':
803
+ """
804
+ Get an existing CheckRestApi resource's state with the given name, id, and optional extra
805
+ properties used to qualify the lookup.
806
+
807
+ :param str resource_name: The unique name of the resulting resource.
808
+ :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
809
+ :param pulumi.ResourceOptions opts: Options for the resource.
810
+ :param pulumi.Input[str] body: The Rest API request body.
811
+ :param pulumi.Input[str] completion_event: The completion event of the Rest API call. Possible values: `Callback`, `ApiResponse`. Defaults to `Callback`.
812
+ :param pulumi.Input[str] connected_service_name: The name of the Service Connection.
813
+ :param pulumi.Input[str] connected_service_name_selector: The type of the Service Connection used to invoke the REST API. Possible values: `connectedServiceName`(**Generic** type service connection) and `connectedServiceNameARM`(**Azure Resource Manager** type service connection).
814
+ :param pulumi.Input[str] display_name: The Name of the Rest API check.
815
+ :param pulumi.Input[str] headers: The headers of the request in JSON format.
816
+ :param pulumi.Input[str] method: The HTTP method of the request. Possible values: `OPTIONS`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `TRACE`, `PATCH`
817
+ :param pulumi.Input[str] project_id: The ID of the project. Changing this forces a new resource to be created.
818
+ :param pulumi.Input[int] retry_interval: The time between evaluations (minutes).
819
+
820
+ ~>**NOTE** 1. The retry times should less them 10 based on the timeout. For example: `timeout` is `4000` then `retry_interval` should be `0` or no less then `400`.
821
+ <br>2. `retry_interval` is not required when `completion_event=Callback`.
822
+ :param pulumi.Input[str] success_criteria: The Criteria which defines when to pass the task. No criteria means response content does not influence the result.
823
+
824
+ ~>**NOTE** `success_criteria` is used when `completion_event=ApiResponse`
825
+ :param pulumi.Input[str] target_resource_id: The ID of the resource being protected by the check. Changing this forces a new resource to be created
826
+ :param pulumi.Input[str] target_resource_type: The type of resource being protected by the check. Possible values: `endpoint`, `environment`, `queue`, `repository`, `securefile`, `variablegroup`. Changing this forces a new resource to be created.
827
+ :param pulumi.Input[int] timeout: The timeout in minutes for the Rest API check. Defaults to `1440`.
828
+ :param pulumi.Input[str] url_suffix: The URL suffix and parameters.
829
+ :param pulumi.Input[str] variable_group_name: The name of the Variable Group.
830
+ :param pulumi.Input[int] version: The version of the Rest API check.
831
+ """
832
+ opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
833
+
834
+ __props__ = _CheckRestApiState.__new__(_CheckRestApiState)
835
+
836
+ __props__.__dict__["body"] = body
837
+ __props__.__dict__["completion_event"] = completion_event
838
+ __props__.__dict__["connected_service_name"] = connected_service_name
839
+ __props__.__dict__["connected_service_name_selector"] = connected_service_name_selector
840
+ __props__.__dict__["display_name"] = display_name
841
+ __props__.__dict__["headers"] = headers
842
+ __props__.__dict__["method"] = method
843
+ __props__.__dict__["project_id"] = project_id
844
+ __props__.__dict__["retry_interval"] = retry_interval
845
+ __props__.__dict__["success_criteria"] = success_criteria
846
+ __props__.__dict__["target_resource_id"] = target_resource_id
847
+ __props__.__dict__["target_resource_type"] = target_resource_type
848
+ __props__.__dict__["timeout"] = timeout
849
+ __props__.__dict__["url_suffix"] = url_suffix
850
+ __props__.__dict__["variable_group_name"] = variable_group_name
851
+ __props__.__dict__["version"] = version
852
+ return CheckRestApi(resource_name, opts=opts, __props__=__props__)
853
+
854
+ @property
855
+ @pulumi.getter
856
+ def body(self) -> pulumi.Output[Optional[str]]:
857
+ """
858
+ The Rest API request body.
859
+ """
860
+ return pulumi.get(self, "body")
861
+
862
+ @property
863
+ @pulumi.getter(name="completionEvent")
864
+ def completion_event(self) -> pulumi.Output[Optional[str]]:
865
+ """
866
+ The completion event of the Rest API call. Possible values: `Callback`, `ApiResponse`. Defaults to `Callback`.
867
+ """
868
+ return pulumi.get(self, "completion_event")
869
+
870
+ @property
871
+ @pulumi.getter(name="connectedServiceName")
872
+ def connected_service_name(self) -> pulumi.Output[str]:
873
+ """
874
+ The name of the Service Connection.
875
+ """
876
+ return pulumi.get(self, "connected_service_name")
877
+
878
+ @property
879
+ @pulumi.getter(name="connectedServiceNameSelector")
880
+ def connected_service_name_selector(self) -> pulumi.Output[str]:
881
+ """
882
+ The type of the Service Connection used to invoke the REST API. Possible values: `connectedServiceName`(**Generic** type service connection) and `connectedServiceNameARM`(**Azure Resource Manager** type service connection).
883
+ """
884
+ return pulumi.get(self, "connected_service_name_selector")
885
+
886
+ @property
887
+ @pulumi.getter(name="displayName")
888
+ def display_name(self) -> pulumi.Output[str]:
889
+ """
890
+ The Name of the Rest API check.
891
+ """
892
+ return pulumi.get(self, "display_name")
893
+
894
+ @property
895
+ @pulumi.getter
896
+ def headers(self) -> pulumi.Output[Optional[str]]:
897
+ """
898
+ The headers of the request in JSON format.
899
+ """
900
+ return pulumi.get(self, "headers")
901
+
902
+ @property
903
+ @pulumi.getter
904
+ def method(self) -> pulumi.Output[str]:
905
+ """
906
+ The HTTP method of the request. Possible values: `OPTIONS`, `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `TRACE`, `PATCH`
907
+ """
908
+ return pulumi.get(self, "method")
909
+
910
+ @property
911
+ @pulumi.getter(name="projectId")
912
+ def project_id(self) -> pulumi.Output[str]:
913
+ """
914
+ The ID of the project. Changing this forces a new resource to be created.
915
+ """
916
+ return pulumi.get(self, "project_id")
917
+
918
+ @property
919
+ @pulumi.getter(name="retryInterval")
920
+ def retry_interval(self) -> pulumi.Output[Optional[int]]:
921
+ """
922
+ The time between evaluations (minutes).
923
+
924
+ ~>**NOTE** 1. The retry times should less them 10 based on the timeout. For example: `timeout` is `4000` then `retry_interval` should be `0` or no less then `400`.
925
+ <br>2. `retry_interval` is not required when `completion_event=Callback`.
926
+ """
927
+ return pulumi.get(self, "retry_interval")
928
+
929
+ @property
930
+ @pulumi.getter(name="successCriteria")
931
+ def success_criteria(self) -> pulumi.Output[Optional[str]]:
932
+ """
933
+ The Criteria which defines when to pass the task. No criteria means response content does not influence the result.
934
+
935
+ ~>**NOTE** `success_criteria` is used when `completion_event=ApiResponse`
936
+ """
937
+ return pulumi.get(self, "success_criteria")
938
+
939
+ @property
940
+ @pulumi.getter(name="targetResourceId")
941
+ def target_resource_id(self) -> pulumi.Output[str]:
942
+ """
943
+ The ID of the resource being protected by the check. Changing this forces a new resource to be created
944
+ """
945
+ return pulumi.get(self, "target_resource_id")
946
+
947
+ @property
948
+ @pulumi.getter(name="targetResourceType")
949
+ def target_resource_type(self) -> pulumi.Output[str]:
950
+ """
951
+ The type of resource being protected by the check. Possible values: `endpoint`, `environment`, `queue`, `repository`, `securefile`, `variablegroup`. Changing this forces a new resource to be created.
952
+ """
953
+ return pulumi.get(self, "target_resource_type")
954
+
955
+ @property
956
+ @pulumi.getter
957
+ def timeout(self) -> pulumi.Output[Optional[int]]:
958
+ """
959
+ The timeout in minutes for the Rest API check. Defaults to `1440`.
960
+ """
961
+ return pulumi.get(self, "timeout")
962
+
963
+ @property
964
+ @pulumi.getter(name="urlSuffix")
965
+ def url_suffix(self) -> pulumi.Output[Optional[str]]:
966
+ """
967
+ The URL suffix and parameters.
968
+ """
969
+ return pulumi.get(self, "url_suffix")
970
+
971
+ @property
972
+ @pulumi.getter(name="variableGroupName")
973
+ def variable_group_name(self) -> pulumi.Output[Optional[str]]:
974
+ """
975
+ The name of the Variable Group.
976
+ """
977
+ return pulumi.get(self, "variable_group_name")
978
+
979
+ @property
980
+ @pulumi.getter
981
+ def version(self) -> pulumi.Output[int]:
982
+ """
983
+ The version of the Rest API check.
984
+ """
985
+ return pulumi.get(self, "version")
986
+