models Package

Classes

AccessPolicyEntry

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.

All required parameters must be populated in order to send to server.

Action

Action.

Attributes

The object attributes managed by the KeyVault service.

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

CheckMhsmNameAvailabilityParameters

The parameters used to check the availability of the managed hsm name.

All required parameters must be populated in order to send to server.

CheckMhsmNameAvailabilityResult

The CheckMhsmNameAvailability operation response.

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

CheckNameAvailabilityResult

The CheckNameAvailability operation response.

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

CloudErrorBody

An error response from Key Vault resource provider.

DeletedManagedHsm

DeletedManagedHsm.

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

DeletedManagedHsmListResult

List of deleted managed HSM Pools.

DeletedManagedHsmProperties

Properties of the deleted managed HSM.

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

DeletedVault

Deleted vault information with extended details.

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

DeletedVaultListResult

List of vaults.

DeletedVaultProperties

Properties of the deleted vault.

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

DimensionProperties

Type of operation: get, read, delete, etc.

Error

The server error.

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

IPRule

A rule governing the accessibility of a vault from a specific ip address or ip range.

All required parameters must be populated in order to send to server.

Key

The key resource.

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

KeyAttributes

The object attributes managed by the Azure Key Vault service.

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

KeyCreateParameters

The parameters used to create a key.

All required parameters must be populated in order to send to server.

KeyListResult

The page of keys.

KeyProperties

The properties of the key.

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

KeyReleasePolicy

KeyReleasePolicy.

KeyRotationPolicyAttributes

KeyRotationPolicyAttributes.

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

LifetimeAction

LifetimeAction.

LogSpecification

Log specification of operation.

MHSMGeoReplicatedRegion

A region that this managed HSM Pool has been extended to.

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

MHSMIPRule

A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range.

All required parameters must be populated in order to send to server.

MHSMNetworkRuleSet

A set of rules governing the network accessibility of a managed hsm pool.

MHSMPrivateEndpoint

Private endpoint object properties.

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

MHSMPrivateEndpointConnection

Private endpoint connection resource.

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

MHSMPrivateEndpointConnectionItem

Private endpoint connection item.

MHSMPrivateEndpointConnectionsListResult

List of private endpoint connections associated with a managed HSM Pools.

MHSMPrivateLinkResource

A private link resource.

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

MHSMPrivateLinkResourceListResult

A list of private link resources.

MHSMPrivateLinkServiceConnectionState

An object that represents the approval state of the private link connection.

MHSMRegionsListResult

List of regions associated with a managed HSM Pools.

MHSMVirtualNetworkRule

A rule governing the accessibility of a managed hsm pool from a specific virtual network.

All required parameters must be populated in order to send to server.

ManagedHSMSecurityDomainProperties

The security domain properties of the managed hsm.

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

ManagedHsm

Resource information with extended details.

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

ManagedHsmAction

ManagedHsmAction.

ManagedHsmError

The error exception.

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

ManagedHsmKey

The key resource.

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

ManagedHsmKeyAttributes

The object attributes managed by the Azure Key Vault service.

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

ManagedHsmKeyCreateParameters

The parameters used to create a key.

All required parameters must be populated in order to send to server.

ManagedHsmKeyListResult

The page of keys.

ManagedHsmKeyProperties

The properties of the key.

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

ManagedHsmKeyReleasePolicy

ManagedHsmKeyReleasePolicy.

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmKeyRotationPolicyAttributes.

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

ManagedHsmLifetimeAction

ManagedHsmLifetimeAction.

ManagedHsmListResult

List of managed HSM Pools.

ManagedHsmProperties

Properties of the managed HSM Pool.

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

ManagedHsmResource

Managed HSM resource.

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

ManagedHsmRotationPolicy

ManagedHsmRotationPolicy.

ManagedHsmSku

SKU details.

All required parameters must be populated in order to send to server.

ManagedHsmTrigger

ManagedHsmTrigger.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities).

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

All required parameters must be populated in order to send to server.

MetricSpecification

Metric specification of operation.

NetworkRuleSet

A set of rules governing the network accessibility of a vault.

Operation

Key Vault REST API operation definition.

OperationDisplay

Display metadata associated with the operation.

OperationListResult

Result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.

Permissions

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

PrivateEndpoint

Private endpoint object properties.

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

PrivateEndpointConnection

Private endpoint connection resource.

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

PrivateEndpointConnectionItem

Private endpoint connection item.

PrivateEndpointConnectionListResult

List of private endpoint connections.

PrivateLinkResource

A private link resource.

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

PrivateLinkResourceListResult

A list of private link resources.

PrivateLinkServiceConnectionState

An object that represents the approval state of the private link connection.

ProxyResourceWithoutSystemData

Common fields that are returned in the response for all Azure Resource Manager resources.

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

Resource

Key Vault resource.

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

ResourceListResult

List of vault resources.

RotationPolicy

RotationPolicy.

Secret

Resource information with extended details.

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

All required parameters must be populated in order to send to server.

SecretAttributes

The secret management attributes.

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

SecretCreateOrUpdateParameters

Parameters for creating or updating a secret.

All required parameters must be populated in order to send to server.

SecretListResult

List of secrets.

SecretPatchParameters

Parameters for patching a secret.

SecretPatchProperties

Properties of the secret.

SecretProperties

Properties of the secret.

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

ServiceSpecification

One property of operation, include log specifications.

Sku

SKU details.

All required parameters must be populated in order to send to server.

SystemData

Metadata pertaining to creation and last modification of the key vault resource.

Trigger

Trigger.

UserAssignedIdentity

User assigned identity properties.

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

Vault

Resource information with extended details.

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

All required parameters must be populated in order to send to server.

VaultAccessPolicyParameters

Parameters for updating the access policy in a vault.

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

All required parameters must be populated in order to send to server.

VaultAccessPolicyProperties

Properties of the vault access policy.

All required parameters must be populated in order to send to server.

VaultCheckNameAvailabilityParameters

The parameters used to check the availability of the vault name.

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

All required parameters must be populated in order to send to server.

VaultCreateOrUpdateParameters

Parameters for creating or updating a vault.

All required parameters must be populated in order to send to server.

VaultListResult

List of vaults.

VaultPatchParameters

Parameters for creating or updating a vault.

VaultPatchProperties

Properties of the vault.

VaultProperties

Properties of the vault.

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

All required parameters must be populated in order to send to server.

VirtualNetworkRule

A rule governing the accessibility of a vault from a specific virtual network.

All required parameters must be populated in order to send to server.

Enums

AccessPolicyUpdateKind

AccessPolicyUpdateKind.

ActionsRequired

A message indicating if changes on the service provider require any updates on the consumer.

ActivationStatus

Activation Status.

CertificatePermissions

CertificatePermissions.

CreateMode

The vault's create mode to indicate whether the vault need to be recovered or not.

DeletionRecoveryLevel

The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.

GeoReplicationRegionProvisioningState

The current provisioning state.

IdentityType

The type of identity.

JsonWebKeyCurveName

The elliptic curve name. For valid values, see JsonWebKeyCurveName.

JsonWebKeyOperation

The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.

JsonWebKeyType

The type of the key. For valid values, see JsonWebKeyType.

KeyPermissions

KeyPermissions.

KeyRotationPolicyActionType

The type of action.

ManagedHsmSkuFamily

SKU Family of the managed HSM Pool.

ManagedHsmSkuName

SKU of the managed HSM Pool.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

NetworkRuleAction

The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.

NetworkRuleBypassOptions

Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

ProvisioningState

Provisioning state.

PublicNetworkAccess

Control permission to the managed HSM from public networks.

Reason

The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.

SecretPermissions

SecretPermissions.

SkuFamily

SKU family name.

SkuName

SKU name to specify whether the key vault is a standard vault or a premium vault.

StoragePermissions

StoragePermissions.

VaultProvisioningState

Provisioning state of the vault.