搭配適用於 NoSQL 的 Azure Cosmos DB 使用控制平面角色型訪問控制

發行項
10/22/2024

適用於：NoSQL

部署指南順序中目前位置（『角色型存取控制』）的圖表。

本文將逐步解說授與身分識別存取權，以管理適用於 NoSQL 的 Azure Cosmos DB 帳戶及其資源。

重要

本文中的步驟只涵蓋控制平面存取，以在帳戶階層中的任何資源本身執行作業。若要瞭解如何管理數據平面的專案和執行查詢，請參閱授與數據平面角色型存取。

必要條件

具有有效訂用帳戶的 Azure 帳戶。免費建立帳戶。
現有的 Azure Cosmos DB 帳戶。
Microsoft Entra ID 中的一或多個現有身分識別。

在 Azure Cloud Shell 中使用 Bash 環境。如需詳細資訊，請參閱 Azure Cloud Shell 中的 Bash 快速入門。
若要在本地執行 CLI 參考命令，請安裝 Azure CLI。若您在 Windows 或 macOS 上執行，請考慮在 Docker 容器中執行 Azure CLI。如需詳細資訊，請參閱〈如何在 Docker 容器中執行 Azure CLI〉。
- 如果您使用的是本機安裝，請使用 az login 命令，透過 Azure CLI 來登入。請遵循您終端機上顯示的步驟，完成驗證程序。如需其他登入選項，請參閱使用 Azure CLI 登入。
- 出現提示時，請在第一次使用時安裝 Azure CLI 延伸模組。如需擴充功能詳細資訊，請參閱使用 Azure CLI 擴充功能。
- 執行 az version 以尋找已安裝的版本和相依程式庫。若要升級至最新版本，請執行 az upgrade。

如果您選擇在本機使用 Azure PowerShell：
- 安裝最新版的 Az PowerShell 模組。
- 使用 Connect-AzAccount Cmdlet 連線至 Azure 帳戶。
如果您選擇使用 Azure Cloud Shell：
- 請參閱 Azure Cloud Shell 概觀以取得詳細資訊。

準備角色定義

首先，您必須準備角色定義，並列出 actions ，以授與存取權以管理 Azure Cosmos DB 中的帳戶資源。

內建定義
自訂定義

使用 az role definition list列出與您的 Azure Cosmos DB 帳戶相關聯的所有角色定義。檢閱輸出，並找出名為 Cosmos DB內建數據參與者的角色定義。輸出包含屬性中 id 角色定義的唯一標識碼。請記錄此值，因為本指南稍後必須在指派步驟中使用。

az role definition list \
    --name "Cosmos DB Operator"

[
  {
    "assignableScopes": [
      "/"
    ],
    "description": "Lets you manage Azure Cosmos DB accounts, but not access data in them. Prevents access to account keys and connection strings.",
    "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/providers/Microsoft.Authorization/roleDefinitions/230815da-be43-4aae-9cb4-875f7bd000aa",
    "name": "230815da-be43-4aae-9cb4-875f7bd000aa",
    "permissions": [
      {
        "actions": [
          "Microsoft.DocumentDb/databaseAccounts/*",
          "Microsoft.Insights/alertRules/*",
          "Microsoft.Authorization/*/read",
          "Microsoft.ResourceHealth/availabilityStatuses/read",
          "Microsoft.Resources/deployments/*",
          "Microsoft.Resources/subscriptions/resourceGroups/read",
          "Microsoft.Support/*",
          "Microsoft.Network/virtualNetworks/subnets/joinViaServiceEndpoint/action"
        ],
        "condition": null,
        "conditionVersion": null,
        "dataActions": [],
        "notActions": [
          "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs/*",
          "Microsoft.DocumentDB/databaseAccounts/readonlyKeys/*",
          "Microsoft.DocumentDB/databaseAccounts/regenerateKey/*",
          "Microsoft.DocumentDB/databaseAccounts/listKeys/*",
          "Microsoft.DocumentDB/databaseAccounts/listConnectionStrings/*",
          "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions/write",
          "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions/delete",
          "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments/write",
          "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments/delete",
          "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions/write",
          "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions/delete",
          "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions/write",
          "Microsoft.DocumentDB/databaseAccounts/mongodbUserDefinitions/delete"
        ],
        "notDataActions": []
      }
    ],
    "roleName": "Cosmos DB Operator",
    "roleType": "BuiltInRole",
    "type": "Microsoft.Authorization/roleDefinitions",
  }
]

注意

在此範例中，id 值會是 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/providers/Microsoft.Authorization/roleDefinitions/230815da-be43-4aae-9cb4-875f7bd000aa。此範例會使用虛構的數據，而且您的標識符會與這個範例不同。不過，在 Azure 中的所有角色定義中，標識碼（230815da-be43-4aae-9cb4-875f7bd000aa）在全域上是唯一的。

登入 Azure 入口網站 (https://portal.azure.com)。
在全域搜尋列中輸入 資源群組 。
在 [服務] 中，選取 [資源群組]。
在 [ 資源群組] 窗格中，選取現有的資源群組。

注意

此範例螢幕快照包含 msdocs-identity-example 資源群組。您的實際資源組名可能不同。
在資源群組的窗格中，選取 服務功能表中的 [存取控制][IAM ]。
在 [ 訪問控制（IAM）] 窗格中，選取 [ 角色]。
在 [角色] 區段中，使用搜尋詞組 Cosmos DB 並找出 Cosmos DB 操作員角色定義。然後，選取與該定義相關聯的 [ 檢視] 選項。
在 [ Cosmos DB 操作員 角色定義] 對話框中，觀察指派為此角色定義一部分的動作。
關閉 [ Cosmos DB 操作員 角色定義] 對話方塊。

使用 Get-AzRoleDefinition 列出與您的 Azure Cosmos DB 帳戶相關聯的所有角色定義。檢閱輸出，並找出名為 Cosmos DB內建數據參與者的角色定義。輸出包含屬性中 Id 角色定義的唯一標識碼。請記錄此值，因為本指南稍後必須在指派步驟中使用。

$parameters = @{
    Name = "Cosmos DB Operator"
}
Get-AzRoleDefinition @parameters

Name             : Cosmos DB Operator
Id               : 230815da-be43-4aae-9cb4-875f7bd000aa
IsCustom         : False
Description      : Lets you manage Azure Cosmos DB accounts, but not access data in them. Prevents access to account keys and connection strings.
Actions          : {Microsoft.DocumentDb/databaseAccounts/*, Microsoft.Insights/alertRules/*, Microsoft.Authorization/*/read, Microsoft.ResourceHealth/availabilityStatuses/read…}
NotActions       : {Microsoft.DocumentDB/databaseAccounts/dataTransferJobs/*, Microsoft.DocumentDB/databaseAccounts/readonlyKeys/*, Microsoft.DocumentDB/databaseAccounts/regenerateKey/*, Microsoft.DocumentDB/databaseAccounts/listKeys/*…}
DataActions      : {}
NotDataActions   : {}
AssignableScopes : {/}

注意

在此範例中，Id 值會是 230815da-be43-4aae-9cb4-875f7bd000aa。標識元在 Azure 中的所有角色定義中都是全域唯一的。

使用 az group show 取得目前資源群組的元數據。

az group show \
    --name "<name-of-existing-resource-group>"

觀察上一個命令的輸出。記錄此資源群組的 id 屬性值，因為下一個步驟需要使用此屬性。
```
{
  "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example",
  "location": "westus",
  "name": "msdocs-identity-example",
  "type": "Microsoft.Resources/resourceGroups"
}
```
注意

在此範例中，id 值會是 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example。此範例會使用虛構的數據，而且您的標識符會與這個範例不同。這是輸出的截斷範例。
建立名為 role-definition.json 的新 JSON 檔案。在檔案中，建立此資源定義，以指定此處所列的值。 AssignableScopes針對清單，新增id上一個步驟中記錄之資源群組的屬性。
```
{
  "Name": "Azure Cosmos DB Control Plane Owner",
  "IsCustom": true,
  "Description": "Can perform all control plane actions for an Azure Cosmos DB account.",
  "Actions": [
    "Microsoft.DocumentDb/*"
  ],
  "AssignableScopes": [
    "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example"
  ]
}
```
注意

這個範例會使用 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example 從上一個步驟記錄的值。您的實際資源標識碼可能不同。
使用 az role definition create建立新的角色定義。 使用 role-definition.json 檔案作為自變數的--role-definition輸入。
```
az role definition create \
    --role-definition role-definition.json
```

檢閱定義建立命令的輸出。輸出包含屬性中 id 角色定義的唯一標識碼。請記錄此值，因為本指南稍後必須在指派步驟中使用。

{
  "assignableScopes": [
    "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example"
  ],
  "description": "Can perform all control plane actions for an Azure Cosmos DB account.",
  "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleDefinitions/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0",
  "name": "e4e4e4e4-ffff-aaaa-bbbb-c5c5c5c5c5c5",
  "permissions": [
    {
      "actions": [
        "Microsoft.DocumentDb/*"
      ]
    }
  ],
  "roleName": "Azure Cosmos DB Control Plane Owner",
  "roleType": "CustomRole"
}

注意

在此範例中，id 值會是 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleDefinitions/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0。此範例會使用虛構的數據，而且您的標識符會與這個範例不同。這是從部署輸出的一般 JSON 子集，為了清楚起見。

建立新的 Bicep 檔案來定義您的角色定義。將檔案 命名為 control-plane-role-definition.bicep。將這些內容 actions 新增至定義：

	描述
*`Microsoft.DocumentDb/`**	啟用所有可能的動作。

metadata description = 'Create RBAC definition for control plane access to Azure Cosmos DB.'

@description('Name of the role definition.')
param roleDefinitionName string = 'Azure Cosmos DB Control Plane Owner'

@description('Description of the role definition.')
param roleDefinitionDescription string = 'Can perform all control plane actions for an Azure Cosmos DB account.'

resource definition 'Microsoft.Authorization/roleDefinitions@2022-04-01' = {
  name: guid(subscription().id, resourceGroup().id, roleDefinitionName)
  scope: resourceGroup()
  properties: {
    roleName: roleDefinitionName
    description: roleDefinitionDescription
    type: 'CustomRole'
    permissions: [
      {
        actions: [
          'Microsoft.DocumentDb/*'
        ]
      }
    ]
    assignableScopes: [
      resourceGroup().id
    ]
  }
}

output definitionId string = definition.id

使用 az deployment group create 部署 Bicep 範本。指定 Bicep 範本和 Azure 資源群組的名稱。

az deployment group create \
    --resource-group "<name-of-existing-resource-group>" \
    --template-file control-plane-role-definition.bicep

檢閱部署的輸出。輸出包含屬性中 properties.outputs.definitionId.value 角色定義的唯一標識碼。請記錄此值，因為本指南稍後必須在指派步驟中使用。
```
{
  "properties": {
    "outputs": {
      "definitionId": {
        "type": "String",
        "value": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleDefinitions/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0"
      }
    }
  }
}
```
注意

在此範例中，id 值會是 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleDefinitions/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0。此範例會使用虛構的數據，而且您的標識符會與這個範例不同。這是從部署輸出的一般 JSON 子集，為了清楚起見。

在 [訪問控制（IAM）] 窗格中，選取 [新增]，然後選取 [新增自定義角色]。
在 [ 基本] 窗格中，設定下列選項，然後選取 [ 下一步]：

值

自訂角色名稱 Azure Cosmos DB Control Plane Owner

說明 Can perform all control plane actions for an Azure Cosmos DB account.

基準許可權 從頭開始
在 [ 許可權] 窗格中，選取 [ 新增許可權]。然後，在 [許可權] 對話框中搜尋 DocumentDB 。最後，選取 [Microsoft.DocumentDB] 選項。
在 [許可權] 對話框中，選取的所有動作Microsoft.DocumentDB。然後，選取 [ 新增 ] 以返回 [許可權] 窗格。
回到 [ 許可權] 窗格中，觀察許可權清單。然後，選取 [檢閱 + 建立]。
在 [ 檢閱 + 建立] 窗格中，檢閱新角色定義的指定選項。最後，選取 [建立]。
等候入口網站完成建立角色定義。

	值
自訂角色名稱	`Azure Cosmos DB Control Plane Owner`
說明	`Can perform all control plane actions for an Azure Cosmos DB account.`
基準許可權	從頭開始

使用 Get-AzResourceGroup 取得目前資源群組的元數據。

$parameters = @{
    Name = "<name-of-existing-resource-group>"
}
Get-AzResourceGroup @parameters

觀察上一個命令的輸出。記錄此資源群組的 ResourceId 屬性值，因為下一個步驟需要使用此屬性。
```
ResourceGroupName : msdocs-identity-example
Location          : westus
ProvisioningState : Succeeded
ResourceId        : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example
```
注意

在此範例中，ResourceId 值會是 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example。此範例會使用虛構的數據，而且您的標識符會與這個範例不同。這是一般輸出的截斷範例。

首先，匯入 Az.Resources 模組。然後，建立新的 Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition 物件。在物件中，建立此資源定義，以指定這裡所列的值。 AssignableScopes針對清單，新增ResourceId上一個步驟中記錄之資源群組的屬性。最後，使用角色定義物件做為參數的-RoleNew-AzRoleDefinition輸入。

Import-Module Az.Resources

$parameters = @{
    TypeName = "Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition"
    Property = @{
        Name = "Azure Cosmos DB Control Plane Owner"
        Description = "Can perform all control plane actions for an Azure Cosmos DB account."
        IsCustom = $true
        Actions = @(
            "Microsoft.DocumentDb/*"
        )
        AssignableScopes = @(
            "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example"
        )
    }
}
$role = New-Object @parameters

New-AzRoleDefinition -Role $role

注意

這個範例會使用 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example 從上一個步驟記錄的值。您的實際資源標識碼可能不同。

檢閱定義建立命令的輸出。輸出包含屬性中 Name 角色定義的唯一標識碼。請記錄此值，因為本指南稍後必須在指派步驟中使用。

Name             : Azure Cosmos DB Control Plane Owner
Id               : e4e4e4e4-ffff-aaaa-bbbb-c5c5c5c5c5c5
IsCustom         : True
Description      : Can perform all control plane actions for an Azure Cosmos DB account.
Actions          : {Microsoft.DocumentDb/*}
AssignableScopes : {/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example}

注意

在此範例中，Name 值會是 Azure Cosmos DB Control Plane Owner。這是部署一般輸出的子集，為了清楚起見。

將角色指派給身分識別

現在，將新定義的角色指派給身分識別，讓您的應用程式可以存取 Azure Cosmos DB 中的資源。

重要

此指派工作會要求您已經有您想要授與角色型訪問控制許可權之任何身分識別的唯一標識符。

使用 az group show 再次取得目前資源群組的元數據。

az group show \
    --name "<name-of-existing-resource-group>"

觀察上一個命令的輸出。記錄此資源群組的 id 屬性值，因為下一個步驟需要使用此屬性。
```
{
  "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example",
  "location": "westus",
  "name": "msdocs-identity-example",
  "type": "Microsoft.Resources/resourceGroups"
}
```
注意

在此範例中，id 值會是 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example。此範例會使用虛構的數據，而且您的標識符會與這個範例不同。這是輸出的截斷範例。
使用 az role assignment create指派新角色。使用資源群組的自變數標識碼 --scope 、自變數的角色標識碼 -role ，以及您身分識別的唯一標識碼至 --assignee 自變數。
```
az role assignment create \
    --assignee "<your-principal-identifier>" \
    --role "subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleDefinitions/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0" \
    --scope "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example"
```
注意

在此範例命令中， scope 已設定為上一個步驟範例中的虛構範例 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example 。您的資源群組標識碼會與這個範例不同。 role也設定為虛構/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleDefinitions/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0的。同樣地，您的角色識別碼會是不同的。

觀察命令的輸出。輸出包含屬性中 id 指派的唯一標識碼。

{
  "id": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleAssignments/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0",
  "name": "ffffffff-5555-6666-7777-aaaaaaaaaaaa",
  "principalId": "aaaaaaaa-bbbb-cccc-1111-222222222222",
  "resourceGroup": "msdocs-identity-example",
  "roleDefinitionId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleDefinitions/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0",
  "scope": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example",
  "type": "Microsoft.Authorization/roleAssignments"
}

注意

在此範例中 id ，屬性是 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleAssignments/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0 另一個虛構範例。

重複這些步驟，從您想要使用的任何其他身分識別授與帳戶的存取權。

提示

您可以針對您想要的身分識別重複這些步驟。一般而言，這些步驟至少會重複執行，以允許開發人員使用其人為身分識別存取帳戶，並允許應用程式使用受控識別進行存取。

建立新的 Bicep 檔案，以定義您的角色指派。將檔案 命名為 control-plane-role-assignment.bicep。

metadata description = 'Assign RBAC role for control plane access to Azure Cosmos DB.'

@description('Id of the role definition to assign to the targeted principal in the context of the account.')
param roleDefinitionId string

@description('Id of the identity/principal to assign this role in the context of the account.')
param identityId string

resource assignment 'Microsoft.Authorization/roleAssignments@2022-04-01' = {
  name: guid(subscription().id, resourceGroup().id, roleDefinitionId, identityId)
  scope: resourceGroup()
  properties: {
    roleDefinitionId: roleDefinitionId
    principalId: identityId
  }
}

建立名為 control-plane-role-assignment 的新 Bicep 參數檔案。bicepparam 在此參數檔案中;將先前記錄的角色定義標識碼指派給 roleDefinitionId 參數，並將您身分識別的唯一標識符指派給 identityId 參數。
```
using './control-plane-role-assignment.bicep'

param roleDefinitionId = '<id-of-new-role-definition>'
param identityId = '<id-of-existing-identity>'
```

使用 az deployment group create部署此 Bicep 範本。

az deployment group create \
    --resource-group "<name-of-existing-resource-group>" \
    --parameters control-plane-role-assignment.bicepparam \
    --template-file control-plane-role-assignment.bicep

重複這些步驟，從您想要使用的任何其他身分識別授與帳戶的存取權。

提示

您可以針對您想要的身分識別重複這些步驟。一般而言，這些步驟至少會重複執行，以允許開發人員使用其人為身分識別存取帳戶，並允許應用程式使用受控識別進行存取。

在 [訪問控制（IAM）] 窗格中，選取 [新增]，然後選取 [新增角色指派]。
在 [ 角色] 窗格中，搜尋 Azure Cosmos DB ，然後選取本指南稍早建立的 Azure Cosmos DB 控制平面擁有者 角色。然後選取下一步。

提示

您可以選擇性地篩選角色清單，只包含自定義角色。
在 [ 成員] 窗格中，選取 [ 選取成員] 選項。在 [成員] 對話框中，選取您想要為 Azure Cosmos DB 帳戶授與此層級存取權的身分識別，然後使用 [ 選取 ] 選項來確認您的選擇。

注意

此螢幕擷取畫面說明一個名為 "Kai Carter" 且主體為 kai@adventure-works.com 的範例使用者。
回到 [ 成員 ] 窗格中，檢閱選取的成員[s]，然後選取 [ 檢閱 + 指派]。
在 [ 檢閱 + 指派 ] 窗格中，檢閱新角色指派的指定選項。最後，選取 [檢閱 + 指派]。
等候入口網站完成角色指派的建立。

使用 New-AzRoleAssignment指派新角色。將角色的名稱用於 RoleDefinitionName 參數，並將您身分識別的唯一標識碼用於 ObjectId 參數。

$parameters = @{
    ResourceGroupName = "<name-of-existing-resource-group>"
    ObjectId = "<your-principal-identifier>"
    RoleDefinitionName = "Azure Cosmos DB Control Plane Owner"
}
New-AzRoleAssignment @parameters

觀察命令的輸出。輸出包含屬性中 RoleAssignmentId 指派的唯一標識碼。

RoleAssignmentName : ffffffff-5555-6666-7777-aaaaaaaaaaaa
RoleAssignmentId   : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleAssignments/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0
Scope              : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example
DisplayName        : Kai Carter
SignInName         : <kai@adventure-works.com>
RoleDefinitionName : Azure Cosmos DB Control Plane Owner
RoleDefinitionId   : e4e4e4e4-ffff-aaaa-bbbb-c5c5c5c5c5c5

注意

在此範例中 RoleAssignmentId ，屬性是 /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/msdocs-identity-example/providers/Microsoft.Authorization/roleAssignments/ffffffff-eeee-dddd-cccc-bbbbbbbbbbb0 另一個虛構範例。這是部署一般輸出的子集，為了清楚起見。

重複這些步驟，從您想要使用的任何其他身分識別授與帳戶的存取權。

提示

您可以針對您想要的身分識別重複這些步驟。一般而言，這些步驟至少會重複執行，以允許開發人員使用其人為身分識別存取帳戶，並允許應用程式使用受控識別進行存取。

驗證程式代碼中的控制平面存取

最後，使用您慣用的程式設計語言使用應用程式程式代碼和 Azure 管理 SDK，驗證您是否已正確授與存取權。

using Azure.Identity;
using Azure.ResourceManager;

DefaultAzureCredential credential = new();

ArmClient client = new(credential);

重要

此程式代碼範例會使用 NuGet 中的 Azure.ResourceManager.CosmosDB 和 Azure.Identity 連結庫。

const { CosmosDBManagementClient } = require('@azure/arm-cosmosdb');
const { DefaultAzureCredential } = require('@azure/identity');

const subscriptionId = "<subscription-id>";

const credential = new DefaultAzureCredential();

const client = new CosmosDBManagementClient(credential, subscriptionId);

重要

此程式代碼範例會使用來自 npm 的 @azure/arm-cosmosdb 和 @azure/identity 連結庫。

import { CosmosDBManagementClient } from '@azure/arm-cosmosdb';
import { TokenCredential, DefaultAzureCredential } from '@azure/identity';

let subscriptionId: string = "<subscription-id>";

let credential: TokenCredential = new DefaultAzureCredential();

const client: CosmosDBManagementClient = new CosmosDBManagementClient(credential, subscriptionId);

重要

此程式代碼範例會使用來自 npm 的 @azure/arm-cosmosdb 和 @azure/identity 連結庫。

from azure.mgmt.cosmosdb import CosmosDBManagementClient
from azure.identity import DefaultAzureCredential

subscription_id = "<subscription-id>"

credential = DefaultAzureCredential()

client = CosmosDBManagementClient(credential=credential, subscription=subscription_id)

重要

此程式代碼範例會使用 PyPI 中的 azure-mgmt-cosmosdb 和 azure-identity 連結庫。

package main

import (
    "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
    "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos"
)

const subscriptionId = "<subscription-id>"

func main() {
    credential, _ := azidentity.NewDefaultAzureCredential(nil)
    
    client, _ := armcosmos.NewDatabaseClient(subscriptionId, credential, nil)
}

重要

此程式代碼範例會使用 Go 中的 azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos 和 azure/azure-sdk-for-go/sdk/azidentity 連結庫。

package com.example;

import com.azure.core.management.profile.AzureProfile;
import com.azure.core.management.AzureEnvironment;
import com.azure.identity.DefaultAzureCredential;
import com.azure.identity.DefaultAzureCredentialBuilder;
import com.azure.resourcemanager.cosmos.CosmosManager;

public class CosmosDB {
    public static void main(String[] args) {
        AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
        DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
          .build();

        CosmosManager manager = CosmosManager.authenticate(credential, profile);
    }
}

重要

此程式代碼範例會使用 Maven 中的 com.azure.resourcemanager/azure-resourcemanager-cosmos 和 com.azure/azure-identity 連結庫。

後續步驟

授與身分識別數據平面角色型存取權

共用方式為