SqlResources2 - Get Sql Role Definition

Načte vlastnosti existující definice role Azure Cosmos DB SQL s daným ID.

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

Parametry identifikátoru URI

Name In Required Type Description
accountName
path True
  • string

Cosmos DB název databázového účtu.

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

resourceGroupName
path True
  • string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

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

roleDefinitionId
path True
  • string

Identifikátor GUID definice role

subscriptionId
path True
  • string

ID cílového předplatného

api-version
query True
  • string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Type Description
200 OK

Definice role se úspěšně načetla.

Other Status Codes

Chybová odezva popisující, proč se operace nezdařila

Zabezpečení

azure_auth

Azure Active Directory tok OAuth2

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

Scopes

Name Description
user_impersonation Zosobnění uživatelského účtu

Příklady

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

Definice

CloudError

Odpověď na chybu od služby.

ErrorResponse

Chybná odpověď.

Permission

Sada operací roviny dat povolená prostřednictvím této definice role.

RoleDefinitionType

Určuje, jestli byla definice role předdefinovaná nebo vytvořená uživatelem.

SqlRoleDefinitionGetResults

Azure Cosmos DB definice role SQL

CloudError

Odpověď na chybu od služby.

Name Type Description
error

Chybná odpověď.

ErrorResponse

Chybná odpověď.

Name Type Description
code
  • string

Kód chyby

message
  • string

Chybová zpráva indikující, proč se operace nezdařila.

Permission

Sada operací roviny dat povolená prostřednictvím této definice role.

Name Type Description
dataActions
  • string[]

Pole datových akcí, které jsou povoleny.

notDataActions
  • string[]

Pole datových akcí, které jsou odepřeny.

RoleDefinitionType

Určuje, jestli byla definice role předdefinovaná nebo vytvořená uživatelem.

Name Type Description
BuiltInRole
  • string
CustomRole
  • string

SqlRoleDefinitionGetResults

Azure Cosmos DB definice role SQL

Name Type Description
id
  • string

Jedinečný identifikátor prostředku databázového účtu.

name
  • string

Název databázového účtu.

properties.assignableScopes
  • string[]

Sada plně kvalifikovaných oborů na nebo pod kterou může být vytvořeno přiřazení rolí pomocí této definice role. To umožní použití této definice role v celém databázovém účtu nebo v jakékoli podkladové databázi či kolekci. Musí mít alespoň jeden element. Rozsahy vyšší než databázový účet není možné vymáhat jako přiřazovatelné obory. Upozorňujeme, že prostředky odkazované v přidaných oborech nemusí existovat.

properties.permissions

Sada operací povolených prostřednictvím této definice role.

properties.roleName
  • string

Uživatelsky přívětivý název definice role. Musí být pro databázový účet jedinečný.

properties.type

Určuje, jestli byla definice role předdefinovaná nebo vytvořená uživatelem.

type
  • string

Typ prostředku Azure.