ProvidersOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ResourceManagementClient's

<xref:providers> attribute.

Inheritance
builtins.object
ProvidersOperations

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.

async get(resource_provider_namespace: str, expand: str | None = None, **kwargs: Any) -> Provider

Parameters

Name Description
resource_provider_namespace
Required
str

The namespace of the resource provider. Required.
expand
Required
str

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. Default value is None.

Returns

Type Description
Provider

Provider or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_at_tenant_scope

Gets the specified resource provider at the tenant level.

async get_at_tenant_scope(resource_provider_namespace: str, expand: str | None = None, **kwargs: Any) -> Provider

Parameters

Name Description
resource_provider_namespace
Required
str

The namespace of the resource provider. Required.
expand
Required
str

The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. Default value is None.

Returns

Type Description
Provider

Provider or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all resource providers for a subscription.

list(expand: str | None = None, **kwargs: Any) -> AsyncIterable[Provider]

Parameters

Name Description
expand
Required
str

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
AsyncItemPaged[Provider]

An iterator like instance of either Provider or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_at_tenant_scope

Gets all resource providers for the tenant.

list_at_tenant_scope(expand: str | None = None, **kwargs: Any) -> AsyncIterable[Provider]

Parameters

Name Description
expand
Required
str

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
AsyncItemPaged[Provider]

An iterator like instance of either Provider or the result of cls(response)

Exceptions

Type Description
HttpResponseError

provider_permissions

Get the provider permissions.

async provider_permissions(resource_provider_namespace: str, **kwargs: Any) -> ProviderPermissionListResult

Parameters

Name Description
resource_provider_namespace
Required
str

The namespace of the resource provider. Required.

Returns

Type Description
ProviderPermissionListResult

ProviderPermissionListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

register

Registers a subscription with a resource provider.

async 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
str

The namespace of the resource provider to register. Required.
properties
Required
ProviderRegistrationRequest or IO[bytes]

The third party consent for S2S. Is either a ProviderRegistrationRequest type or a IO[bytes] type. Default value is None.

Returns

Type Description
Provider

Provider or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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.

async register_at_management_group_scope(resource_provider_namespace: str, group_id: str, **kwargs: Any) -> None

Parameters

Name Description
resource_provider_namespace
Required
str

The namespace of the resource provider to register. Required.
group_id
Required
str

The management group ID. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

unregister

Unregisters a subscription from a resource provider.

async unregister(resource_provider_namespace: str, **kwargs: Any) -> Provider

Parameters

Name Description
resource_provider_namespace
Required
str

The namespace of the resource provider to unregister. Required.

Returns

Type Description
Provider

Provider or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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'>