Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2024-02-15-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/sqlRoleDefinitions można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: databaseAccounts
Właściwości Właściwości do tworzenia i aktualizowania definicji roli SQL usługi Azure Cosmos DB. SqlRoleDefinitionResource

Pozwolenie

Nazwa Opis Wartość
dataActions Tablica akcji danych, które są dozwolone. string[]
notDataActions Tablica akcji danych, które są odrzucane. string[]

SqlRoleDefinitionResource

Nazwa Opis Wartość
assignableScopes Zestaw w pełni kwalifikowanych zakresów w lub poniżej, które można utworzyć przypisania ról przy użyciu tej definicji roli. Umożliwi to zastosowanie tej definicji roli na całym koncie bazy danych lub dowolnej podstawowej bazie danych/kolekcji. Musi zawierać co najmniej jeden element. Zakresy wyższe niż konto bazy danych nie są wymuszane jako możliwe do przypisania zakresy. Należy pamiętać, że zasoby, do których odwołuje się przypisywane zakresy, nie muszą istnieć. string[]
Uprawnienia Zestaw operacji dozwolony za pomocą tej definicji roli. uprawnienia[]
roleName Przyjazna dla użytkownika nazwa definicji roli. Musi być unikatowa dla konta bazy danych. struna
typ Wskazuje, czy definicja roli została utworzona, czy też utworzona przez użytkownika. "BuiltInRole"
"CustomRole"

Przykłady z przewodnika Szybki start

W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.

Plik Bicep Opis
Tworzenie konta SQL usługi Azure Cosmos DB przy użyciu kontroli dostępu opartej na rolach płaszczyzny danych Ten szablon utworzy konto usługi SQL Cosmos, natywnie zachowaną definicję roli i natywnie obsługiwane przypisanie roli dla tożsamości usługi AAD.

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/sqlRoleDefinitions można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2024-02-15-preview"
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości do tworzenia i aktualizowania definicji roli SQL usługi Azure Cosmos DB. SqlRoleDefinitionResource
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions"

Pozwolenie

Nazwa Opis Wartość
dataActions Tablica akcji danych, które są dozwolone. string[]
notDataActions Tablica akcji danych, które są odrzucane. string[]

SqlRoleDefinitionResource

Nazwa Opis Wartość
assignableScopes Zestaw w pełni kwalifikowanych zakresów w lub poniżej, które można utworzyć przypisania ról przy użyciu tej definicji roli. Umożliwi to zastosowanie tej definicji roli na całym koncie bazy danych lub dowolnej podstawowej bazie danych/kolekcji. Musi zawierać co najmniej jeden element. Zakresy wyższe niż konto bazy danych nie są wymuszane jako możliwe do przypisania zakresy. Należy pamiętać, że zasoby, do których odwołuje się przypisywane zakresy, nie muszą istnieć. string[]
Uprawnienia Zestaw operacji dozwolony za pomocą tej definicji roli. uprawnienia[]
roleName Przyjazna dla użytkownika nazwa definicji roli. Musi być unikatowa dla konta bazy danych. struna
typ Wskazuje, czy definicja roli została utworzona, czy też utworzona przez użytkownika. "BuiltInRole"
"CustomRole"

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Tworzenie konta SQL usługi Azure Cosmos DB przy użyciu kontroli dostępu opartej na rolach płaszczyzny danych

wdrażanie w usłudze Azure		 Ten szablon utworzy konto usługi SQL Cosmos, natywnie zachowaną definicję roli i natywnie obsługiwane przypisanie roli dla tożsamości usługi AAD.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/sqlRoleDefinitions można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Nazwa Opis Wartość
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts
Właściwości Właściwości do tworzenia i aktualizowania definicji roli SQL usługi Azure Cosmos DB. SqlRoleDefinitionResource
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-02-15-preview"

Pozwolenie

Nazwa Opis Wartość
dataActions Tablica akcji danych, które są dozwolone. string[]
notDataActions Tablica akcji danych, które są odrzucane. string[]

SqlRoleDefinitionResource

Nazwa Opis Wartość
assignableScopes Zestaw w pełni kwalifikowanych zakresów w lub poniżej, które można utworzyć przypisania ról przy użyciu tej definicji roli. Umożliwi to zastosowanie tej definicji roli na całym koncie bazy danych lub dowolnej podstawowej bazie danych/kolekcji. Musi zawierać co najmniej jeden element. Zakresy wyższe niż konto bazy danych nie są wymuszane jako możliwe do przypisania zakresy. Należy pamiętać, że zasoby, do których odwołuje się przypisywane zakresy, nie muszą istnieć. string[]
Uprawnienia Zestaw operacji dozwolony za pomocą tej definicji roli. uprawnienia[]
roleName Przyjazna dla użytkownika nazwa definicji roli. Musi być unikatowa dla konta bazy danych. struna
typ Wskazuje, czy definicja roli została utworzona, czy też utworzona przez użytkownika. "BuiltInRole"
"CustomRole"