Dela via

ProvidersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ResourceManagementClient's

<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.
register

Registers a subscription with a resource provider.
register_at_management_group_scope

Registers a management group with a resource provider.
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
str

The namespace of the resource provider. Required.
expand
str

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

Provider or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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
str

The namespace of the resource provider. Required.
expand
str

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

Provider or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all resource providers for a subscription.

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

Parameters

Name Description
top
int

The number of results to return. If null is passed returns all deployments. Default value is None.

Default value: None
expand
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.

Default value: None

Returns

Type Description
ItemPaged[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(top: int | None = None, expand: str | None = None, **kwargs: Any) -> ItemPaged[Provider]

Parameters

Name Description
top
int

The number of results to return. If null is passed returns all providers. Default value is None.

Default value: None
expand
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.

Default value: None

Returns

Type Description
ItemPaged[Provider]

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

Exceptions

Type Description
HttpResponseError

register

Registers a subscription with a resource provider.

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

Parameters

Name Description
resource_provider_namespace
Required
str

The namespace of the resource provider to register. Required.

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.

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.

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.v2021_01_01.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv206\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2021_01_01\\models\\__init__.py'>