ProvidersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:providers> attribute.
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) -> ProviderParameters
| Name | Description |
|---|---|
|
resource_provider_namespace
Required
|
The namespace of the resource provider. Required. |
|
expand
|
The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. Default value is None. Default value: 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) -> ProviderParameters
| Name | Description |
|---|---|
|
resource_provider_namespace
Required
|
The namespace of the resource provider. Required. |
|
expand
|
The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. Default value is None. Default value: 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) -> ItemPaged[Provider]Parameters
| Name | Description |
|---|---|
|
expand
|
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. Default value: 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) -> ItemPaged[Provider]Parameters
| Name | Description |
|---|---|
|
expand
|
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. Default value: 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) -> ProviderPermissionListResultParameters
| 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.ProviderParameters
| Name | Description |
|---|---|
|
resource_provider_namespace
Required
|
The namespace of the resource provider to register. Required. |
|
properties
|
The third party consent for S2S. Is either a ProviderRegistrationRequest type or a IO[bytes] type. Default value is None. Default value: 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) -> NoneParameters
| 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) -> ProviderParameters
| 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:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv206\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2022_09_01\\models\\__init__.py'>