KeyVaultIdentifier Class

Creates a KeyVaultIdentifier based of the specified uri or keyword arguments :param uri: The uri of the key vault object identifier :param kwargs: The format parameters for the key vault object identifier. If uri is specified these are used to validate the components of the uri.

Inheritance
KeyVaultIdentifier

Constructor

KeyVaultIdentifier(uri=None, **kwargs)

Parameters

Name Description
uri
default value: None

Methods

create_certificate_id
create_certificate_issuer_id
create_certificate_operation_id
create_key_id
create_object_id
create_secret_id
parse_certificate_id
parse_certificate_issuer_id
parse_certificate_operation_id
parse_key_id
parse_object_id
parse_secret_id

create_certificate_id

static create_certificate_id(vault, name, version=None)

Parameters

Name Description
vault
Required
str

The vault uri.

name
Required
str

The certificate name.

version
str

The certificate version.

default value: None

Returns

Type Description

create_certificate_issuer_id

static create_certificate_issuer_id(vault, name)

Parameters

Name Description
vault
Required
str

The vault uri.

name
Required
str

The certificate name.

Returns

Type Description

create_certificate_operation_id

static create_certificate_operation_id(vault, name)

Parameters

Name Description
vault
Required
str

The vault uri.

name
Required
str

The certificate name.

Returns

Type Description

create_key_id

static create_key_id(vault, name, version=None)

Parameters

Name Description
vault
Required
str

The vault uri.

name
Required
str

The key name.

version
str

The key version.

default value: None

Returns

Type Description

create_object_id

static create_object_id(collection, vault, name, version)

Parameters

Name Description
collection
Required
str

The resource collection type.

vault
Required
str

The vault URI.

name
Required
str

The resource name.

version
Required
str

The resource version.

Returns

Type Description

create_secret_id

static create_secret_id(vault, name, version=None)

Parameters

Name Description
vault
Required
str

The vault uri.

name
Required
str

The secret name.

version
str

The secret version.

default value: None

Returns

Type Description

parse_certificate_id

static parse_certificate_id(id)

Parameters

Name Description
id
Required
str

The resource collection type.

Returns

Type Description

parse_certificate_issuer_id

static parse_certificate_issuer_id(id)

Parameters

Name Description
id
Required
str

The resource collection type.

Returns

Type Description

parse_certificate_operation_id

static parse_certificate_operation_id(id)

Parameters

Name Description
id
Required
str

The resource collection type.

Returns

Type Description

parse_key_id

static parse_key_id(id)

Parameters

Name Description
id
Required
str

The key uri.

Returns

Type Description

parse_object_id

static parse_object_id(collection, id)

Parameters

Name Description
collection
Required
str

The resource collection type.

id
Required
str

The resource uri.

Returns

Type Description

parse_secret_id

static parse_secret_id(id)

Parameters

Name Description
id
Required
str

The secret uri.

Returns

Type Description

Attributes

base_id

The version-less key vault object identifier uri,

id

The full key vault object identifier uri

version_none

version_none = ''