Sdílet prostřednictvím

Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2022-05-15

  • Článek

Definice prostředku Bicep

Typ prostředku databaseAccounts/sqlRoleDefinitions je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, přidejte do šablony následující bicep.

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

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Jméno Popis Hodnota
Jméno Název prostředku string (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: databaseAccounts
vlastnosti Vlastnosti pro vytvoření a aktualizaci definice role SQL služby Azure Cosmos DB SqlRoleDefinitionResource

Povolení

Jméno Popis Hodnota
dataActions Pole datových akcí, které jsou povoleny. string[]
notDataActions Pole akcí dat, které jsou odepřeny. string[]

SqlRoleDefinitionResource

Jméno Popis Hodnota
assignableScopes Sada plně kvalifikovaných oborů s použitím této definice role nebo pod touto definicí role může být vytvořena. To umožní použití této definice role pro celý účet databáze nebo jakoukoli podkladovou databázi nebo kolekci. Musí mít alespoň jeden prvek. Obory vyšší než účet databáze nelze vynutit jako přiřaditelné obory. Všimněte si, že prostředky odkazované v přiřaditelných oborech nemusí existovat. string[]
dovolení Sada operací povolených prostřednictvím této definice role. oprávnění[]
roleName Uživatelsky přívětivý název definice role. Pro databázový účet musí být jedinečný. řetězec
typ Určuje, jestli byla definice role vytvořená předdefinovaná nebo vytvořená uživatelem. BuiltInRole
CustomRole

Příklady použití

Ukázky rychlého startu Azure

Následující šablony Azure pro rychlý start obsahují ukázky Bicep pro nasazení tohoto typu prostředku.

Soubor Bicep Popis
vytvoření účtu SQL služby Azure Cosmos DB s RBAC roviny dat Tato šablona vytvoří účet SLUŽBY SQL Cosmos, nativně udržovanou definici role a nativně udržované přiřazení role pro identitu AAD.

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/sqlRoleDefinitions je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, přidejte do šablony následující JSON.

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

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2022-05-15'
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pro vytvoření a aktualizaci definice role SQL služby Azure Cosmos DB SqlRoleDefinitionResource
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Povolení

Jméno Popis Hodnota
dataActions Pole datových akcí, které jsou povoleny. string[]
notDataActions Pole akcí dat, které jsou odepřeny. string[]

SqlRoleDefinitionResource

Jméno Popis Hodnota
assignableScopes Sada plně kvalifikovaných oborů s použitím této definice role nebo pod touto definicí role může být vytvořena. To umožní použití této definice role pro celý účet databáze nebo jakoukoli podkladovou databázi nebo kolekci. Musí mít alespoň jeden prvek. Obory vyšší než účet databáze nelze vynutit jako přiřaditelné obory. Všimněte si, že prostředky odkazované v přiřaditelných oborech nemusí existovat. string[]
dovolení Sada operací povolených prostřednictvím této definice role. oprávnění[]
roleName Uživatelsky přívětivý název definice role. Pro databázový účet musí být jedinečný. řetězec
typ Určuje, jestli byla definice role vytvořená předdefinovaná nebo vytvořená uživatelem. BuiltInRole
CustomRole

Příklady použití

Šablony azure pro rychlý start

Následující šablony Azure Pro rychlý start nasadit tento typ prostředku.

Šablona Popis
vytvoření účtu SQL služby Azure Cosmos DB s RBAC roviny dat

nasazení do Azure		 Tato šablona vytvoří účet SLUŽBY SQL Cosmos, nativně udržovanou definici role a nativně udržované přiřazení role pro identitu AAD.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts/sqlRoleDefinitions je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Jméno Popis Hodnota
Jméno Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: databaseAccounts
vlastnosti Vlastnosti pro vytvoření a aktualizaci definice role SQL služby Azure Cosmos DB SqlRoleDefinitionResource
typ Typ prostředku Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2022-05-15

Povolení

Jméno Popis Hodnota
dataActions Pole datových akcí, které jsou povoleny. string[]
notDataActions Pole akcí dat, které jsou odepřeny. string[]

SqlRoleDefinitionResource

Jméno Popis Hodnota
assignableScopes Sada plně kvalifikovaných oborů s použitím této definice role nebo pod touto definicí role může být vytvořena. To umožní použití této definice role pro celý účet databáze nebo jakoukoli podkladovou databázi nebo kolekci. Musí mít alespoň jeden prvek. Obory vyšší než účet databáze nelze vynutit jako přiřaditelné obory. Všimněte si, že prostředky odkazované v přiřaditelných oborech nemusí existovat. string[]
dovolení Sada operací povolených prostřednictvím této definice role. oprávnění[]
roleName Uživatelsky přívětivý název definice role. Pro databázový účet musí být jedinečný. řetězec
typ Určuje, jestli byla definice role vytvořená předdefinovaná nebo vytvořená uživatelem. BuiltInRole
CustomRole