Dela via

Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2024-09-01-preview

  • 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-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    assignableScopes: [
      'string'
    ]
    permissions: [
      {
        dataActions: [
          'string'
        ]
        notDataActions: [
          'string'
        ]
      }
    ]
    roleName: 'string'
    type: 'string'
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
förälder 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 den överordnade resursen.		 Symboliskt namn för resurs av typen: databaseAccounts
Egenskaper Egenskaper för att skapa och uppdatera en SQL-rolldefinition för Azure Cosmos DB. SqlRoleDefinitionResource

Tillåtelse

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

SqlRoleDefinitionResource

Namn 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 någon 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 var inbyggd eller om användaren skapades. "BuiltInRole"
"CustomRole"

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
Skapa ett Azure Cosmos DB SQL-konto med dataplanets RBAC- Den här mallen skapar ett SQL Cosmos-konto, en inbyggt underhållen rolldefinition och en inbyggt 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 Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Namn Beskrivning Värde
apiVersion API-versionen "2024-09-01-preview"
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för att skapa och uppdatera en SQL-rolldefinition för Azure Cosmos DB. SqlRoleDefinitionResource
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions"

Tillåtelse

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

SqlRoleDefinitionResource

Namn 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 någon 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 var inbyggd eller om användaren skapades. "BuiltInRole"
"CustomRole"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

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

Distribuera till Azure 		Den här mallen skapar ett SQL Cosmos-konto, en inbyggt underhållen rolldefinition och en inbyggt 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 Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Namn Beskrivning Värde
Namn 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
Egenskaper Egenskaper för att skapa och uppdatera en SQL-rolldefinition för Azure Cosmos DB. SqlRoleDefinitionResource
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-09-01-preview"

Tillåtelse

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

SqlRoleDefinitionResource

Namn 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 någon 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 var inbyggd eller om användaren skapades. "BuiltInRole"
"CustomRole"