ProvidersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:providers> attribute.
- Inheritance
-
builtins.objectProvidersOperations
Constructor
ProvidersOperations(*args, **kwargs)
Methods
get |
Gets the specified resource provider. |
get_at_tenant_scope |
Gets the specified resource provider at the tenant level. |
list |
Gets all resource providers for a subscription. |
list_at_tenant_scope |
Gets all resource providers for the tenant. |
provider_permissions |
Get the provider permissions. |
register |
Registers a subscription with a resource provider. |
register_at_management_group_scope |
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. |
unregister |
Unregisters a subscription from a resource provider. |
get
Gets the specified resource provider.
get(resource_provider_namespace: str, expand: str | None = None, **kwargs: Any) -> Provider
Parameters
Name | Description |
---|---|
resource_provider_namespace
Required
|
The namespace of the resource provider. Required. |
expand
Required
|
The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. Default value is None. |
Returns
Type | Description |
---|---|
Provider or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_at_tenant_scope
Gets the specified resource provider at the tenant level.
get_at_tenant_scope(resource_provider_namespace: str, expand: str | None = None, **kwargs: Any) -> Provider
Parameters
Name | Description |
---|---|
resource_provider_namespace
Required
|
The namespace of the resource provider. Required. |
expand
Required
|
The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. Default value is None. |
Returns
Type | Description |
---|---|
Provider or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list
Gets all resource providers for a subscription.
list(expand: str | None = None, **kwargs: Any) -> Iterable[Provider]
Parameters
Name | Description |
---|---|
expand
Required
|
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. |
Returns
Type | Description |
---|---|
An iterator like instance of either Provider or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_at_tenant_scope
Gets all resource providers for the tenant.
list_at_tenant_scope(expand: str | None = None, **kwargs: Any) -> Iterable[Provider]
Parameters
Name | Description |
---|---|
expand
Required
|
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. |
Returns
Type | Description |
---|---|
An iterator like instance of either Provider or the result of cls(response) |
Exceptions
Type | Description |
---|---|
provider_permissions
Get the provider permissions.
provider_permissions(resource_provider_namespace: str, **kwargs: Any) -> ProviderPermissionListResult
Parameters
Name | Description |
---|---|
resource_provider_namespace
Required
|
The namespace of the resource provider. Required. |
Returns
Type | Description |
---|---|
ProviderPermissionListResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
register
Registers a subscription with a resource provider.
register(resource_provider_namespace: str, properties: _models.ProviderRegistrationRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Provider
Parameters
Name | Description |
---|---|
resource_provider_namespace
Required
|
The namespace of the resource provider to register. Required. |
properties
Required
|
The third party consent for S2S. Is either a ProviderRegistrationRequest type or a IO[bytes] type. Default value is None. |
Returns
Type | Description |
---|---|
Provider or the result of cls(response) |
Exceptions
Type | Description |
---|---|
register_at_management_group_scope
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.
register_at_management_group_scope(resource_provider_namespace: str, group_id: str, **kwargs: Any) -> None
Parameters
Name | Description |
---|---|
resource_provider_namespace
Required
|
The namespace of the resource provider to register. Required. |
group_id
Required
|
The management group ID. Required. |
Returns
Type | Description |
---|---|
None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
unregister
Unregisters a subscription from a resource provider.
unregister(resource_provider_namespace: str, **kwargs: Any) -> Provider
Parameters
Name | Description |
---|---|
resource_provider_namespace
Required
|
The namespace of the resource provider to unregister. Required. |
Returns
Type | Description |
---|---|
Provider or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.resource.resources.v2022_09_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2022_09_01\\models\\__init__.py'>
Azure SDK for Python