VaultPatchParameters Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models

Assembly:

Az.KeyVault.private.dll

Parameters for creating or updating a vault

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.VaultPatchParametersTypeConverter))]
public class VaultPatchParameters : Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.IVaultPatchParameters

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.KeyVault.Models.VaultPatchParametersTypeConverter))>]
type VaultPatchParameters = class
    interface IVaultPatchParameters
    interface IJsonSerializable

Public Class VaultPatchParameters
Implements IVaultPatchParameters

Inheritance

Object

VaultPatchParameters

Attributes

TypeConverterAttribute

Implements

IVaultPatchParameters IJsonSerializable

Constructors

VaultPatchParameters()

Creates an new VaultPatchParameters instance.

Properties

AccessPolicy	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.
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 value of this property will not change.
EnableSoftDelete	Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false.
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.
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
Tag	The tags that will be assigned to the key vault.
TenantId	The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

Methods

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