Partilhar via

Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2023-03-01-preview

  • Artigo

Definição de recursos do bíceps

O tipo de recurso databaseAccounts/sqlRoleDefinitions pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: databaseAccounts
propriedades Propriedades para criar e atualizar uma Definição de Função SQL do Azure Cosmos DB. SqlRoleDefinitionResource

Permissão

Designação Descrição Valor
dataActions Uma matriz de ações de dados que são permitidas. string[]
notDataActions Uma matriz de ações de dados que são negadas. string[]

SqlRoleDefinitionResource

Designação Descrição Valor
assignableScopes Um conjunto de Escopos totalmente qualificados em ou abaixo dos quais Atribuições de Função podem ser criadas usando esta Definição de Função. Isso permitirá a aplicação desta Definição de Função em toda a conta do banco de dados ou em qualquer Banco de Dados / Coleção subjacente. Deve ter pelo menos um elemento. Escopos superiores à conta de banco de dados não são aplicáveis como escopos atribuíveis. Observe que os recursos referenciados em Escopos atribuíveis não precisam existir. string[]
Permissões O conjunto de operações permitidas através desta Definição de Função. Permissão[]
nome_da-função Um nome amigável para a definição de função. Deve ser exclusivo para a conta do banco de dados. string
tipo Indica se a Definição de Função foi interna ou criada pelo usuário. 'BuiltInRole'
'CustomRole'

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Criar uma conta SQL do Azure Cosmos DB com o plano de dados RBAC Este modelo criará uma conta do SQL Cosmos, uma Definição de Função mantida nativamente e uma Atribuição de Função mantida nativamente para uma identidade do AAD.

Definição de recurso de modelo ARM

O tipo de recurso databaseAccounts/sqlRoleDefinitions pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Designação Descrição Valor
apiVersion A versão api '2023-03-01-pré-visualização'
Designação O nome do recurso string (obrigatório)
propriedades Propriedades para criar e atualizar uma Definição de Função SQL do Azure Cosmos DB. SqlRoleDefinitionResource
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'

Permissão

Designação Descrição Valor
dataActions Uma matriz de ações de dados que são permitidas. string[]
notDataActions Uma matriz de ações de dados que são negadas. string[]

SqlRoleDefinitionResource

Designação Descrição Valor
assignableScopes Um conjunto de Escopos totalmente qualificados em ou abaixo dos quais Atribuições de Função podem ser criadas usando esta Definição de Função. Isso permitirá a aplicação desta Definição de Função em toda a conta do banco de dados ou em qualquer Banco de Dados / Coleção subjacente. Deve ter pelo menos um elemento. Escopos superiores à conta de banco de dados não são aplicáveis como escopos atribuíveis. Observe que os recursos referenciados em Escopos atribuíveis não precisam existir. string[]
Permissões O conjunto de operações permitidas através desta Definição de Função. Permissão[]
nome_da-função Um nome amigável para a definição de função. Deve ser exclusivo para a conta do banco de dados. string
tipo Indica se a Definição de Função foi interna ou criada pelo usuário. 'BuiltInRole'
'CustomRole'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma conta SQL do Azure Cosmos DB com o plano de dados RBAC

Implantar no Azure 		Este modelo criará uma conta do SQL Cosmos, uma Definição de Função mantida nativamente e uma Atribuição de Função mantida nativamente para uma identidade do AAD.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso databaseAccounts/sqlRoleDefinitions pode ser implantado com operações que visam:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: databaseAccounts
propriedades Propriedades para criar e atualizar uma Definição de Função SQL do Azure Cosmos DB. SqlRoleDefinitionResource
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2023-03-01-preview"

Permissão

Designação Descrição Valor
dataActions Uma matriz de ações de dados que são permitidas. string[]
notDataActions Uma matriz de ações de dados que são negadas. string[]

SqlRoleDefinitionResource

Designação Descrição Valor
assignableScopes Um conjunto de Escopos totalmente qualificados em ou abaixo dos quais Atribuições de Função podem ser criadas usando esta Definição de Função. Isso permitirá a aplicação desta Definição de Função em toda a conta do banco de dados ou em qualquer Banco de Dados / Coleção subjacente. Deve ter pelo menos um elemento. Escopos superiores à conta de banco de dados não são aplicáveis como escopos atribuíveis. Observe que os recursos referenciados em Escopos atribuíveis não precisam existir. string[]
Permissões O conjunto de operações permitidas através desta Definição de Função. Permissão[]
nome_da-função Um nome amigável para a definição de função. Deve ser exclusivo para a conta do banco de dados. string
tipo Indica se a Definição de Função foi interna ou criada pelo usuário. 'BuiltInRole'
'CustomRole'