keyvault Package

  • Reference

Packages

http_bearer_challenge_cache
v2016_10_01
v7_0

Modules

http_bearer_challenge
http_challenge
http_message_security
key_vault_authentication
key_vault_client
key_vault_id
models
version

Classes

AccessToken

Create new instance of AccessToken(scheme, token, key)
CertificateId

Creates a key vault certificate id. If uri is specified the id properties are parsed from the uri, otherwise builds the id from the specified vault, name and version. :param uri: The uri of the key vault certificate :param vault: The vault uri :param name: The certificate name :param version: The certificate version
CertificateIssuerId

Creates a key vault certificate issuer id. If uri is specified the id properties are parsed from the uri, otherwise builds the id from the specified vault and name. :param uri: The uri of the key vault certificate issuer :param vault: The vault uri :param name: The certificate issuer name
CertificateOperationId

Creates a key vault certificate operation id. If uri is specified the id properties are parsed from the uri, otherwise builds the id from the specified vault and name. :param uri: The uri of the key vault certificate operation :param vault: The vault uri :param name: The certificate name
HttpBearerChallenge

Parses an HTTP WWW-Authentication Bearer challenge from a server.
HttpChallenge

Parses an HTTP WWW-Authentication Bearer challenge from a server.
KeyId

Creates a key vault key id. If uri is specified the id properties are parsed from the uri, otherwise builds the id from the specified vault, name and version. :param uri: The uri of the key vault key :param vault: The vault uri :param name: The key name :param version: The key version
KeyVaultAuthBase

Used for handling authentication challenges, by hooking into the request AuthBase extension model.

Creates a new KeyVaultAuthBase instance used for handling authentication challenges, by hooking into the request AuthBase extension model. :param authorization_callback: A callback used to provide authentication credentials to the key vault data service. This callback should take four str arguments: authorization uri, resource, scope, and scheme, and return an AccessToken

return AccessToken(scheme=token['token_type'], token=token['access_token'])

Note: for backward compatibility a tuple of the scheme and token can also be returned. return token['token_type'], token['access_token']
KeyVaultAuthentication

Authentication class to be used as credentials for the KeyVaultClient. :Example Usage:

def auth_callack(server, resource, scope): self.data_creds = self.data_creds or ServicePrincipalCredentials(client_id=self.config.client_id, secret=self.config.client_secret, tenant=self.config.tenant_id, resource=resource)

  token = self.data_creds.token
  return token['token_type'], token['access_token']

self.keyvault_data_client = KeyVaultClient(KeyVaultAuthentication(auth_callack))

Creates a new KeyVaultAuthentication instance used for authentication in the KeyVaultClient :param authorization_callback: A callback used to provide authentication credentials to the key vault data service. This callback should take three str arguments: authorization uri, resource, and scope, and return a tuple of (token type, access token). :param credentials:: Credentials needed for the client to connect to Azure. :type credentials: :mod:>>`<<A msrestazure Credentials

object<msrestazure.azure_active_directory>`
KeyVaultClient

The key vault client performs cryptographic key operations and vault operations against the Key Vault service. Implementation depends on the API version:

  • 2016-10-01: KeyVaultClient

  • 7.0: <xref:azure.mgmt.keyvault.v7_0.KeyVaultClient>
KeyVaultId

An identifier for an Azure Key Vault resource.
SecretId

Creates a key vault secret id. If uri is specified the id properties are parsed from the uri, otherwise builds the id from the specified vault, name and version. :param uri: The uri of the key vault secret :param vault: The vault uri :param name: The secret name :param version: The secret version
StorageAccountId

Creates a key vault storage account id. If uri is specified the id properties are parsed from the uri, otherwise builds the id from the specified vault and name. :param uri: The uri of the key vault storage account :param vault: The vault uri :param name: The storage account name
StorageSasDefinitionId

Creates a key vault storage account sas definition id. If uri is specified the id properties are parsed from the uri, otherwise builds the id from the specified vault, account_name, and sas_definition. :param uri: The uri of the key vault storage account sas definition :param vault: The vault uri :param account_name: The storage account name :param sas_definition: The sas definition name

Functions

generate_pop_key

Generates a key which can be used for Proof Of Possession token authentication. :return:

generate_pop_key()