azure.mgmt.keyvault.models module

class azure.mgmt.keyvault.models.Sku(name)[source]

Bases: msrest.serialization.Model

SKU details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:family (str) – SKU family name. Default value: “A” .
Parameters:name (str or SkuName) – SKU name to specify whether the key vault is a standard vault or a premium vault. Possible values include: ‘standard’, ‘premium’
family = 'A'
class azure.mgmt.keyvault.models.Permissions(keys=None, secrets=None, certificates=None, storage=None)[source]

Bases: msrest.serialization.Model

Permissions the identity has for keys, secrets, certificates and storage.

Parameters:
class azure.mgmt.keyvault.models.AccessPolicyEntry(tenant_id, object_id, permissions, application_id=None)[source]

Bases: msrest.serialization.Model

An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault’s tenant ID.

Parameters:
  • tenant_id (str) – The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
  • object_id (str) – The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.
  • application_id (str) – Application ID of the client making request on behalf of a principal
  • permissions (Permissions) – Permissions the identity has for keys, secrets and certificates.
class azure.mgmt.keyvault.models.VaultProperties(tenant_id, sku, access_policies=None, vault_uri=None, enabled_for_deployment=None, enabled_for_disk_encryption=None, enabled_for_template_deployment=None, enable_soft_delete=None, create_mode=None)[source]

Bases: msrest.serialization.Model

Properties of the vault.

Parameters:
  • tenant_id (str) – The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
  • sku (Sku) – SKU details
  • access_policies (list of AccessPolicyEntry) – An array of 0 to 16 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault’s tenant ID.
  • vault_uri (str) – The URI of the vault for performing operations on keys and secrets.
  • enabled_for_deployment (bool) – Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
  • enabled_for_disk_encryption (bool) – Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
  • enabled_for_template_deployment (bool) – Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
  • enable_soft_delete (bool) – Property to specify whether the ‘soft delete’ functionality is enabled for this key vault. It does not accept false value.
  • create_mode (str or CreateMode) – The vault’s create mode to indicate whether the vault need to be recovered or not. Possible values include: ‘recover’, ‘default’
class azure.mgmt.keyvault.models.DeletedVaultProperties[source]

Bases: msrest.serialization.Model

Properties of the deleted vault.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • vault_id (str) – The resource id of the original vault.
  • location (str) – The location of the original vault.
  • deletion_date (datetime) – The deleted date.
  • scheduled_purge_date (datetime) – The scheduled purged date.
  • tags (dict) – Tags of the original vault.
class azure.mgmt.keyvault.models.VaultCreateOrUpdateParameters(location, properties, tags=None)[source]

Bases: msrest.serialization.Model

Parameters for creating or updating a vault.

Parameters:
  • location (str) – The supported Azure location where the key vault should be created.
  • tags (dict) – The tags that will be assigned to the key vault.
  • properties (VaultProperties) – Properties of the vault
class azure.mgmt.keyvault.models.Vault(name, location, properties, tags=None)[source]

Bases: azure.mgmt.keyvault.models.resource.Resource

Resource information with extended details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – The Azure Resource Manager resource ID for the key vault.
  • type (str) – The resource type of the key vault.
Parameters:
  • name (str) – The name of the key vault.
  • location (str) – The supported Azure location where the key vault should be created.
  • tags (dict) – The tags that will be assigned to the key vault.
  • properties (VaultProperties) – Properties of the vault
class azure.mgmt.keyvault.models.DeletedVault(properties=None)[source]

Bases: msrest.serialization.Model

Deleted vault information with extended details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – The resource ID for the deleted key vault.
  • name (str) – The name of the key vault.
  • type (str) – The resource type of the key vault.
Parameters:

properties (DeletedVaultProperties) – Properties of the vault

class azure.mgmt.keyvault.models.Resource(name, location, tags=None)[source]

Bases: msrest.serialization.Model

Key Vault resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – The Azure Resource Manager resource ID for the key vault.
  • type (str) – The resource type of the key vault.
Parameters:
  • name (str) – The name of the key vault.
  • location (str) – The supported Azure location where the key vault should be created.
  • tags (dict) – The tags that will be assigned to the key vault.
class azure.mgmt.keyvault.models.VaultPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Vault object

class azure.mgmt.keyvault.models.DeletedVaultPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DeletedVault object

class azure.mgmt.keyvault.models.ResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Resource object

class azure.mgmt.keyvault.models.SkuName[source]

Bases: enum.Enum

premium = 'premium'
standard = 'standard'
class azure.mgmt.keyvault.models.KeyPermissions[source]

Bases: enum.Enum

backup = 'backup'
create = 'create'
decrypt = 'decrypt'
delete = 'delete'
encrypt = 'encrypt'
get = 'get'
import_enum = 'import'
list = 'list'
purge = 'purge'
recover = 'recover'
restore = 'restore'
sign = 'sign'
unwrap_key = 'unwrapKey'
update = 'update'
verify = 'verify'
wrap_key = 'wrapKey'
class azure.mgmt.keyvault.models.SecretPermissions[source]

Bases: enum.Enum

backup = 'backup'
delete = 'delete'
get = 'get'
list = 'list'
purge = 'purge'
recover = 'recover'
restore = 'restore'
set = 'set'
class azure.mgmt.keyvault.models.CertificatePermissions[source]

Bases: enum.Enum

create = 'create'
delete = 'delete'
deleteissuers = 'deleteissuers'
get = 'get'
getissuers = 'getissuers'
import_enum = 'import'
list = 'list'
listissuers = 'listissuers'
managecontacts = 'managecontacts'
manageissuers = 'manageissuers'
purge = 'purge'
recover = 'recover'
setissuers = 'setissuers'
update = 'update'
class azure.mgmt.keyvault.models.StoragePermissions[source]

Bases: enum.Enum

delete = 'delete'
deletesas = 'deletesas'
get = 'get'
getsas = 'getsas'
list = 'list'
listsas = 'listsas'
regeneratekey = 'regeneratekey'
set = 'set'
setsas = 'setsas'
update = 'update'
class azure.mgmt.keyvault.models.CreateMode[source]

Bases: enum.Enum

default = 'default'
recover = 'recover'