Package com.azure.resourcemanager.keyvault.models

Class VaultProperties

  • public final class VaultProperties
extends Object
    Properties of the vault.

    • 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. This property is readonly.
        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. This property is readonly.
        Parameters:
        vaultUri - the vaultUri value to set.
        Returns:
        the VaultProperties object itself.

      • hsmPoolResourceId

        public String hsmPoolResourceId()
        Get the hsmPoolResourceId property: The resource id of HSM Pool.
        Returns:
        the hsmPoolResourceId 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.

      • 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. 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.

      • 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.

      • softDeleteRetentionInDays

        public Integer softDeleteRetentionInDays()
        Get the softDeleteRetentionInDays property: softDelete data retention days. It accepts >=7 and <=90.
        Returns:
        the softDeleteRetentionInDays value.

      • 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.

      • 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.

      • 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.

      • 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.

      • provisioningState

        public VaultProvisioningState provisioningState()
        Get the provisioningState property: Provisioning state of the vault.
        Returns:
        the provisioningState value.

      • 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.

      • 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.