VaultProperties Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models

Assembly:: Az.KeyVault.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Properties of the vault

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.VaultPropertiesTypeConverter))]
public class VaultProperties : Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.IVaultProperties

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.VaultPropertiesTypeConverter))>]
type VaultProperties = class
    interface IVaultProperties
    interface IJsonSerializable

Public Class VaultProperties
Implements IVaultProperties

Inheritance: Object
VaultProperties

Attributes: TypeConverterAttribute

Implements: IVaultProperties IJsonSerializable

Constructors

VaultProperties()

Creates an new VaultProperties instance.

Properties

AccessPolicy	An array of 0 to 1024 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. When `createMode` is set to `recover`, access policies are not required. Otherwise, access policies are required.
CreateMode	The vault's create mode to indicate whether the vault need to be recovered or not.
EnabledForDeployment	Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
EnabledForDiskEncryption	Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
EnabledForTemplateDeployment	Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
EnablePurgeProtection	Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value.
EnableRbacAuthorization	Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC.
EnableSoftDelete	Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false.
HsmPoolResourceId	The resource id of HSM Pool.
NetworkAclsBypass	Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
NetworkAclsDefaultAction	The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
NetworkAclsIPRule	The list of IP address rules.
NetworkAclsVirtualNetworkRule	The list of virtual network rules.
PrivateEndpointConnection	List of private endpoint connections associated with the key vault.
ProvisioningState	Provisioning state of the vault.
PublicNetworkAccess	Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules.
SkuFamily	SKU family name
SkuName	SKU name to specify whether the key vault is a standard vault or a premium vault.
SoftDeleteRetentionInDay
TenantId	The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
VaultUri	The URI of the vault for performing operations on keys and secrets.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of VaultProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of VaultProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.IVaultProperties.
FromJsonString(String)	Creates a new instance of VaultProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of VaultProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()

Applies to

Share via