ProvidersOperations Class

ProvidersOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

ProvidersOperations

Constructor

ProvidersOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.
unregister	Unregisters a subscription from a resource provider.

get

Gets the specified resource provider.

get(resource_provider_namespace: str, expand: Optional[str] = None, **kwargs: Any) -> azure.mgmt.resource.resources.v2019_07_01.models._models_py3.Provider

Parameters

resource_provider_namespace

str

Required

The namespace of the resource provider.

expand

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

Provider, or the result of cls(response)

Return type

Provider

Exceptions

HttpResponseError

get_at_tenant_scope

Gets the specified resource provider at the tenant level.

get_at_tenant_scope(resource_provider_namespace: str, expand: Optional[str] = None, **kwargs: Any) -> azure.mgmt.resource.resources.v2019_07_01.models._models_py3.Provider

Parameters

resource_provider_namespace

str

Required

The namespace of the resource provider.

expand

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

Provider, or the result of cls(response)

Return type

Provider

Exceptions

HttpResponseError

list

Gets all resource providers for a subscription.

list(top: Optional[int] = None, expand: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.resource.resources.v2019_07_01.models._models_py3.ProviderListResult]

Parameters

top

int

Required

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

expand

str

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ProviderListResult]

Exceptions

HttpResponseError

list_at_tenant_scope

Gets all resource providers for the tenant.

list_at_tenant_scope(top: Optional[int] = None, expand: Optional[str] = None, **kwargs: Any) -> Iterable[azure.mgmt.resource.resources.v2019_07_01.models._models_py3.ProviderListResult]

Parameters

top

int

Required

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

expand

str

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.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ProviderListResult]

Exceptions

HttpResponseError

register

Registers a subscription with a resource provider.

register(resource_provider_namespace: str, **kwargs: Any) -> azure.mgmt.resource.resources.v2019_07_01.models._models_py3.Provider

Parameters

resource_provider_namespace

str

Required

The namespace of the resource provider to register.

cls

callable

A custom type or function that will be passed the direct response

Returns

Provider, or the result of cls(response)

Return type

Provider

Exceptions

HttpResponseError

unregister

Unregisters a subscription from a resource provider.

unregister(resource_provider_namespace: str, **kwargs: Any) -> azure.mgmt.resource.resources.v2019_07_01.models._models_py3.Provider

Parameters

resource_provider_namespace

str

Required

The namespace of the resource provider to unregister.

cls

callable

A custom type or function that will be passed the direct response

Returns

Provider, or the result of cls(response)

Return type

Provider

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.resource.resources.v2019_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2019_07_01\\models\\__init__.py'>