Package com.azure.resourcemanager.cosmos.fluent.models

Class SqlRoleDefinitionResource

java.lang.Object
com.azure.resourcemanager.cosmos.fluent.models.SqlRoleDefinitionResource
All Implemented Interfaces:
com.azure.json.JsonSerializable<SqlRoleDefinitionResource>
public final class SqlRoleDefinitionResource extends Object implements com.azure.json.JsonSerializable<SqlRoleDefinitionResource>
Azure Cosmos DB SQL Role Definition resource object.

  • Constructor Details

    • SqlRoleDefinitionResource

      public SqlRoleDefinitionResource()
      Creates an instance of SqlRoleDefinitionResource class.

  • Method Details

    • roleName

      public String roleName()
      Get the roleName property: A user-friendly name for the Role Definition. Must be unique for the database account.
      Returns:
      the roleName value.

    • withRoleName

      public SqlRoleDefinitionResource withRoleName(String roleName)
      Set the roleName property: A user-friendly name for the Role Definition. Must be unique for the database account.
      Parameters:
      roleName - the roleName value to set.
      Returns:
      the SqlRoleDefinitionResource object itself.

    • type

      public RoleDefinitionType type()
      Get the type property: Indicates whether the Role Definition was built-in or user created.
      Returns:
      the type value.

    • withType

      public SqlRoleDefinitionResource withType(RoleDefinitionType type)
      Set the type property: Indicates whether the Role Definition was built-in or user created.
      Parameters:
      type - the type value to set.
      Returns:
      the SqlRoleDefinitionResource object itself.

    • assignableScopes

      public List<String> assignableScopes()
      Get the assignableScopes property: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
      Returns:
      the assignableScopes value.

    • withAssignableScopes

      public SqlRoleDefinitionResource withAssignableScopes(List<String> assignableScopes)
      Set the assignableScopes property: A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
      Parameters:
      assignableScopes - the assignableScopes value to set.
      Returns:
      the SqlRoleDefinitionResource object itself.

    • permissions

      public List<Permission> permissions()
      Get the permissions property: The set of operations allowed through this Role Definition.
      Returns:
      the permissions value.

    • withPermissions

      public SqlRoleDefinitionResource withPermissions(List<Permission> permissions)
      Set the permissions property: The set of operations allowed through this Role Definition.
      Parameters:
      permissions - the permissions value to set.
      Returns:
      the SqlRoleDefinitionResource 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<SqlRoleDefinitionResource>
      Throws:
      IOException

    • fromJson

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