通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SecretsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

KeyVaultManagementClient's

secrets attribute.

Constructor

SecretsOperations(*args, **kwargs)

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: _models.SecretCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Secret

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
vault_name
Required
str

The name of the vault. Required.
secret_name
Required
str

The name of the secret. Required.
parameters
Required
SecretCreateOrUpdateParameters or <xref:JSON> or IO[bytes]

Parameters to create or update the secret. Is one of the following types: SecretCreateOrUpdateParameters, JSON, IO[bytes] Required.

Returns

Type Description
Secret

Secret. The Secret is compatible with MutableMapping

Exceptions

Type Description
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) -> Secret

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
vault_name
Required
str

The name of the vault. Required.
secret_name
Required
str

The name of the secret. Required.

Returns

Type Description
Secret

Secret. The Secret is compatible with MutableMapping

Exceptions

Type Description
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: int | None = None, **kwargs: Any) -> AsyncItemPaged[Secret]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
vault_name
Required
str

The name of the vault. Required.

Keyword-Only Parameters

Name Description
top
int

Maximum number of results to return. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[Secret]

An iterator like instance of Secret

Exceptions

Type Description
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: _models.SecretPatchParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Secret

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
vault_name
Required
str

The name of the vault. Required.
secret_name
Required
str

The name of the secret. Required.
parameters
Required
SecretPatchParameters or <xref:JSON> or IO[bytes]

Parameters to patch the secret. Is one of the following types: SecretPatchParameters, JSON, IO[bytes] Required.

Returns

Type Description
Secret

Secret. The Secret is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError