azure.keyvault package

Module contents

azure.keyvault.KeyVaultClient

alias of CustomKeyVaultClient

class azure.keyvault.KeyVaultId(collection, vault, name, version)[source]

Bases: object

An identifier for an Azure Key Vault resource.

Parameters:
  • collection (str) – The resource collection type.
  • vault (str) – The vault URI.
  • name (str) – The resource name.
  • version (str) – The resource version.
base_id
static create_certificate_id(vault, name, version=None)[source]
Parameters:
  • vault (str) – The vault uri.
  • name (str) – The certificate name.
  • version (str) – The certificate version.
Return type:

KeyVaultId
static create_certificate_issuer_id(vault, name)[source]
Parameters:
  • vault (str) – The vault uri.
  • name (str) – The certificate name.
Return type:

KeyVaultId
static create_certificate_operation_id(vault, name)[source]
Parameters:
  • vault (str) – The vault uri.
  • name (str) – The certificate name.
Return type:

KeyVaultId
static create_key_id(vault, name, version=None)[source]
Parameters:
  • vault (str) – The vault uri.
  • name (str) – The key name.
  • version (str) – The key version.
Return type:

KeyVaultId
static create_object_id(collection, vault, name, version)[source]
Parameters:
  • collection (str) – The resource collection type.
  • vault (str) – The vault URI.
  • name (str) – The resource name.
  • version (str) – The resource version.
Return type:

KeyVaultId
static create_secret_id(vault, name, version=None)[source]
Parameters:
  • vault (str) – The vault uri.
  • name (str) – The secret name.
  • version (str) – The secret version.
Return type:

KeyVaultId
id
static parse_certificate_id(id)[source]
Parameters:id (str) – The resource collection type.
Return type:KeyVaultId
static parse_certificate_issuer_id(id)[source]
Parameters:id (str) – The resource collection type.
Return type:KeyVaultId
static parse_certificate_operation_id(id)[source]
Parameters:id (str) – The resource collection type.
Return type:KeyVaultId
static parse_key_id(id)[source]
Parameters:id (str) – The key uri.
Return type:KeyVaultId
static parse_object_id(collection, id)[source]
Parameters:
  • collection (str) – The resource collection type.
  • id (str) – The resource uri.
Return type:

KeyVaultId
static parse_secret_id(id)[source]
Parameters:id (str) – The secret uri.
Return type:KeyVaultId
version_none = ''
class azure.keyvault.HttpBearerChallenge(request_uri, challenge)[source]

Bases: object

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

get_authorization_server()[source]

Returns the URI for the authorization server if present, otherwise empty string.

get_resource()[source]

Returns the resource if present, otherwise empty string.

get_scope()[source]

Returns the scope if present, otherwise empty string.

get_value(key)[source]
static is_bearer_challenge(authentication_header)[source]

Tests whether an authentication header is a Bearer challenge. :param authentication_header: the authentication header to test rtype: bool

class azure.keyvault.KeyVaultAuthentication(authorization_callback)[source]

Bases: msrest.authentication.Authentication

signed_session()[source]
class azure.keyvault.KeyVaultAuthBase(authorization_callback)[source]

Bases: requests.auth.AuthBase

set_authorization_header(request, challenge)[source]