/
azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.yml
208 lines (195 loc) · 8.02 KB
/
azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
### YamlMime:PythonClass
uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations
name: ProvidersOperations
fullName: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations
module: azure.mgmt.resource.resources.v2021_04_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
\ you should access the following operations through\n>\n> <xref:azure.mgmt.resource.resources.v2021_04_01.ResourceManagementClient>'s\n\
>\n> <xref:providers> attribute.\n>"
constructor:
syntax: ProvidersOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.get
name: get
summary: Gets the specified resource provider.
signature: 'get(resource_provider_namespace: str, expand: str | None = None, **kwargs:
Any) -> Provider'
parameters:
- name: resource_provider_namespace
description: The namespace of the resource provider. Required.
isRequired: true
types:
- <xref:str>
- name: expand
description: 'The $expand query parameter. For example, to include property aliases
in
response, use $expand=resourceTypes/aliases. Default value is None.'
isRequired: true
types:
- <xref:str>
return:
description: Provider or the result of cls(response)
types:
- <xref:azure.mgmt.resource.resources.v2021_04_01.models.Provider>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.get_at_tenant_scope
name: get_at_tenant_scope
summary: Gets the specified resource provider at the tenant level.
signature: 'get_at_tenant_scope(resource_provider_namespace: str, expand: str |
None = None, **kwargs: Any) -> Provider'
parameters:
- name: resource_provider_namespace
description: The namespace of the resource provider. Required.
isRequired: true
types:
- <xref:str>
- name: expand
description: 'The $expand query parameter. For example, to include property aliases
in
response, use $expand=resourceTypes/aliases. Default value is None.'
isRequired: true
types:
- <xref:str>
return:
description: Provider or the result of cls(response)
types:
- <xref:azure.mgmt.resource.resources.v2021_04_01.models.Provider>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.list
name: list
summary: Gets all resource providers for a subscription.
signature: 'list(expand: str | None = None, **kwargs: Any) -> Iterable[Provider]'
parameters:
- name: expand
description: 'The properties to include in the results. For example, use &$expand=metadata
in
the query string to retrieve resource provider metadata. To include property
aliases in
response, use $expand=resourceTypes/aliases. Default value is None.'
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either Provider or the result of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.resources.v2021_04_01.models.Provider>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.list_at_tenant_scope
name: list_at_tenant_scope
summary: Gets all resource providers for the tenant.
signature: 'list_at_tenant_scope(expand: str | None = None, **kwargs: Any) -> Iterable[Provider]'
parameters:
- name: expand
description: 'The properties to include in the results. For example, use &$expand=metadata
in
the query string to retrieve resource provider metadata. To include property
aliases in
response, use $expand=resourceTypes/aliases. Default value is None.'
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either Provider or the result of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.resources.v2021_04_01.models.Provider>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.provider_permissions
name: provider_permissions
summary: Get the provider permissions.
signature: 'provider_permissions(resource_provider_namespace: str, **kwargs: Any)
-> ProviderPermissionListResult'
parameters:
- name: resource_provider_namespace
description: The namespace of the resource provider. Required.
isRequired: true
types:
- <xref:str>
return:
description: ProviderPermissionListResult or the result of cls(response)
types:
- <xref:azure.mgmt.resource.resources.v2021_04_01.models.ProviderPermissionListResult>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.register
name: register
summary: Registers a subscription with a resource provider.
signature: 'register(resource_provider_namespace: str, properties: _models.ProviderRegistrationRequest
| None = None, *, content_type: str = ''application/json'', **kwargs: Any) ->
_models.Provider'
parameters:
- name: resource_provider_namespace
description: 'The namespace of the resource provider to register.
Required.'
isRequired: true
types:
- <xref:str>
- name: properties
description: 'The third party consent for S2S. Is either a ProviderRegistrationRequest
type or a IO[bytes] type. Default value is None.'
isRequired: true
types:
- <xref:azure.mgmt.resource.resources.v2021_04_01.models.ProviderRegistrationRequest>
- <xref:typing.IO>[<xref:bytes>]
return:
description: Provider or the result of cls(response)
types:
- <xref:azure.mgmt.resource.resources.v2021_04_01.models.Provider>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.register_at_management_group_scope
name: register_at_management_group_scope
summary: 'Registers a management group with a resource provider. Use this operation
to register a
resource provider with resource types that can be deployed at the management group
scope. It
does not recursively register subscriptions within the management group. Instead,
you must
register subscriptions individually.'
signature: 'register_at_management_group_scope(resource_provider_namespace: str,
group_id: str, **kwargs: Any) -> None'
parameters:
- name: resource_provider_namespace
description: 'The namespace of the resource provider to register.
Required.'
isRequired: true
types:
- <xref:str>
- name: group_id
description: The management group ID. Required.
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.unregister
name: unregister
summary: Unregisters a subscription from a resource provider.
signature: 'unregister(resource_provider_namespace: str, **kwargs: Any) -> Provider'
parameters:
- name: resource_provider_namespace
description: 'The namespace of the resource provider to unregister.
Required.'
isRequired: true
types:
- <xref:str>
return:
description: Provider or the result of cls(response)
types:
- <xref:azure.mgmt.resource.resources.v2021_04_01.models.Provider>
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.resource.resources.v2021_04_01.operations.ProvidersOperations.models
name: models
signature: models = <module 'azure.mgmt.resource.resources.v2021_04_01.models' from
'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2021_04_01\\models\\__init__.py'>