VaultProperties (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.resourcemanager.keyvault.models.VaultProperties

public final class VaultProperties
extends Object

Properties of the vault.

Constructor Summary

Constructors
Constructor and Description

VaultProperties()

Constructors
Constructor and Description
`VaultProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`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.
`Boolean`	`enablePurgeProtection()` Get the enablePurgeProtection property: Property specifying whether protection against purge is enabled for this vault.
`Boolean`	`enableSoftDelete()` Get the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this key vault.
`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.
`Sku`	`sku()` Get the sku property: SKU details.
`UUID`	`tenantId()` Get the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
`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`	`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`	`withEnablePurgeProtection(Boolean enablePurgeProtection)` Set the enablePurgeProtection property: Property specifying whether protection against purge is enabled for this vault.
`VaultProperties`	`withEnableSoftDelete(Boolean enableSoftDelete)` Set the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this key vault.
`VaultProperties`	`withNetworkAcls(NetworkRuleSet networkAcls)` Set the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.
`VaultProperties`	`withSku(Sku sku)` Set the sku property: SKU details.
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VaultProperties
```
public VaultProperties()
```
- Method Detail
  - 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.
  - 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.
  - sku
```
public Sku sku()
```
    Get the sku property: SKU details.
    
    Returns:
    
    the sku value.
  - withSku
```
public VaultProperties withSku(Sku sku)
```
    Set the sku property: SKU details.
    
    Parameters:
    
    sku - the sku value to set.
    
    Returns:
    
    the VaultProperties object itself.
  - accessPolicies
```
public List<AccessPolicyEntry> 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.
  - withAccessPolicies
```
public VaultProperties withAccessPolicies(List<AccessPolicyEntry> 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.
  - vaultUri
```
public String vaultUri()
```
    Get the vaultUri property: The URI of the vault for performing operations on keys and secrets.
    
    Returns:
    
    the vaultUri value.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - enableSoftDelete
```
public Boolean enableSoftDelete()
```
    Get the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value.
    
    Returns:
    
    the enableSoftDelete value.
  - withEnableSoftDelete
```
public VaultProperties withEnableSoftDelete(Boolean enableSoftDelete)
```
    Set the enableSoftDelete property: Property to specify whether the 'soft delete' functionality is enabled for this key vault. It does not accept false value.
    
    Parameters:
    
    enableSoftDelete - the enableSoftDelete value to set.
    
    Returns:
    
    the VaultProperties object itself.
  - 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.
  - 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.
  - 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.
  - 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.
  - networkAcls
```
public NetworkRuleSet networkAcls()
```
    Get the networkAcls property: Rules governing the accessibility of the key vault from specific network locations.
    
    Returns:
    
    the networkAcls value.
  - 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.
  - privateEndpointConnections
```
public List<PrivateEndpointConnectionItem> privateEndpointConnections()
```
    Get the privateEndpointConnections property: List of private endpoint connections associated with the key vault.
    
    Returns:
    
    the privateEndpointConnections value.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Class VaultProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VaultProperties

Method Detail

tenantId

withTenantId

sku

withSku

accessPolicies

withAccessPolicies

vaultUri

withVaultUri

enabledForDeployment

withEnabledForDeployment

enabledForDiskEncryption

withEnabledForDiskEncryption

enabledForTemplateDeployment

withEnabledForTemplateDeployment

enableSoftDelete

withEnableSoftDelete

createMode

withCreateMode

enablePurgeProtection

withEnablePurgeProtection

networkAcls

withNetworkAcls

privateEndpointConnections

validate