Package com.azure.resourcemanager.keyvault.models

Interface Vault

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<KeyVaultManager,VaultInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<VaultInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<KeyVaultManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<Vault>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.model.Updatable<Vault.Update>
public interface Vault extends com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<KeyVaultManager,VaultInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<Vault>, com.azure.resourcemanager.resources.fluentcore.model.Updatable<Vault.Update>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection
An immutable client-side representation of an Azure Key Vault.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Vault.Definition
    Container interface for all the definitions that need to be implemented.
    static interface 
    Vault.DefinitionStages
    Grouping of all the key vault definition stages.
    static interface 
    Vault.Update
    The template for a key vault update operation, containing all the settings that can be modified.
    static interface 
    Vault.UpdateStages
    Grouping of all the key vault update stages.

    Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

    Modifier and Type
    Method
    Description
    List<AccessPolicy>
    accessPolicies()
    Gets an array of 0 to 16 identities that have access to the key vault.
    CreateMode
    createMode()
    Get the createMode value.
    boolean
    enabledForDeployment()
    Checks whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
    boolean
    enabledForDiskEncryption()
    Checks whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
    boolean
    enabledForTemplateDeployment()
    Checks whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
    KeyAsyncClient
    keyClient()
    Gets an authenticated Key Vault key client.
    Keys
    keys()
    Gets the Key Vault key API entry point.
    NetworkRuleSet
    networkRuleSet()
    Get the networkAcls value.
    PublicNetworkAccess
    publicNetworkAccess()
    Whether the vault can be accessed from public network.
    boolean
    purgeProtectionEnabled()
    Checks whether purge protection is enabled for this key vault.
    boolean
    roleBasedAccessControlEnabled()
    Checks whether role based access control (RBAC) for authorization of data access is enabled.
    SecretAsyncClient
    secretClient()
    Gets an authenticated Key Vault secret client.
    Secrets
    secrets()
    Gets the Key Vault secret API entry point.
    Sku
    sku()
    Gets SKU details.
    boolean
    softDeleteEnabled()
    Gets whether soft delete is enabled for this key vault.
    String
    tenantId()
    Gets the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
    com.azure.core.http.HttpPipeline
    vaultHttpPipeline()
    Gets an authenticated Key Vault rest client.
    String
    vaultUri()
    Gets the URI of the vault for performing operations on keys and secrets.

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasId

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager

    manager

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasName

    name

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup

    resourceGroupName

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

    refresh, refreshAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    region, regionName, tags, type

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource

    listPrivateLinkResources, listPrivateLinkResourcesAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection

    approvePrivateEndpointConnection, approvePrivateEndpointConnectionAsync, rejectPrivateEndpointConnection, rejectPrivateEndpointConnectionAsync

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

  • Method Details

    • secretClient

      SecretAsyncClient secretClient()
      Gets an authenticated Key Vault secret client.
      Returns:
      an authenticated Key Vault secret client

    • keyClient

      KeyAsyncClient keyClient()
      Gets an authenticated Key Vault key client.
      Returns:
      an authenticated Key Vault key client

    • vaultHttpPipeline

      com.azure.core.http.HttpPipeline vaultHttpPipeline()
      Gets an authenticated Key Vault rest client.
      Returns:
      an authenticated Key Vault rest client

    • keys

      Keys keys()
      Gets the Key Vault key API entry point.
      Returns:
      the Key Vault key API entry point

    • secrets

      Secrets secrets()
      Gets the Key Vault secret API entry point.
      Returns:
      the Key Vault secret API entry point

    • vaultUri

      String vaultUri()
      Gets the URI of the vault for performing operations on keys and secrets.
      Returns:
      the URI of the vault for performing operations on keys and secrets.

    • tenantId

      String tenantId()
      Gets the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
      Returns:
      the Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

    • sku

      Sku sku()
      Gets SKU details.
      Returns:
      SKU details.

    • accessPolicies

      List<AccessPolicy> accessPolicies()
      Gets an array of 0 to 16 identities that have access to the key vault.
      Returns:
      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.

    • roleBasedAccessControlEnabled

      boolean roleBasedAccessControlEnabled()
      Checks whether role based access control (RBAC) for authorization of data access is enabled.
      Returns:
      whether role based access control (RBAC) for authorization of data access is enabled.

    • publicNetworkAccess

      PublicNetworkAccess publicNetworkAccess()
      Whether the vault can be accessed from public network.
      Returns:
      whether the vault can be accessed from public network.

    • enabledForDeployment

      boolean enabledForDeployment()
      Checks whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
      Returns:
      whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.

    • enabledForDiskEncryption

      boolean enabledForDiskEncryption()
      Checks whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.
      Returns:
      whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys.

    • enabledForTemplateDeployment

      boolean enabledForTemplateDeployment()
      Checks whether Azure Resource Manager is permitted to retrieve secrets from the key vault.
      Returns:
      whether Azure Resource Manager is permitted to retrieve secrets from the key vault.

    • softDeleteEnabled

      boolean softDeleteEnabled()
      Gets whether soft delete is enabled for this key vault.
      Returns:
      whether soft delete is enabled for this key vault.

    • purgeProtectionEnabled

      boolean purgeProtectionEnabled()
      Checks whether purge protection is enabled for this key vault.
      Returns:
      whether purge protection is enabled for this key vault. Purge protection can only be enabled if soft delete is enabled.

    • createMode

      CreateMode createMode()
      Get the createMode value.
      Returns:
      the createMode value

    • networkRuleSet

      NetworkRuleSet networkRuleSet()
      Get the networkAcls value.
      Returns:
      the networkAcls value