KeyValuesOperations Class

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.

Inheritance

builtins.object

KeyValuesOperations

Constructor

KeyValuesOperations(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_delete	Deletes a key-value.
create_or_update	Creates a key-value.
get	Gets the properties of the specified key-value.
list_by_configuration_store	Lists the key-values for a given configuration store.

begin_delete

Deletes a key-value.

begin_delete(resource_group_name: str, config_store_name: str, key_value_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[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.

key_value_name

str

Required

Identifier of key and label combination. Key and label are joined by $ character. Label is optional.

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

LROPoller[None]

Exceptions

HttpResponseError

create_or_update

Creates a key-value.

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

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.

key_value_name

str

Required

Identifier of key and label combination. Key and label are joined by $ character. Label is optional.

key_value_parameters

KeyValue

Required

The parameters for creating a key-value. Default value is None.

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

Exceptions

HttpResponseError

get

Gets the properties of the specified key-value.

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

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.

key_value_name

str

Required

Identifier of key and label combination. Key and label are joined by $ character. Label is optional.

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

Exceptions

HttpResponseError

list_by_configuration_store

Lists the key-values for a given configuration store.

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]

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 KeyValueListResult or the result of cls(response)

Return type

ItemPaged[KeyValueListResult]

Exceptions

HttpResponseError

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