Share via

ArmKeyVaultModelFactory.KeyVaultProperties Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.KeyVault.Models
Assembly:
Azure.ResourceManager.KeyVault.dll
Package:
Azure.ResourceManager.KeyVault v1.3.0
Package:
Azure.ResourceManager.KeyVault v1.2.0-beta.2
Source:
ArmKeyVaultModelFactory.cs
Source:
ArmKeyVaultModelFactory.cs

Initializes a new instance of KeyVaultProperties.

public static Azure.ResourceManager.KeyVault.Models.KeyVaultProperties KeyVaultProperties (Guid tenantId = default, Azure.ResourceManager.KeyVault.Models.KeyVaultSku sku = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.KeyVault.Models.KeyVaultAccessPolicy> accessPolicies = default, Uri vaultUri = default, string hsmPoolResourceId = default, bool? enabledForDeployment = default, bool? enabledForDiskEncryption = default, bool? enabledForTemplateDeployment = default, bool? enableSoftDelete = default, int? softDeleteRetentionInDays = default, bool? enableRbacAuthorization = default, Azure.ResourceManager.KeyVault.Models.KeyVaultCreateMode? createMode = default, bool? enablePurgeProtection = default, Azure.ResourceManager.KeyVault.Models.KeyVaultNetworkRuleSet networkRuleSet = default, Azure.ResourceManager.KeyVault.Models.KeyVaultProvisioningState? provisioningState = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.KeyVault.Models.KeyVaultPrivateEndpointConnectionItemData> privateEndpointConnections = default, string publicNetworkAccess = default);
static member KeyVaultProperties : Guid * Azure.ResourceManager.KeyVault.Models.KeyVaultSku * seq<Azure.ResourceManager.KeyVault.Models.KeyVaultAccessPolicy> * Uri * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<bool> * Nullable<Azure.ResourceManager.KeyVault.Models.KeyVaultCreateMode> * Nullable<bool> * Azure.ResourceManager.KeyVault.Models.KeyVaultNetworkRuleSet * Nullable<Azure.ResourceManager.KeyVault.Models.KeyVaultProvisioningState> * seq<Azure.ResourceManager.KeyVault.Models.KeyVaultPrivateEndpointConnectionItemData> * string -> Azure.ResourceManager.KeyVault.Models.KeyVaultProperties
Public Shared Function KeyVaultProperties (Optional tenantId As Guid = Nothing, Optional sku As KeyVaultSku = Nothing, Optional accessPolicies As IEnumerable(Of KeyVaultAccessPolicy) = Nothing, Optional vaultUri As Uri = Nothing, Optional hsmPoolResourceId As String = Nothing, Optional enabledForDeployment As Nullable(Of Boolean) = Nothing, Optional enabledForDiskEncryption As Nullable(Of Boolean) = Nothing, Optional enabledForTemplateDeployment As Nullable(Of Boolean) = Nothing, Optional enableSoftDelete As Nullable(Of Boolean) = Nothing, Optional softDeleteRetentionInDays As Nullable(Of Integer) = Nothing, Optional enableRbacAuthorization As Nullable(Of Boolean) = Nothing, Optional createMode As Nullable(Of KeyVaultCreateMode) = Nothing, Optional enablePurgeProtection As Nullable(Of Boolean) = Nothing, Optional networkRuleSet As KeyVaultNetworkRuleSet = Nothing, Optional provisioningState As Nullable(Of KeyVaultProvisioningState) = Nothing, Optional privateEndpointConnections As IEnumerable(Of KeyVaultPrivateEndpointConnectionItemData) = Nothing, Optional publicNetworkAccess As String = Nothing) As KeyVaultProperties

Parameters

tenantId
Guid

The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

sku
KeyVaultSku

SKU details.

accessPolicies
IEnumerable<KeyVaultAccessPolicy>

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.

vaultUri
Uri

The URI of the vault for performing operations on keys and secrets.

hsmPoolResourceId
String

The resource id of HSM Pool.

enabledForDeployment
Nullable<Boolean>

Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.

enabledForDiskEncryption
Nullable<Boolean>

Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.

enabledForTemplateDeployment
Nullable<Boolean>

Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.

enableSoftDelete
Nullable<Boolean>

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.

softDeleteRetentionInDays
Nullable<Int32>

softDelete data retention days. It accepts >=7 and <=90.

enableRbacAuthorization
Nullable<Boolean>

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.

createMode
Nullable<KeyVaultCreateMode>

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

enablePurgeProtection
Nullable<Boolean>

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.

networkRuleSet
KeyVaultNetworkRuleSet

Rules governing the accessibility of the key vault from specific network locations.

provisioningState
Nullable<KeyVaultProvisioningState>

Provisioning state of the vault.

privateEndpointConnections
IEnumerable<KeyVaultPrivateEndpointConnectionItemData>

List of private endpoint connections associated with the key vault.

publicNetworkAccess
String

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.

Returns

KeyVaultProperties

A new KeyVaultProperties instance for mocking.

Applies to