Sql Resources - Create Update Sql Role Definition

Referensi

Service:: Cosmos DB Resource Provider

API Version:: 2021-04-01-preview

Membuat atau memperbarui Definisi Peran SQL Azure Cosmos DB.

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

Parameter URI

Name	In	Required	Type	Description
accountName	path	True	string	Nama akun database Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
roleDefinitionId	path	True	string	GUID untuk Definisi Peran.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name	Type	Description
properties.assignableScopes	string[]	Sekumpulan Cakupan yang sepenuhnya memenuhi syarat di atau di bawah penetapan peran mana yang dapat dibuat menggunakan Definisi Peran ini. Ini akan memungkinkan penerapan Definisi Peran ini pada seluruh akun database atau Database / Koleksi yang mendasar. Harus memiliki setidaknya satu elemen. Cakupan yang lebih tinggi dari akun Database tidak dapat diberlakukan sebagai Cakupan yang dapat ditetapkan. Perhatikan bahwa sumber daya yang dirujuk dalam Cakupan yang dapat ditetapkan tidak perlu ada.
properties.permissions	Permission[]	Kumpulan operasi yang diizinkan melalui Definisi Peran ini.
properties.roleName	string	Nama yang mudah digunakan untuk Definisi Peran. Harus unik untuk akun database.
properties.type	RoleDefinitionType	Menunjukkan apakah Definisi Peran adalah bawaan atau pengguna yang dibuat.

Respons

Name	Type	Description
200 OK	SqlRoleDefinitionGetResults	Operasi pembuatan atau pembaruan Definisi Peran berhasil diselesaikan.
202 Accepted		Permintaan pembuatan atau pembaruan Definisi Peran diterima dan akan selesai secara asinkron.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name	Description
user_impersonation	Meniru akun pengguna Anda

Contoh

CosmosDBSqlRoleDefinitionCreateUpdate

Sample Request

HTTP

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

{
  "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

Status code:: 200

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

Status code:: 202

Definisi

CloudError	Respons kesalahan dari layanan.
ErrorResponse	Respons Kesalahan.
Permission	Kumpulan operasi sarana data yang diizinkan melalui Definisi Peran ini.
RoleDefinitionType	Menunjukkan apakah Definisi Peran adalah bawaan atau pengguna yang dibuat.
SqlRoleDefinitionCreateUpdateParameters	Parameter untuk membuat dan memperbarui Definisi Peran SQL Azure Cosmos DB.
SqlRoleDefinitionGetResults	Definisi Peran SQL Azure Cosmos DB.

CloudError

Respons kesalahan dari layanan.

Name	Type	Description
error	ErrorResponse	Respons Kesalahan.

ErrorResponse

Respons Kesalahan.

Name	Type	Description
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

Permission

Kumpulan operasi sarana data yang diizinkan melalui Definisi Peran ini.

Name	Type	Description
dataActions	string[]	Array tindakan data yang diizinkan.
notDataActions	string[]	Array tindakan data yang ditolak.

RoleDefinitionType

Menunjukkan apakah Definisi Peran adalah bawaan atau pengguna yang dibuat.

Name	Type	Description
BuiltInRole	string
CustomRole	string

SqlRoleDefinitionCreateUpdateParameters

Parameter untuk membuat dan memperbarui Definisi Peran SQL Azure Cosmos DB.

Name	Type	Description
properties.assignableScopes	string[]	Sekumpulan Cakupan yang sepenuhnya memenuhi syarat di atau di bawah penetapan peran mana yang dapat dibuat menggunakan Definisi Peran ini. Ini akan memungkinkan penerapan Definisi Peran ini pada seluruh akun database atau Database / Koleksi yang mendasar. Harus memiliki setidaknya satu elemen. Cakupan yang lebih tinggi dari akun Database tidak dapat diberlakukan sebagai Cakupan yang dapat ditetapkan. Perhatikan bahwa sumber daya yang dirujuk dalam Cakupan yang dapat ditetapkan tidak perlu ada.
properties.permissions	Permission[]	Kumpulan operasi yang diizinkan melalui Definisi Peran ini.
properties.roleName	string	Nama yang mudah digunakan untuk Definisi Peran. Harus unik untuk akun database.
properties.type	RoleDefinitionType	Menunjukkan apakah Definisi Peran adalah bawaan atau pengguna yang dibuat.

SqlRoleDefinitionGetResults

Definisi Peran SQL Azure Cosmos DB.

Name	Type	Description
id	string	Pengidentifikasi sumber daya unik akun database.
name	string	Nama akun database.
properties.assignableScopes	string[]	Sekumpulan Cakupan yang sepenuhnya memenuhi syarat di atau di bawah penetapan peran mana yang dapat dibuat menggunakan Definisi Peran ini. Ini akan memungkinkan penerapan Definisi Peran ini pada seluruh akun database atau Database / Koleksi yang mendasar. Harus memiliki setidaknya satu elemen. Cakupan yang lebih tinggi dari akun Database tidak dapat diberlakukan sebagai Cakupan yang dapat ditetapkan. Perhatikan bahwa sumber daya yang dirujuk dalam Cakupan yang dapat ditetapkan tidak perlu ada.
properties.permissions	Permission[]	Kumpulan operasi yang diizinkan melalui Definisi Peran ini.
properties.roleName	string	Nama yang mudah digunakan untuk Definisi Peran. Harus unik untuk akun database.
properties.type	RoleDefinitionType	Menunjukkan apakah Definisi Peran adalah bawaan atau pengguna yang dibuat.
type	string	Jenis sumber daya Azure.