Delen via

Microsoft.DocumentDB-databaseAccounts/sqlRoleDefinitions

  • Artikel

Bicep-resourcedefinitie

Het resourcetype databaseAccounts/sqlRoleDefinitions kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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'
  }
}

Eigenschapswaarden

databaseAccounts/sqlRoleDefinitions

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.		 tekenreeks (vereist)
Bovenliggende In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie Onderliggende resource buiten bovenliggende resource voor meer informatie.		 Symbolische naam voor resource van het type: databaseAccounts
properties Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB SQL-roldefinitie. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Naam Description Waarde
assignableScopes Een set volledig gekwalificeerde bereiken op of onder welke roltoewijzingen kunnen worden gemaakt met behulp van deze roldefinitie. Hiermee kunt u deze roldefinitie toepassen op het hele databaseaccount of een onderliggende database/verzameling. Moet ten minste één element bevatten. Bereiken die hoger zijn dan databaseaccounts kunnen niet worden afgedwongen als toewijsbare bereiken. Houd er rekening mee dat resources waarnaar wordt verwezen in toewijsbare bereiken niet hoeven te bestaan. tekenreeks[]
permissions De set bewerkingen die zijn toegestaan via deze roldefinitie. Machtiging[]
roleName Een gebruiksvriendelijke naam voor de roldefinitie. Moet uniek zijn voor het databaseaccount. tekenreeks
type Hiermee wordt aangegeven of de roldefinitie is ingebouwd of door de gebruiker is gemaakt. 'BuiltInRole'
'CustomRole'

Machtiging

Naam Description Waarde
dataActions Een matrix met gegevensacties die zijn toegestaan. tekenreeks[]
notDataActions Een matrix met gegevensacties die worden geweigerd. tekenreeks[]

Snelstartsjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Een Azure Cosmos DB SQL-account maken met gegevensvlak-RBAC

Implementeren op Azure		 Met deze sjabloon maakt u een SQL Cosmos-account, een systeemeigen onderhouden roldefinitie en een systeemeigen onderhouden roltoewijzing voor een AAD-identiteit.

Resourcedefinitie van ARM-sjabloon

Het resourcetype databaseAccounts/sqlRoleDefinitions kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

databaseAccounts/sqlRoleDefinitions

Naam Description Waarde
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'
apiVersion De resource-API-versie '2024-05-15'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.		 tekenreeks (vereist)
properties Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB SQL-roldefinitie. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Naam Description Waarde
assignableScopes Een set volledig gekwalificeerde bereiken op of onder welke roltoewijzingen kunnen worden gemaakt met behulp van deze roldefinitie. Hierdoor kan deze roldefinitie worden toegepast op het hele databaseaccount of een onderliggende database/verzameling. Moet ten minste één element bevatten. Bereiken die hoger zijn dan het databaseaccount kunnen niet worden afgedwongen als toewijsbare bereiken. Houd er rekening mee dat resources waarnaar wordt verwezen in toewijsbare bereiken niet hoeven te bestaan. tekenreeks[]
permissions De set bewerkingen die zijn toegestaan via deze roldefinitie. Machtiging[]
roleName Een gebruiksvriendelijke naam voor de roldefinitie. Moet uniek zijn voor het databaseaccount. tekenreeks
type Hiermee wordt aangegeven of de roldefinitie is ingebouwd of door de gebruiker is gemaakt. 'BuiltInRole'
'CustomRole'

Machtiging

Naam Description Waarde
dataActions Een matrix met gegevensacties die zijn toegestaan. tekenreeks[]
notDataActions Een matrix met gegevensacties die worden geweigerd. tekenreeks[]

Snelstartsjablonen

Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Een Azure Cosmos DB SQL-account maken met gegevensvlak-RBAC

Implementeren op Azure		 Met deze sjabloon maakt u een SQL Cosmos-account, een systeemeigen onderhouden roldefinitie en een systeemeigen onderhouden roltoewijzing voor een AAD-identiteit.

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype databaseAccounts/sqlRoleDefinitions kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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"
    }
  })
}

Eigenschapswaarden

databaseAccounts/sqlRoleDefinitions

Naam Description Waarde
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15"
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: databaseAccounts
properties Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB SQL-roldefinitie. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Naam Description Waarde
assignableScopes Een set volledig gekwalificeerde bereiken op of onder welke roltoewijzingen kunnen worden gemaakt met behulp van deze roldefinitie. Hierdoor kan deze roldefinitie worden toegepast op het hele databaseaccount of een onderliggende database/verzameling. Moet ten minste één element bevatten. Bereiken die hoger zijn dan het databaseaccount kunnen niet worden afgedwongen als toewijsbare bereiken. Houd er rekening mee dat resources waarnaar wordt verwezen in toewijsbare bereiken niet hoeven te bestaan. tekenreeks[]
permissions De set bewerkingen die zijn toegestaan via deze roldefinitie. Machtiging[]
roleName Een gebruiksvriendelijke naam voor de roldefinitie. Moet uniek zijn voor het databaseaccount. tekenreeks
type Hiermee wordt aangegeven of de roldefinitie is ingebouwd of door de gebruiker is gemaakt. "BuiltInRole"
"CustomRole"

Machtiging

Naam Description Waarde
dataActions Een matrix met gegevensacties die zijn toegestaan. tekenreeks[]
notDataActions Een matrix met gegevensacties die worden geweigerd. tekenreeks[]