SecretsOperations Class

SecretsOperations 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

SecretsOperations

Constructor

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

create_or_update	Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
get	Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
list	The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
update	Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

create_or_update

Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

async create_or_update(resource_group_name: str, vault_name: str, secret_name: str, parameters: azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.SecretCreateOrUpdateParameters, **kwargs: Any) -> azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.Secret

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the vault belongs.

vault_name

str

Required

Name of the vault.

secret_name

str

Required

Name of the secret.

parameters

SecretCreateOrUpdateParameters

Required

Parameters to create or update the secret.

cls

callable

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

Returns

Secret, or the result of cls(response)

Return type

Secret

Exceptions

HttpResponseError

get

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

async get(resource_group_name: str, vault_name: str, secret_name: str, **kwargs: Any) -> azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.Secret

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the vault belongs.

vault_name

str

Required

The name of the vault.

secret_name

str

Required

The name of the secret.

cls

callable

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

Returns

Secret, or the result of cls(response)

Return type

Secret

Exceptions

HttpResponseError

list

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

list(resource_group_name: str, vault_name: str, top: Optional[int] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.SecretListResult]

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the vault belongs.

vault_name

str

Required

The name of the vault.

top

int

Required

Maximum number of results to return. 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 SecretListResult or the result of cls(response)

Return type

AsyncItemPaged[SecretListResult]

Exceptions

HttpResponseError

update

Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

async update(resource_group_name: str, vault_name: str, secret_name: str, parameters: azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.SecretPatchParameters, **kwargs: Any) -> azure.mgmt.keyvault.v2021_06_01_preview.models._models_py3.Secret

Parameters

resource_group_name

str

Required

The name of the Resource Group to which the vault belongs.

vault_name

str

Required

Name of the vault.

secret_name

str

Required

Name of the secret.

parameters

SecretPatchParameters

Required

Parameters to patch the secret.

cls

callable

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

Returns

Secret, or the result of cls(response)

Return type

Secret

Exceptions

HttpResponseError

Attributes

models

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