Udostępnij za pośrednictwem


Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2023-09-15

Definicja zasobu Bicep

Typ zasobu databaseAccounts/sqlRoleDefinitions można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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@2023-09-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    assignableScopes: [
      'string'
    ]
    permissions: [
      {
        dataActions: [
          'string'
        ]
        notDataActions: [
          'string'
        ]
      }
    ]
    roleName: 'string'
    type: 'string'
  }
}

Wartości właściwości

databaseAccounts/sqlRoleDefinitions

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.
ciąg (wymagany)
Nadrzędny 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
properties Właściwości do tworzenia i aktualizowania definicji roli SQL usługi Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Nazwa Opis Wartość
assignableScopes Zestaw w pełni kwalifikowanych zakresów w lokalizacji lub poniżej, w których 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 bazowej bazie danych/kolekcji. Musi zawierać co najmniej jeden element. Zakresy wyższe niż konto bazy danych nie można wymusić jako zakresów możliwych do przypisania. Należy pamiętać, że zasoby, do których odwołuje się przypisywane zakresy, nie muszą istnieć. ciąg[]
uprawnienia Zestaw operacji dozwolonych za pomocą tej definicji roli. Uprawnienie[]
Rolename Przyjazna dla użytkownika nazwa definicji roli. Musi być unikatowa dla konta bazy danych. ciąg
typ Wskazuje, czy definicja roli została utworzona, czy utworzona przez użytkownika. "BuiltInRole"
"CustomRole"

Uprawnienie

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

Szablony szybkiego startu

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

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

Wdróż na platformie Azure
Ten szablon utworzy konto usługi SQL Cosmos, natywnie utrzymywaną 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ć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik 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": "2023-09-15",
  "name": "string",
  "properties": {
    "assignableScopes": [ "string" ],
    "permissions": [
      {
        "dataActions": [ "string" ],
        "notDataActions": [ "string" ]
      }
    ],
    "roleName": "string",
    "type": "string"
  }
}

Wartości właściwości

databaseAccounts/sqlRoleDefinitions

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions"
apiVersion Wersja interfejsu API zasobów '2023-09-15'
name Nazwa zasobu

Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON.
ciąg (wymagany)
properties Właściwości do tworzenia i aktualizowania definicji roli SQL usługi Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Nazwa Opis Wartość
assignableScopes Zestaw w pełni kwalifikowanych zakresów w lokalizacji lub poniżej, w której można utworzyć przypisania ról przy użyciu tej definicji roli. Pozwoli to na zastosowanie tej definicji roli na całym koncie bazy danych lub dowolnej bazowej bazie danych/kolekcji. Musi mieć 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ć. ciąg[]
uprawnienia Zestaw operacji dozwolonych za pomocą tej definicji roli. Uprawnienie[]
Rolename Przyjazna dla użytkownika nazwa definicji roli. Musi być unikatowa dla konta bazy danych. ciąg
typ Wskazuje, czy definicja roli została utworzona, czy użytkownik. "BuiltInRole"
"CustomRole"

Uprawnienie

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

Szablony szybkiego startu

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

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

Wdróż na platformie Azure
Ten szablon utworzy konto usługi SQL Cosmos, natywnie utrzymywaną definicję roli i natywnie zachowane przypisanie roli dla tożsamości usługi AAD.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/sqlRoleDefinitions można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

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

Format zasobu

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

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

Wartości właściwości

databaseAccounts/sqlRoleDefinitions

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

SqlRoleDefinitionResource

Nazwa Opis Wartość
assignableScopes Zestaw w pełni kwalifikowanych zakresów w lokalizacji lub poniżej, w której można utworzyć przypisania ról przy użyciu tej definicji roli. Pozwoli to na zastosowanie tej definicji roli na całym koncie bazy danych lub dowolnej bazowej bazie danych/kolekcji. Musi mieć 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ć. ciąg[]
uprawnienia Zestaw operacji dozwolonych za pomocą tej definicji roli. Uprawnienie[]
Rolename Przyjazna dla użytkownika nazwa definicji roli. Musi być unikatowa dla konta bazy danych. ciąg
typ Wskazuje, czy definicja roli została utworzona, czy użytkownik. "BuiltInRole"
"CustomRole"

Uprawnienie

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