Share via

VaultProperties Class

  • Reference
Package:
com.azure.resourcemanager.keyvault.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-keyvault:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.keyvault.models.VaultProperties

Implements

JsonSerializable<VaultProperties>

public final class VaultProperties
implements JsonSerializable<VaultProperties>

Properties of the vault.

Constructor Summary

Constructor Description
VaultProperties()

Creates an instance of VaultProperties class.

Method Summary

Modifier and Type Method and Description
List<AccessPolicyEntry> accessPolicies()

Get the accessPolicies property: An array of 0 to 1024 identities that have access to the key vault.
CreateMode createMode()

Get the createMode property: The vault's create mode to indicate whether the vault need to be recovered or not.
Boolean enablePurgeProtection()

Get the enablePurgeProtection property: Property specifying whether protection against purge is enabled for this vault.
Boolean enableRbacAuthorization()

Get the enableRbacAuthorization property: Property that controls how data actions are authorized.
Boolean enableSoftDelete()

Get the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this key vault.
Boolean enabledForDeployment()

Get the enabledForDeployment property: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
Boolean enabledForDiskEncryption()

Get the enabledForDiskEncryption property: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
Boolean enabledForTemplateDeployment()

Get the enabledForTemplateDeployment property: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
static VaultProperties fromJson(JsonReader jsonReader)

Reads an instance of VaultProperties from the JsonReader.
String hsmPoolResourceId()

Get the hsmPoolResourceId property: The resource id of HSM Pool.
NetworkRuleSet networkAcls()

Get the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.
List<PrivateEndpointConnectionItem> privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connections associated with the key vault.
VaultProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the vault.
String publicNetworkAccess()

Get the publicNetworkAccess property: Property to specify whether the vault will accept traffic from public internet.
Sku sku()

Get the sku property: SKU details.
Integer softDeleteRetentionInDays()

Get the softDeleteRetentionInDays property: softDelete data retention days.
UUID tenantId()

Get the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
String vaultUri()

Get the vaultUri property: The URI of the vault for performing operations on keys and secrets.
VaultProperties withAccessPolicies(List<AccessPolicyEntry> accessPolicies)

Set the accessPolicies property: An array of 0 to 1024 identities that have access to the key vault.
VaultProperties withCreateMode(CreateMode createMode)

Set the createMode property: The vault's create mode to indicate whether the vault need to be recovered or not.
VaultProperties withEnablePurgeProtection(Boolean enablePurgeProtection)

Set the enablePurgeProtection property: Property specifying whether protection against purge is enabled for this vault.
VaultProperties withEnableRbacAuthorization(Boolean enableRbacAuthorization)

Set the enableRbacAuthorization property: Property that controls how data actions are authorized.
VaultProperties withEnableSoftDelete(Boolean enableSoftDelete)

Set the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this key vault.
VaultProperties withEnabledForDeployment(Boolean enabledForDeployment)

Set the enabledForDeployment property: Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
VaultProperties withEnabledForDiskEncryption(Boolean enabledForDiskEncryption)

Set the enabledForDiskEncryption property: Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
VaultProperties withEnabledForTemplateDeployment(Boolean enabledForTemplateDeployment)

Set the enabledForTemplateDeployment property: Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
VaultProperties withNetworkAcls(NetworkRuleSet networkAcls)

Set the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.
VaultProperties withProvisioningState(VaultProvisioningState provisioningState)

Set the provisioningState property: Provisioning state of the vault.
VaultProperties withPublicNetworkAccess(String publicNetworkAccess)

Set the publicNetworkAccess property: Property to specify whether the vault will accept traffic from public internet.
VaultProperties withSku(Sku sku)

Set the sku property: SKU details.
VaultProperties withSoftDeleteRetentionInDays(Integer softDeleteRetentionInDays)

Set the softDeleteRetentionInDays property: softDelete data retention days.
VaultProperties withTenantId(UUID tenantId)

Set the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
VaultProperties withVaultUri(String vaultUri)

Set the vaultUri property: The URI of the vault for performing operations on keys and secrets.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VaultProperties

public VaultProperties()

Creates an instance of VaultProperties class.

Method Details

accessPolicies

public List accessPolicies()

Get the accessPolicies property: 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.

Returns:

the accessPolicies value.

createMode

public CreateMode createMode()

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

Returns:

the createMode value.

enablePurgeProtection

public Boolean enablePurgeProtection()

Get the enablePurgeProtection property: 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.

Returns:

the enablePurgeProtection value.

enableRbacAuthorization

public Boolean enableRbacAuthorization()

Get the enableRbacAuthorization property: 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.

Returns:

the enableRbacAuthorization value.

enableSoftDelete

public Boolean enableSoftDelete()

Get the enableSoftDelete property: 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.

Returns:

the enableSoftDelete value.

enabledForDeployment

public Boolean enabledForDeployment()

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

Returns:

the enabledForDeployment value.

enabledForDiskEncryption

public Boolean enabledForDiskEncryption()

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

Returns:

the enabledForDiskEncryption value.

enabledForTemplateDeployment

public Boolean enabledForTemplateDeployment()

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

Returns:

the enabledForTemplateDeployment value.

fromJson

public static VaultProperties fromJson(JsonReader jsonReader)

Reads an instance of VaultProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of VaultProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

hsmPoolResourceId

public String hsmPoolResourceId()

Get the hsmPoolResourceId property: The resource id of HSM Pool.

Returns:

the hsmPoolResourceId value.

networkAcls

public NetworkRuleSet networkAcls()

Get the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.

Returns:

the networkAcls value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connections associated with the key vault.

Returns:

the privateEndpointConnections value.

provisioningState

public VaultProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the vault.

Returns:

the provisioningState value.

publicNetworkAccess

public String publicNetworkAccess()

Get the publicNetworkAccess property: 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:

the publicNetworkAccess value.

sku

public Sku sku()

Get the sku property: SKU details.

Returns:

the sku value.

softDeleteRetentionInDays

public Integer softDeleteRetentionInDays()

Get the softDeleteRetentionInDays property: softDelete data retention days. It accepts >=7 and <=90.

Returns:

the softDeleteRetentionInDays value.

tenantId

public UUID tenantId()

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

Returns:

the tenantId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

vaultUri

public String vaultUri()

Get the vaultUri property: The URI of the vault for performing operations on keys and secrets.

Returns:

the vaultUri value.

withAccessPolicies

public VaultProperties withAccessPolicies(List accessPolicies)

Set the accessPolicies property: 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.

Parameters:

accessPolicies - the accessPolicies value to set.

Returns:

the VaultProperties object itself.

withCreateMode

public VaultProperties withCreateMode(CreateMode createMode)

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

Parameters:

createMode - the createMode value to set.

Returns:

the VaultProperties object itself.

withEnablePurgeProtection

public VaultProperties withEnablePurgeProtection(Boolean enablePurgeProtection)

Set the enablePurgeProtection property: 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.

Parameters:

enablePurgeProtection - the enablePurgeProtection value to set.

Returns:

the VaultProperties object itself.

withEnableRbacAuthorization

public VaultProperties withEnableRbacAuthorization(Boolean enableRbacAuthorization)

Set the enableRbacAuthorization property: 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.

Parameters:

enableRbacAuthorization - the enableRbacAuthorization value to set.

Returns:

the VaultProperties object itself.

withEnableSoftDelete

public VaultProperties withEnableSoftDelete(Boolean enableSoftDelete)

Set the enableSoftDelete property: 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.

Parameters:

enableSoftDelete - the enableSoftDelete value to set.

Returns:

the VaultProperties object itself.

withEnabledForDeployment

public VaultProperties withEnabledForDeployment(Boolean enabledForDeployment)

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

Parameters:

enabledForDeployment - the enabledForDeployment value to set.

Returns:

the VaultProperties object itself.

withEnabledForDiskEncryption

public VaultProperties withEnabledForDiskEncryption(Boolean enabledForDiskEncryption)

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

Parameters:

enabledForDiskEncryption - the enabledForDiskEncryption value to set.

Returns:

the VaultProperties object itself.

withEnabledForTemplateDeployment

public VaultProperties withEnabledForTemplateDeployment(Boolean enabledForTemplateDeployment)

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

Parameters:

enabledForTemplateDeployment - the enabledForTemplateDeployment value to set.

Returns:

the VaultProperties object itself.

withNetworkAcls

public VaultProperties withNetworkAcls(NetworkRuleSet networkAcls)

Set the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.

Parameters:

networkAcls - the networkAcls value to set.

Returns:

the VaultProperties object itself.

withProvisioningState

public VaultProperties withProvisioningState(VaultProvisioningState provisioningState)

Set the provisioningState property: Provisioning state of the vault.

Parameters:

provisioningState - the provisioningState value to set.

Returns:

the VaultProperties object itself.

withPublicNetworkAccess

public VaultProperties withPublicNetworkAccess(String publicNetworkAccess)

Set the publicNetworkAccess property: 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.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the VaultProperties object itself.

withSku

public VaultProperties withSku(Sku sku)

Set the sku property: SKU details.

Parameters:

sku - the sku value to set.

Returns:

the VaultProperties object itself.

withSoftDeleteRetentionInDays

public VaultProperties withSoftDeleteRetentionInDays(Integer softDeleteRetentionInDays)

Set the softDeleteRetentionInDays property: softDelete data retention days. It accepts >=7 and <=90.

Parameters:

softDeleteRetentionInDays - the softDeleteRetentionInDays value to set.

Returns:

the VaultProperties object itself.

withTenantId

public VaultProperties withTenantId(UUID tenantId)

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

Parameters:

tenantId - the tenantId value to set.

Returns:

the VaultProperties object itself.

withVaultUri

public VaultProperties withVaultUri(String vaultUri)

Set the vaultUri property: The URI of the vault for performing operations on keys and secrets.

Parameters:

vaultUri - the vaultUri value to set.

Returns:

the VaultProperties object itself.

Applies to