SqlResources2 - Get Sql Role Definition

Pobiera właściwości istniejącej Azure Cosmos DB roli SQL o podanym identyfikatorze.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}?api-version=2021-03-01-preview

Parametry identyfikatora URI

Name In Required Type Description
accountName
path True
  • string

Nazwa konta bazy danych Cosmos DB.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True
  • string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

Regex pattern: ^[-\w\._\(\)]+$

roleDefinitionId
path True
  • string

Identyfikator GUID definicji roli.

subscriptionId
path True
  • string

Identyfikator subskrypcji docelowej.

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Name Type Description
200 OK

Definicja roli została pomyślnie pobrana.

Other Status Codes

Odpowiedź na błąd z opisem przyczyny niepowodzenia operacji.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

CosmosDBSqlRoleDefinitionGet

Sample Request

GET https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId?api-version=2021-03-01-preview

Sample Response

{
  "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId",
  "name": "myRoleDefinitionId",
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create",
          "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read"
        ],
        "notDataActions": []
      }
    ]
  }
}

Definicje

CloudError

Odpowiedź na błąd z usługi.

ErrorResponse

Odpowiedź na błąd.

Permission

Zestaw operacji płaszczyzny danych dozwolonych za pomocą tej definicji roli.

RoleDefinitionType

Wskazuje, czy definicja roli była wbudowana czy utworzona przez użytkownika.

SqlRoleDefinitionGetResults

Azure Cosmos DB definicję roli SQL.

CloudError

Odpowiedź na błąd z usługi.

Name Type Description
error

Odpowiedź na błąd.

ErrorResponse

Odpowiedź na błąd.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Komunikat o błędzie informujący o tym, dlaczego operacja nie powiodła się.

Permission

Zestaw operacji płaszczyzny danych dozwolonych za pomocą tej definicji roli.

Name Type Description
dataActions
  • string[]

Tablica akcji danych, które są dozwolone.

notDataActions
  • string[]

Tablica akcji danych, które są odrzucane.

RoleDefinitionType

Wskazuje, czy definicja roli była wbudowana czy utworzona przez użytkownika.

Name Type Description
BuiltInRole
  • string
CustomRole
  • string

SqlRoleDefinitionGetResults

Azure Cosmos DB definicję roli SQL.

Name Type Description
id
  • string

Unikatowy identyfikator zasobu konta bazy danych.

name
  • string

Nazwa konta bazy danych.

properties.assignableScopes
  • string[]

Zestaw w pełni kwalifikowanych zakresów w lub poniżej, które przypisania ról można utworzyć przy użyciu tej definicji roli. Umożliwi to zastosowanie tej definicji roli na całym koncie bazy danych lub w źródłowej bazie danych/kolekcji. Musi mieć co najmniej jeden element. Nie można wymusić zakresów wyższych niż konto bazy danych jako zakresów, które można przypisać. Należy zauważyć, że zasoby, do których odwołuje się zakresy, które można przypisać, nie muszą istnieć.

properties.permissions

Zestaw operacji dozwolonych za pomocą tej definicji roli.

properties.roleName
  • string

Przyjazna dla użytkownika nazwa definicji roli. Musi być unikatowa dla konta bazy danych.

properties.type

Wskazuje, czy definicja roli była wbudowana czy utworzona przez użytkownika.

type
  • string

Typ zasobu platformy Azure.