SqlResources2 - Create Update Sql Role Definition

Erstellt oder aktualisiert eine Azure Cosmos DB-SQL-Rollendefinition.

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

URI-Parameter

Name In Required Type Description
accountName
path True
  • string

Cosmos Datenbankkontoname der Datenbank.

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.

roleDefinitionId
path True
  • string

Die GUID für die Rollendefinition.

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.

Anforderungstext

Name Type Description
properties.assignableScopes
  • string[]

Eine Gruppe von vollqualifizierten Bereichen unter oder unterhalb derer Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine zugrunde liegende Datenbank/Sammlung. Muss über mindestens ein Element verfügen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisbare Bereiche erzwungen werden. Beachten Sie, dass ressourcen, auf die in zuweisbaren Bereichen verwiesen wird, nicht vorhanden sein müssen.

properties.permissions

Der Satz von Vorgängen, die über 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.

Antworten

Name Type Description
200 OK

Der Vorgang zum Erstellen oder Aktualisieren der Rollendefinition wurde erfolgreich abgeschlossen.

202 Accepted

Die Anforderung zum Erstellen oder Aktualisieren der Rollendefinition wurde akzeptiert und wird asynchron 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 Annehmen der Identität Ihres Benutzerkontos

Beispiele

CosmosDBSqlRoleDefinitionCreateUpdate

Sample Request

PUT https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId?api-version=2021-04-15
{
  "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": []
      }
    ]
  }
}

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"
        ]
      }
    ]
  }
}

Definitionen

CloudError

Eine Fehlerantwort vom Dienst.

ErrorResponse

Fehlerantwort.

Permission

Der Satz von Vorgängen auf Datenebene, die über diese Rollendefinition zulässig sind.

RoleDefinitionType

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

SqlRoleDefinitionCreateUpdateParameters

Parameter zum Erstellen und Aktualisieren einer Azure Cosmos DB-SQL-Rollendefinition.

SqlRoleDefinitionGetResults

Eine Azure Cosmos DB-SQL Rollendefinition.

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 Vorgängen auf Datenebene, 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

SqlRoleDefinitionCreateUpdateParameters

Parameter zum Erstellen und Aktualisieren einer Azure Cosmos DB-SQL-Rollendefinition.

Name Type Description
properties.assignableScopes
  • string[]

Eine Gruppe von vollqualifizierten Bereichen unter oder unterhalb derer Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine zugrunde liegende Datenbank/Sammlung. Muss über mindestens ein Element verfügen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisbare Bereiche erzwungen werden. Beachten Sie, dass ressourcen, auf die in zuweisbaren Bereichen verwiesen wird, nicht vorhanden sein müssen.

properties.permissions

Der Satz von Vorgängen, die über 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.

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[]

Eine Gruppe von vollqualifizierten Bereichen unter oder unterhalb derer Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine zugrunde liegende Datenbank/Sammlung. Muss über mindestens ein Element verfügen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisbare Bereiche erzwungen werden. Beachten Sie, dass ressourcen, auf die in zuweisbaren Bereichen verwiesen wird, nicht vorhanden sein müssen.

properties.permissions

Der Satz von Vorgängen, die über 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.