Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/sqlRoleDefinitions 2024-05-15-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/sqlRoleDefinitions se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    assignableScopes: [
      'string'
    ]
    permissions: [
      {
        dataActions: [
          'string'
        ]
        notDataActions: [
          'string'
        ]
      }
    ]
    roleName: 'string'
    type: 'string'
  }
}

Valores de propiedad

databaseAccounts/sqlRoleDefinitions

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: databaseAccounts
properties Propiedades para crear y actualizar una definición de rol de SQL de Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Nombre Descripción Valor
assignableScopes Un conjunto de ámbitos completos en o por debajo de los cuales se pueden crear asignaciones de roles mediante esta definición de roles. Esto permitirá la aplicación de esta definición de roles en toda la cuenta de base de datos o en cualquier base de datos o colección subyacente. Debe tener al menos un elemento. Los ámbitos superiores a la cuenta de base de datos no se pueden aplicar como ámbitos asignables. Tenga en cuenta que los recursos a los que se hace referencia en ámbitos asignables no necesitan existir. string[]
permisos Conjunto de operaciones permitidas a través de esta definición de roles. Permiso[]
roleName Un nombre descriptivo para la definición de roles. Debe ser único para la cuenta de base de datos. string
type Indica si se creó la definición de roles o el usuario. "BuiltInRole"
'CustomRole'

Permiso

Nombre Descripción Valor
dataActions Matriz de acciones de datos permitidas. string[]
notDataActions Matriz de acciones de datos denegadas. string[]

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una cuenta sql de Azure Cosmos DB con RBAC del plano de datos

Implementación en Azure		 Esta plantilla creará una cuenta de SQL Cosmos, una definición de rol mantenida de forma nativa y una asignación de roles mantenida de forma nativa para una identidad de AAD.

Definición de recursos de plantilla de ARM

El tipo de recurso databaseAccounts/sqlRoleDefinitions se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
  "apiVersion": "2024-05-15-preview",
  "name": "string",
  "properties": {
    "assignableScopes": [ "string" ],
    "permissions": [
      {
        "dataActions": [ "string" ],
        "notDataActions": [ "string" ]
      }
    ],
    "roleName": "string",
    "type": "string"
  }
}

Valores de propiedad

databaseAccounts/sqlRoleDefinitions

Nombre Descripción Value
type Tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'
apiVersion La versión de la API de recursos "2024-05-15-preview"
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)
properties Propiedades para crear y actualizar una definición de rol de SQL de Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Nombre Descripción Valor
assignableScopes Un conjunto de ámbitos completos en o por debajo de los cuales se pueden crear asignaciones de roles mediante esta definición de roles. Esto permitirá la aplicación de esta definición de roles en toda la cuenta de base de datos o en cualquier base de datos o colección subyacente. Debe tener al menos un elemento. Los ámbitos superiores a la cuenta de base de datos no se pueden aplicar como ámbitos asignables. Tenga en cuenta que los recursos a los que se hace referencia en ámbitos asignables no necesitan existir. string[]
permisos Conjunto de operaciones permitidas a través de esta definición de roles. Permiso[]
roleName Un nombre descriptivo para la definición de roles. Debe ser único para la cuenta de base de datos. string
type Indica si se creó la definición de roles o el usuario. "BuiltInRole"
'CustomRole'

Permiso

Nombre Descripción Valor
dataActions Matriz de acciones de datos permitidas. string[]
notDataActions Matriz de acciones de datos denegadas. string[]

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una cuenta sql de Azure Cosmos DB con RBAC del plano de datos

Implementación en Azure		 Esta plantilla creará una cuenta de SQL Cosmos, una definición de rol mantenida de forma nativa y una asignación de roles mantenida de forma nativa para una identidad de AAD.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso databaseAccounts/sqlRoleDefinitions se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  })
}

Valores de propiedad

databaseAccounts/sqlRoleDefinitions

Nombre Descripción Value
type Tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15-preview"
name El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: databaseAccounts
properties Propiedades para crear y actualizar una definición de rol de SQL de Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Nombre Descripción Valor
assignableScopes Un conjunto de ámbitos completos en o por debajo de los cuales se pueden crear asignaciones de roles mediante esta definición de roles. Esto permitirá la aplicación de esta definición de roles en toda la cuenta de base de datos o en cualquier base de datos o colección subyacente. Debe tener al menos un elemento. Los ámbitos superiores a la cuenta de base de datos no se pueden aplicar como ámbitos asignables. Tenga en cuenta que los recursos a los que se hace referencia en ámbitos asignables no necesitan existir. string[]
permisos Conjunto de operaciones permitidas a través de esta definición de roles. Permiso[]
roleName Un nombre descriptivo para la definición de roles. Debe ser único para la cuenta de base de datos. string
type Indica si se creó la definición de roles o el usuario. "BuiltInRole"
"CustomRole"

Permiso

Nombre Descripción Valor
dataActions Matriz de acciones de datos permitidas. string[]
notDataActions Matriz de acciones de datos denegadas. string[]