Package com.azure.resourcemanager.keyvault.models

Class AccessPolicyEntry

java.lang.Object
com.azure.resourcemanager.keyvault.models.AccessPolicyEntry
All Implemented Interfaces:
com.azure.json.JsonSerializable<AccessPolicyEntry>
public final class AccessPolicyEntry extends Object implements com.azure.json.JsonSerializable<AccessPolicyEntry>
An identity 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.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AccessPolicyEntry()
    Creates an instance of AccessPolicyEntry class.

  • Method Summary

    Modifier and Type
    Method
    Description
    UUID
    applicationId()
    Get the applicationId property: Application ID of the client making request on behalf of a principal.
    static AccessPolicyEntry
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of AccessPolicyEntry from the JsonReader.
    String
    objectId()
    Get the objectId property: The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault.
    Permissions
    permissions()
    Get the permissions property: Permissions the identity has for keys, secrets and certificates.
    UUID
    tenantId()
    Get the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    AccessPolicyEntry
    withApplicationId(UUID applicationId)
    Set the applicationId property: Application ID of the client making request on behalf of a principal.
    AccessPolicyEntry
    withObjectId(String objectId)
    Set the objectId property: The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault.
    AccessPolicyEntry
    withPermissions(Permissions permissions)
    Set the permissions property: Permissions the identity has for keys, secrets and certificates.
    AccessPolicyEntry
    withTenantId(UUID tenantId)
    Set the tenantId property: The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • AccessPolicyEntry

      public AccessPolicyEntry()
      Creates an instance of AccessPolicyEntry class.

  • Method Details

    • 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 AccessPolicyEntry 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 AccessPolicyEntry object itself.

    • objectId

      public String objectId()
      Get the objectId property: The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.
      Returns:
      the objectId value.

    • withObjectId

      public AccessPolicyEntry withObjectId(String objectId)
      Set the objectId property: The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.
      Parameters:
      objectId - the objectId value to set.
      Returns:
      the AccessPolicyEntry object itself.

    • applicationId

      public UUID applicationId()
      Get the applicationId property: Application ID of the client making request on behalf of a principal.
      Returns:
      the applicationId value.

    • withApplicationId

      public AccessPolicyEntry withApplicationId(UUID applicationId)
      Set the applicationId property: Application ID of the client making request on behalf of a principal.
      Parameters:
      applicationId - the applicationId value to set.
      Returns:
      the AccessPolicyEntry object itself.

    • permissions

      public Permissions permissions()
      Get the permissions property: Permissions the identity has for keys, secrets and certificates.
      Returns:
      the permissions value.

    • withPermissions

      public AccessPolicyEntry withPermissions(Permissions permissions)
      Set the permissions property: Permissions the identity has for keys, secrets and certificates.
      Parameters:
      permissions - the permissions value to set.
      Returns:
      the AccessPolicyEntry object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AccessPolicyEntry>
      Throws:
      IOException

    • fromJson

      public static AccessPolicyEntry fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AccessPolicyEntry from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AccessPolicyEntry if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AccessPolicyEntry.