Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions

  • Artikel

Bicep-resursdefinition

Resurstypen databaseAccounts/sqlRoleDefinitions kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

databaseAccounts/sqlRoleDefinitions

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: databaseAccounts
properties Egenskaper för att skapa och uppdatera en SQL-rolldefinition för Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Name Beskrivning Värde
assignableScopes En uppsättning fullständigt kvalificerade omfång vid eller under vilka rolltilldelningar kan skapas med hjälp av den här rolldefinitionen. Detta tillåter tillämpning av den här rolldefinitionen för hela databaskontot eller eventuell underliggande databas/samling. Måste ha minst ett element. Omfång som är högre än databaskontot kan inte tillämpas som tilldelningsbara omfång. Observera att resurser som refereras i tilldelningsbara omfång inte behöver finnas. string[]
behörigheter Den uppsättning åtgärder som tillåts via den här rolldefinitionen. Behörighet[]
roleName Ett användarvänligt namn för rolldefinitionen. Måste vara unikt för databaskontot. sträng
typ Anger om rolldefinitionen är inbyggd eller om användaren har skapats. "BuiltInRole"
"CustomRole"

Behörighet

Name Beskrivning Värde
dataActions En matris med dataåtgärder som tillåts. string[]
notDataActions En matris med dataåtgärder som nekas. string[]

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa ett Azure Cosmos DB SQL-konto med dataplanets RBAC

Distribuera till Azure		 Den här mallen skapar ett SQL Cosmos-konto, en internt underhållen rolldefinition och en internt underhållen rolltilldelning för en AAD-identitet.

Resursdefinition för ARM-mall

Resurstypen databaseAccounts/sqlRoleDefinitions kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions lägger du till följande JSON i mallen.

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

Egenskapsvärden

databaseAccounts/sqlRoleDefinitions

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions"
apiVersion Resurs-API-versionen '2024-05-15'
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
properties Egenskaper för att skapa och uppdatera en SQL-rolldefinition för Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Name Beskrivning Värde
assignableScopes En uppsättning fullständigt kvalificerade omfång vid eller under vilka rolltilldelningar kan skapas med hjälp av den här rolldefinitionen. Detta tillåter tillämpning av den här rolldefinitionen för hela databaskontot eller eventuell underliggande databas/samling. Måste ha minst ett element. Omfång som är högre än databaskontot kan inte tillämpas som tilldelningsbara omfång. Observera att resurser som refereras i tilldelningsbara omfång inte behöver finnas. string[]
behörigheter Den uppsättning åtgärder som tillåts via den här rolldefinitionen. Behörighet[]
roleName Ett användarvänligt namn för rolldefinitionen. Måste vara unikt för databaskontot. sträng
typ Anger om rolldefinitionen är inbyggd eller om användaren har skapats. "BuiltInRole"
"CustomRole"

Behörighet

Name Beskrivning Värde
dataActions En matris med dataåtgärder som tillåts. string[]
notDataActions En matris med dataåtgärder som nekas. string[]

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa ett Azure Cosmos DB SQL-konto med dataplanets RBAC

Distribuera till Azure		 Den här mallen skapar ett SQL Cosmos-konto, en internt underhållen rolldefinition och en internt underhållen rolltilldelning för en AAD-identitet.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen databaseAccounts/sqlRoleDefinitions kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions lägger du till följande Terraform i mallen.

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

Egenskapsvärden

databaseAccounts/sqlRoleDefinitions

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15"
name Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: databaseAccounts
properties Egenskaper för att skapa och uppdatera en SQL-rolldefinition för Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Name Beskrivning Värde
assignableScopes En uppsättning fullständigt kvalificerade omfång vid eller under vilka rolltilldelningar kan skapas med hjälp av den här rolldefinitionen. Detta tillåter tillämpning av den här rolldefinitionen för hela databaskontot eller eventuell underliggande databas/samling. Måste ha minst ett element. Omfång som är högre än databaskontot kan inte tillämpas som tilldelningsbara omfång. Observera att resurser som refereras i tilldelningsbara omfång inte behöver finnas. string[]
behörigheter Den uppsättning åtgärder som tillåts via den här rolldefinitionen. Behörighet[]
roleName Ett användarvänligt namn för rolldefinitionen. Måste vara unikt för databaskontot. sträng
typ Anger om rolldefinitionen är inbyggd eller om användaren har skapats. "BuiltInRole"
"CustomRole"

Behörighet

Name Beskrivning Värde
dataActions En matris med dataåtgärder som tillåts. string[]
notDataActions En matris med dataåtgärder som nekas. string[]