KeyvaultClient

Classes

KeyMetadataCollection dataclass

KeyMetadataCollection(value: Optional[List[KeyMetadata]] = None, continuation_token: Optional[str] = None)

Response for List keys

Attributes

value class-attribute instance-attribute

value: Optional[List[KeyMetadata]] = None

The keys

continuation_token class-attribute instance-attribute

continuation_token: Optional[str] = field(default=None, metadata={'wire_name': 'continuationToken'})

Continuation token

KeyMetadata dataclass

KeyMetadata(name: Optional[str] = None, version: Optional[str] = None, is_enabled: Optional[bool] = None, created_time: Optional[str] = None, last_updated_time: Optional[str] = None, validity_start_time: Optional[str] = None, validity_end_time: Optional[str] = None, allowed_operations: Optional[List[str]] = None, key_type: Optional[str] = None)

Response for Get key metadata

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of the key

version class-attribute instance-attribute

version: Optional[str] = None

Version of the key

is_enabled class-attribute instance-attribute

is_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'isEnabled'})

A flag indicating whether the key is enabled

created_time class-attribute instance-attribute

created_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdTime'})

Time when the key was created

last_updated_time class-attribute instance-attribute

last_updated_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastUpdatedTime'})

Time when the key was last updated

validity_start_time class-attribute instance-attribute

validity_start_time: Optional[str] = field(default=None, metadata={'wire_name': 'validityStartTime'})

Time when the key validity starts.

validity_end_time class-attribute instance-attribute

validity_end_time: Optional[str] = field(default=None, metadata={'wire_name': 'validityEndTime'})

Time when the key validity ends.

allowed_operations class-attribute instance-attribute

allowed_operations: Optional[List[str]] = field(default=None, metadata={'wire_name': 'allowedOperations'})

Operations allowed using the key

key_type class-attribute instance-attribute

key_type: Optional[str] = field(default=None, metadata={'wire_name': 'keyType'})

Type of the key

KeyEncryptOutput dataclass

KeyEncryptOutput(encrypted_data: Optional[str] = None)

Response for Encrypt data with key

Attributes

encrypted_data class-attribute instance-attribute

encrypted_data: Optional[str] = field(default=None, metadata={'wire_name': 'encryptedData'})

Encrypted data

KeyDecryptOutput dataclass

KeyDecryptOutput(raw_data: Optional[str] = None)

Response for Decrypt data with key

Attributes

raw_data class-attribute instance-attribute

raw_data: Optional[str] = field(default=None, metadata={'wire_name': 'rawData'})

Raw data

SecretMetadataCollection dataclass

SecretMetadataCollection(value: Optional[List[SecretMetadata]] = None, continuation_token: Optional[str] = None)

Response for List secrets

Attributes

value class-attribute instance-attribute

value: Optional[List[SecretMetadata]] = None

The secrets

continuation_token class-attribute instance-attribute

continuation_token: Optional[str] = field(default=None, metadata={'wire_name': 'continuationToken'})

Continuation token

SecretMetadata dataclass

SecretMetadata(name: Optional[str] = None, version: Optional[str] = None, content_type: Optional[str] = None, is_enabled: Optional[bool] = None, created_time: Optional[str] = None, last_updated_time: Optional[str] = None, validity_start_time: Optional[str] = None, validity_end_time: Optional[str] = None)

Response for Get secret metadata

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of the secret

version class-attribute instance-attribute

version: Optional[str] = None

Version of the secret

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

Content type of the secret

is_enabled class-attribute instance-attribute

is_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'isEnabled'})

A flag indicating whether the secret is enabled

created_time class-attribute instance-attribute

created_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdTime'})

Time when the secret was created

last_updated_time class-attribute instance-attribute

last_updated_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastUpdatedTime'})

Time when the secret was last updated

validity_start_time class-attribute instance-attribute

validity_start_time: Optional[str] = field(default=None, metadata={'wire_name': 'validityStartTime'})

Time when the secret validity starts.

validity_end_time class-attribute instance-attribute

validity_end_time: Optional[str] = field(default=None, metadata={'wire_name': 'validityEndTime'})

Time when the secret validity ends.

Secret dataclass

Secret(value: Optional[str] = None, name: Optional[str] = None, version: Optional[str] = None, content_type: Optional[str] = None, is_enabled: Optional[bool] = None, created_time: Optional[str] = None, last_updated_time: Optional[str] = None, validity_start_time: Optional[str] = None, validity_end_time: Optional[str] = None)

Response for Get secret

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Value of the secret

name class-attribute instance-attribute

name: Optional[str] = None

Name of the secret

version class-attribute instance-attribute

version: Optional[str] = None

Version of the secret

content_type class-attribute instance-attribute

content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

Content type of the secret

is_enabled class-attribute instance-attribute

is_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'isEnabled'})

A flag indicating whether the secret is enabled

created_time class-attribute instance-attribute

created_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdTime'})

Time when the secret was created

last_updated_time class-attribute instance-attribute

last_updated_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastUpdatedTime'})

Time when the secret was last updated

validity_start_time class-attribute instance-attribute

validity_start_time: Optional[str] = field(default=None, metadata={'wire_name': 'validityStartTime'})

Time when the secret validity starts.

validity_end_time class-attribute instance-attribute

validity_end_time: Optional[str] = field(default=None, metadata={'wire_name': 'validityEndTime'})

Time when the secret validity ends.

KeyEncryptInput dataclass

KeyEncryptInput(algorithm: Optional[str] = None, raw_data: Optional[str] = None)

Definition: KeyEncryptInput

Attributes

algorithm class-attribute instance-attribute

algorithm: Optional[str] = None

Algorithm to use for encrypting the data

raw_data class-attribute instance-attribute

raw_data: Optional[str] = field(default=None, metadata={'wire_name': 'rawData'})

Data to encrypt

KeyDecryptInput dataclass

KeyDecryptInput(algorithm: Optional[str] = None, encrypted_data: Optional[str] = None)

Definition: KeyDecryptInput

Attributes

algorithm class-attribute instance-attribute

algorithm: Optional[str] = None

Algorithm to use for decrypting the data

encrypted_data class-attribute instance-attribute

encrypted_data: Optional[str] = field(default=None, metadata={'wire_name': 'encryptedData'})

Data to decrypt

KeyvaultClient

KeyvaultClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for keyvault connector.

Initialize a KeyvaultClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

list_keys_async async

list_keys_async() -> dict[str, Any] | None

List keys

List keys.

list_key_versions_async async

list_key_versions_async(key_name: str) -> dict[str, Any] | None

List key versions

List versions of a key.

get_key_metadata_async async

get_key_metadata_async(key_name: str) -> dict[str, Any] | None

Get key metadata

Gets metadata of a key.

get_key_version_metadata_async async

get_key_version_metadata_async(key_name: str, key_version: str) -> dict[str, Any] | None

Get key version metadata

Gets metadata of a version of a key.

encrypt_data_async async

encrypt_data_async(input: KeyEncryptInput, key_name: str) -> dict[str, Any] | None

Encrypt data with key

Encrypt data using the latest version of a key.

encrypt_data_with_version_async async

encrypt_data_with_version_async(input: KeyEncryptInput, key_name: str, key_version: str) -> dict[str, Any] | None

Encrypt data with key version

Encrypt data using a specific version of a key.

decrypt_data_async async

decrypt_data_async(input: KeyDecryptInput, key_name: str) -> dict[str, Any] | None

Decrypt data with key

Decrypt data using the latest version of a key. Output of this operation is typically classified as secret and can be visible in the run history.

decrypt_data_with_version_async async

decrypt_data_with_version_async(input: KeyDecryptInput, key_name: str, key_version: str) -> dict[str, Any] | None

Decrypt data with key version

Decrypt data using a specific version of a key. Output of this operation is typically classified as secret and can be visible in the run history.

list_secrets_async async

list_secrets_async() -> dict[str, Any] | None

List secrets

List secrets.

list_secret_versions_async async

list_secret_versions_async(secret_name: str) -> dict[str, Any] | None

List secret versions

List versions of a secret.

get_secret_metadata_async async

get_secret_metadata_async(secret_name: str) -> dict[str, Any] | None

Get secret metadata

Gets metadata of a secret.

get_secret_version_metadata_async async

get_secret_version_metadata_async(secret_name: str, secret_version: str) -> dict[str, Any] | None

Get secret version metadata

Gets metadata of a version of a secret.

get_secret_async async

get_secret_async(secret_name: str) -> dict[str, Any] | None

Get secret

Gets a secret. Output of this operation is typically classified as secret and can be visible in the run history.

get_secret_version_async async

get_secret_version_async(secret_name: str, secret_version: str) -> dict[str, Any] | None

Get secret version

Gets a version of a secret. Output of this operation is typically classified as secret and can be visible in the run history.