azure.mgmt.appconfiguration.operations module¶
-
class
azure.mgmt.appconfiguration.operations.
ConfigurationStoresOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ConfigurationStoresOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
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._poller.LROPoller[azure.mgmt.appconfiguration.models._models_py3.ConfigurationStore][source]¶ Creates a configuration store with the specified parameters.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. 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 LROPoller that returns either ConfigurationStore or the result of cls(response)
- Return type
LROPoller[ConfigurationStore]
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, config_store_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a configuration store.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. 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 LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_purge_deleted
(location: str, config_store_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Permanently deletes the specified configuration store.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. 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 LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
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._poller.LROPoller[azure.mgmt.appconfiguration.models._models_py3.ConfigurationStore][source]¶ Updates a configuration store with the specified parameters.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. 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 LROPoller that returns either ConfigurationStore or the result of cls(response)
- Return type
LROPoller[ConfigurationStore]
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, config_store_name: str, **kwargs: Any) → azure.mgmt.appconfiguration.models._models_py3.ConfigurationStore[source]¶ Gets the properties of the specified configuration store.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ConfigurationStore, or the result of cls(response)
- Return type
ConfigurationStore
- Raises
~azure.core.exceptions.HttpResponseError
-
get_deleted
(location: str, config_store_name: str, **kwargs: Any) → azure.mgmt.appconfiguration.models._models_py3.DeletedConfigurationStore[source]¶ Gets a deleted Azure app configuration store.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DeletedConfigurationStore, or the result of cls(response)
- Return type
DeletedConfigurationStore
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.appconfiguration.models._models_py3.ConfigurationStoreListResult][source]¶ Lists the configuration stores for a given subscription.
- Parameters
skip_token (str) – 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.
- Keyword Arguments
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
ItemPaged[ConfigurationStoreListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_resource_group
(resource_group_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.appconfiguration.models._models_py3.ConfigurationStoreListResult][source]¶ Lists the configuration stores for a given resource group.
- Parameters
resource_group_name (str) – The name of the resource group to which the container registry belongs.
skip_token (str) – 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.
- Keyword Arguments
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
ItemPaged[ConfigurationStoreListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
list_deleted
(**kwargs: Any) → Iterable[azure.mgmt.appconfiguration.models._models_py3.DeletedConfigurationStoreListResult][source]¶ Gets information about the deleted configuration stores in a subscription.
- Keyword Arguments
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
ItemPaged[DeletedConfigurationStoreListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
list_keys
(resource_group_name: str, config_store_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.appconfiguration.models._models_py3.ApiKeyListResult][source]¶ Lists the access key for the specified configuration store.
- Parameters
resource_group_name (str) – The name of the resource group to which the container registry belongs.
config_store_name (str) – The name of the configuration store.
skip_token (str) – 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.
- Keyword Arguments
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
ItemPaged[ApiKeyListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
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[source]¶ Regenerates an access key for the specified configuration store.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ApiKey, or the result of cls(response)
- Return type
ApiKey
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.appconfiguration.models' from '/mnt/vss/_work/1/s/sdk/appconfiguration/azure-mgmt-appconfiguration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/appconfiguration/models/__init__.py'>¶
-
class
azure.mgmt.appconfiguration.operations.
KeyValuesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
KeyValuesOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_delete
(resource_group_name: str, config_store_name: str, key_value_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a key-value.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. 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 LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
create_or_update
(resource_group_name: str, config_store_name: str, key_value_name: str, key_value_parameters: Optional[azure.mgmt.appconfiguration.models._models_py3.KeyValue] = None, **kwargs: Any) → azure.mgmt.appconfiguration.models._models_py3.KeyValue[source]¶ Creates a key-value.
- Parameters
resource_group_name (str) – The name of the resource group to which the container registry belongs.
config_store_name (str) – The name of the configuration store.
key_value_name (str) – Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
key_value_parameters (KeyValue) – The parameters for creating a key-value.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
KeyValue, or the result of cls(response)
- Return type
KeyValue
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, config_store_name: str, key_value_name: str, **kwargs: Any) → azure.mgmt.appconfiguration.models._models_py3.KeyValue[source]¶ Gets the properties of the specified key-value.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
KeyValue, or the result of cls(response)
- Return type
KeyValue
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_configuration_store
(resource_group_name: str, config_store_name: str, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.appconfiguration.models._models_py3.KeyValueListResult][source]¶ Lists the key-values for a given configuration store.
- Parameters
resource_group_name (str) – The name of the resource group to which the container registry belongs.
config_store_name (str) – The name of the configuration store.
skip_token (str) – 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.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either KeyValueListResult or the result of cls(response)
- Return type
ItemPaged[KeyValueListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.appconfiguration.models' from '/mnt/vss/_work/1/s/sdk/appconfiguration/azure-mgmt-appconfiguration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/appconfiguration/models/__init__.py'>¶
-
class
azure.mgmt.appconfiguration.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
check_name_availability
(check_name_availability_parameters: azure.mgmt.appconfiguration.models._models_py3.CheckNameAvailabilityParameters, **kwargs: Any) → azure.mgmt.appconfiguration.models._models_py3.NameAvailabilityStatus[source]¶ Checks whether the configuration store name is available for use.
- Parameters
check_name_availability_parameters (CheckNameAvailabilityParameters) – The object containing information for the availability request.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NameAvailabilityStatus, or the result of cls(response)
- Return type
NameAvailabilityStatus
- Raises
~azure.core.exceptions.HttpResponseError
-
list
(skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.appconfiguration.models._models_py3.OperationDefinitionListResult][source]¶ Lists the operations available from this provider.
- Parameters
skip_token (str) – 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.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either OperationDefinitionListResult or the result of cls(response)
- Return type
ItemPaged[OperationDefinitionListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
regional_check_name_availability
(location: str, check_name_availability_parameters: azure.mgmt.appconfiguration.models._models_py3.CheckNameAvailabilityParameters, **kwargs: Any) → azure.mgmt.appconfiguration.models._models_py3.NameAvailabilityStatus[source]¶ Checks whether the configuration store name is available for use.
- Parameters
location (str) – The location in which uniqueness will be verified.
check_name_availability_parameters (CheckNameAvailabilityParameters) – The object containing information for the availability request.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
NameAvailabilityStatus, or the result of cls(response)
- Return type
NameAvailabilityStatus
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.appconfiguration.models' from '/mnt/vss/_work/1/s/sdk/appconfiguration/azure-mgmt-appconfiguration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/appconfiguration/models/__init__.py'>¶
-
class
azure.mgmt.appconfiguration.operations.
PrivateEndpointConnectionsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PrivateEndpointConnectionsOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
begin_create_or_update
(resource_group_name: str, config_store_name: str, private_endpoint_connection_name: str, private_endpoint_connection: azure.mgmt.appconfiguration.models._models_py3.PrivateEndpointConnection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.appconfiguration.models._models_py3.PrivateEndpointConnection][source]¶ Update the state of the specified private endpoint connection associated with the configuration store.
- Parameters
resource_group_name (str) – The name of the resource group to which the container registry belongs.
config_store_name (str) – The name of the configuration store.
private_endpoint_connection_name (str) – Private endpoint connection name.
private_endpoint_connection (PrivateEndpointConnection) – The private endpoint connection properties.
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. 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 LROPoller that returns either PrivateEndpointConnection or the result of cls(response)
- Return type
LROPoller[PrivateEndpointConnection]
- Raises
~azure.core.exceptions.HttpResponseError
-
begin_delete
(resource_group_name: str, config_store_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a private endpoint connection.
- Parameters
- Keyword Arguments
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) – By default, your polling method will be ARMPolling. 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 LROPoller that returns either None or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
get
(resource_group_name: str, config_store_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.appconfiguration.models._models_py3.PrivateEndpointConnection[source]¶ Gets the specified private endpoint connection associated with the configuration store.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnection, or the result of cls(response)
- Return type
PrivateEndpointConnection
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_configuration_store
(resource_group_name: str, config_store_name: str, **kwargs: Any) → Iterable[azure.mgmt.appconfiguration.models._models_py3.PrivateEndpointConnectionListResult][source]¶ Lists all private endpoint connections for a configuration store.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)
- Return type
ItemPaged[PrivateEndpointConnectionListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.appconfiguration.models' from '/mnt/vss/_work/1/s/sdk/appconfiguration/azure-mgmt-appconfiguration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/appconfiguration/models/__init__.py'>¶
-
class
azure.mgmt.appconfiguration.operations.
PrivateLinkResourcesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PrivateLinkResourcesOperations 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.
- Variables
models – Alias to model classes used in this operation group.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
-
get
(resource_group_name: str, config_store_name: str, group_name: str, **kwargs: Any) → azure.mgmt.appconfiguration.models._models_py3.PrivateLinkResource[source]¶ Gets a private link resource that need to be created for a configuration store.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateLinkResource, or the result of cls(response)
- Return type
PrivateLinkResource
- Raises
~azure.core.exceptions.HttpResponseError
-
list_by_configuration_store
(resource_group_name: str, config_store_name: str, **kwargs: Any) → Iterable[azure.mgmt.appconfiguration.models._models_py3.PrivateLinkResourceListResult][source]¶ Gets the private link resources that need to be created for a configuration store.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PrivateLinkResourceListResult or the result of cls(response)
- Return type
ItemPaged[PrivateLinkResourceListResult]
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.mgmt.appconfiguration.models' from '/mnt/vss/_work/1/s/sdk/appconfiguration/azure-mgmt-appconfiguration/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/appconfiguration/models/__init__.py'>¶