ConfigurationStoresOperations Class

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

Constructor

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

Creates a configuration store with the specified parameters.

begin_delete

Deletes a configuration store.

begin_purge_deleted

Permanently deletes the specified configuration store.

begin_update

Updates a configuration store with the specified parameters.

get

Gets the properties of the specified configuration store.

get_deleted

Gets a deleted Azure app configuration store.

list

Lists the configuration stores for a given subscription.

list_by_resource_group

Lists the configuration stores for a given resource group.

list_deleted

Gets information about the deleted configuration stores in a subscription.

list_keys

Lists the access key for the specified configuration store.

regenerate_key

Regenerates an access key for the specified configuration store.

begin_create

Creates a configuration store with the specified parameters.

async begin_create(resource_group_name: str, config_store_name: str, config_store_creation_parameters: azure.mgmt.appconfiguration.models._models_py3.ConfigurationStore, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appconfiguration.models._models_py3.ConfigurationStore]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

config_store_name
str
Required

The name of the configuration store.

config_store_creation_parameters
ConfigurationStore
Required

The parameters for creating a configuration store.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in 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 AsyncLROPoller that returns either ConfigurationStore or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes a configuration store.

async begin_delete(resource_group_name: str, config_store_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

config_store_name
str
Required

The name of the configuration store.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_purge_deleted

Permanently deletes the specified configuration store.

async begin_purge_deleted(location: str, config_store_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

location
str
Required

The location in which uniqueness will be verified.

config_store_name
str
Required

The name of the configuration store.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_update

Updates a configuration store with the specified parameters.

async begin_update(resource_group_name: str, config_store_name: str, config_store_update_parameters: azure.mgmt.appconfiguration.models._models_py3.ConfigurationStoreUpdateParameters, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.appconfiguration.models._models_py3.ConfigurationStore]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

config_store_name
str
Required

The name of the configuration store.

config_store_update_parameters
ConfigurationStoreUpdateParameters
Required

The parameters for updating a configuration store.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in 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 AsyncLROPoller that returns either ConfigurationStore or the result of cls(response)

Return type

Exceptions

get

Gets the properties of the specified configuration store.

async get(resource_group_name: str, config_store_name: str, **kwargs: Any) -> azure.mgmt.appconfiguration.models._models_py3.ConfigurationStore

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

config_store_name
str
Required

The name of the configuration store.

cls
callable

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

Returns

ConfigurationStore, or the result of cls(response)

Return type

Exceptions

get_deleted

Gets a deleted Azure app configuration store.

async get_deleted(location: str, config_store_name: str, **kwargs: Any) -> azure.mgmt.appconfiguration.models._models_py3.DeletedConfigurationStore

Parameters

location
str
Required

The location in which uniqueness will be verified.

config_store_name
str
Required

The name of the configuration store.

cls
callable

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

Returns

DeletedConfigurationStore, or the result of cls(response)

Return type

Exceptions

list

Lists the configuration stores for a given subscription.

list(skip_token: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.appconfiguration.models._models_py3.ConfigurationStoreListResult]

Parameters

skip_token
str
Required

A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. 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 ConfigurationStoreListResult or the result of cls(response)

Return type

Exceptions

list_by_resource_group

Lists the configuration stores for a given resource group.

list_by_resource_group(resource_group_name: str, skip_token: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.appconfiguration.models._models_py3.ConfigurationStoreListResult]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

skip_token
str
Required

A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. 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 ConfigurationStoreListResult or the result of cls(response)

Return type

Exceptions

list_deleted

Gets information about the deleted configuration stores in a subscription.

list_deleted(**kwargs: Any) -> AsyncIterable[azure.mgmt.appconfiguration.models._models_py3.DeletedConfigurationStoreListResult]

Parameters

cls
callable

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

Returns

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

Return type

Exceptions

list_keys

Lists the access key for the specified configuration store.

list_keys(resource_group_name: str, config_store_name: str, skip_token: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.appconfiguration.models._models_py3.ApiKeyListResult]

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

config_store_name
str
Required

The name of the configuration store.

skip_token
str
Required

A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. 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 ApiKeyListResult or the result of cls(response)

Return type

Exceptions

regenerate_key

Regenerates an access key for the specified configuration store.

async regenerate_key(resource_group_name: str, config_store_name: str, regenerate_key_parameters: azure.mgmt.appconfiguration.models._models_py3.RegenerateKeyParameters, **kwargs: Any) -> azure.mgmt.appconfiguration.models._models_py3.ApiKey

Parameters

resource_group_name
str
Required

The name of the resource group to which the container registry belongs.

config_store_name
str
Required

The name of the configuration store.

regenerate_key_parameters
RegenerateKeyParameters
Required

The parameters for regenerating an access key.

cls
callable

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

Returns

ApiKey, or the result of cls(response)

Return type

Exceptions

Attributes

models

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