SqlResources2 - List Sql Role Definitions

Ruft die Liste aller Azure Cosmos DB SQL-Rollendefinitionen ab.

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

URI-Parameter

Name In Required Type Description
accountName
path True
  • string

Cosmos Datenbankkontoname.

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

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True
  • string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True
  • string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Type Description
200 OK

Der Listenvorgang wurde erfolgreich abgeschlossen.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow

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

Scopes

Name Description
user_impersonation Identität Ihres Benutzerkontos imitieren

Beispiele

CosmosDBSqlRoleDefinitionList

Sample Request

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

Sample Response

{
  "value": [
    {
      "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": []
          }
        ]
      }
    }
  ]
}

Definitionen

CloudError

Eine Fehlerantwort vom Dienst.

ErrorResponse

Fehlerantwort.

Permission

Der Satz von Datenebenenvorgängen, die über diese Rollendefinition zulässig sind.

RoleDefinitionType

Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde.

SqlRoleDefinitionGetResults

Eine Azure Cosmos DB SQL-Rollendefinition.

SqlRoleDefinitionListResult

Die relevanten Rollendefinitionen.

CloudError

Eine Fehlerantwort vom Dienst.

Name Type Description
error

Fehlerantwort.

ErrorResponse

Fehlerantwort.

Name Type Description
code
  • string

Fehlercode

message
  • string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

Permission

Der Satz von Datenebenenvorgängen, die über diese Rollendefinition zulässig sind.

Name Type Description
dataActions
  • string[]

Ein Array zulässiger Datenaktionen.

notDataActions
  • string[]

Ein Array von Datenaktionen, die verweigert werden.

RoleDefinitionType

Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde.

Name Type Description
BuiltInRole
  • string
CustomRole
  • string

SqlRoleDefinitionGetResults

Eine Azure Cosmos DB SQL-Rollendefinition.

Name Type Description
id
  • string

Der eindeutige Ressourcenbezeichner des Datenbankkontos.

name
  • string

Der Name des Datenbankkontos.

properties.assignableScopes
  • string[]

Ein Satz vollqualifizierter Bereiche ab oder darunter, unter denen Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder jede zugrunde liegende Datenbank/Sammlung. Muss über mindestens ein Element verfügen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zusetzbare Bereiche erzwungen werden. Beachten Sie, dass ressourcen, auf die in zu weisenden Geltungsbereichen verwiesen wird, nicht vorhanden sein müssen.

properties.permissions

Der Satz von Vorgängen, die für diese Rollendefinition zulässig sind.

properties.roleName
  • string

Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein.

properties.type

Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde.

type
  • string

Der Typ der Azure-Ressource.

SqlRoleDefinitionListResult

Die relevanten Rollendefinitionen.

Name Type Description
value

Liste der Rollendefinitionen und deren Eigenschaften.