CustomResourceProviderOperations Class

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

Constructor

CustomResourceProviderOperations(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

begin_create_or_update

Creates or updates the custom resource provider.

begin_delete

Deletes the custom resource provider.

get

Gets the custom resource provider manifest.

list_by_resource_group

Gets all the custom resource providers within a resource group.

list_by_subscription

Gets all the custom resource providers within a subscription.

update

Updates an existing custom resource provider. The only value that can be updated via PATCH currently is the tags.

begin_create_or_update

Creates or updates the custom resource provider.

begin_create_or_update(resource_group_name: str, resource_provider_name: str, resource_provider: _models.CustomRPManifest, **kwargs: Any) -> LROPoller[_models.CustomRPManifest]

Parameters

resource_group_name
str
Required

The name of the resource group.

resource_provider_name
str
Required

The name of the resource provider.

resource_provider
CustomRPManifest
Required

The parameters required to create or update a custom resource provider definition.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either CustomRPManifest or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes the custom resource provider.

begin_delete(resource_group_name: str, resource_provider_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

resource_provider_name
str
Required

The name of the resource provider.

cls
callable

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

continuation_token
str

A continuation token to restart a poller from a saved state.

polling
bool or PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

get

Gets the custom resource provider manifest.

get(resource_group_name: str, resource_provider_name: str, **kwargs: Any) -> _models.CustomRPManifest

Parameters

resource_group_name
str
Required

The name of the resource group.

resource_provider_name
str
Required

The name of the resource provider.

cls
callable

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

Returns

CustomRPManifest, or the result of cls(response)

Return type

Exceptions

list_by_resource_group

Gets all the custom resource providers within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[_models.ListByCustomRPManifest]

Parameters

resource_group_name
str
Required

The name of the resource group.

cls
callable

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

Returns

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

Return type

Exceptions

list_by_subscription

Gets all the custom resource providers within a subscription.

list_by_subscription(**kwargs: Any) -> Iterable[_models.ListByCustomRPManifest]

Parameters

cls
callable

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

Returns

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

Return type

Exceptions

update

Updates an existing custom resource provider. The only value that can be updated via PATCH currently is the tags.

update(resource_group_name: str, resource_provider_name: str, patchable_resource: _models.ResourceProvidersUpdate, **kwargs: Any) -> _models.CustomRPManifest

Parameters

resource_group_name
str
Required

The name of the resource group.

resource_provider_name
str
Required

The name of the resource provider.

patchable_resource
ResourceProvidersUpdate
Required

The updatable fields of a custom resource provider.

cls
callable

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

Returns

CustomRPManifest, or the result of cls(response)

Return type

Exceptions

Attributes

models

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