Mongo MI Resources - Create Update Mongo MI Role Definition

リファレンス

サービス:: Cosmos DB Resource Provider

API バージョン:: 2025-05-01-preview

Azure Cosmos DB MongoMI ロール定義を作成または更新します。

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB データベースアカウント名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
roleDefinitionId	path	True	string	ロール定義の GUID。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	型	説明
properties.assignableScopes	string[]	このロール定義を使用して MongoMI ロールの割り当てを作成できる完全修飾スコープのセット。これにより、データベースアカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。少なくとも 1 つの要素が必要です。データベースアカウントより高いスコープは、割り当て可能なスコープとして適用できません。割り当て可能なスコープで参照されるリソースは存在する必要はありません。
properties.id	string	ロール定義のパス ID。
properties.permissions	Permission[]	このロール定義で許可される操作のセット。
properties.roleName	string	ロール定義のわかりやすい名前。データベースアカウントに対して一意である必要があります。
properties.type	RoleDefinitionType	ロール定義が組み込まれているか、ユーザーが作成されたかを示します。

応答

名前	型	説明
200 OK	MongoMIRoleDefinitionResource	ロール定義の作成または更新操作が正常に完了しました。
202 Accepted		ロール定義の作成または更新要求が受け入れられ、非同期的に完了します。ヘッダー azure-AsyncOperation: string location: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

MongoMIRoleDefinitionResource

ロール定義の作成または更新操作が正常に完了しました。

202 Accepted

ロール定義の作成または更新要求が受け入れられ、非同期的に完了します。

ヘッダー

azure-AsyncOperation: string
location: string

Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

CosmosDBMongoMIRoleDefinitionCreateUpdate

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongoMIRoleDefinitions/myRoleDefinitionId?api-version=2025-05-01-preview

{
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/mongoMIDatabases/containers/entities/create",
          "Microsoft.DocumentDB/databaseAccounts/mongoMIDatabases/containers/entities/read"
        ],
        "notDataActions": []
      }
    ]
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongoMIRoleDefinitions/myRoleDefinitionId",
  "name": "myRoleDefinitionId",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongoMIRoleDefinitions",
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/mongoMIDatabases/containers/entities/create",
          "Microsoft.DocumentDB/databaseAccounts/mongoMIDatabases/containers/entities/read"
        ]
      }
    ]
  }
}

状態コード:: 202

azure-AsyncOperation: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview
location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
MongoMIRoleDefinitionResource	Azure Cosmos DB MongoMI ロール定義を作成および更新するためのパラメーター。
Permission	このロール定義で許可されるデータプレーン操作のセット。
RoleDefinitionType	ロール定義が組み込まれているか、ユーザーが作成されたかを示します。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

MongoMIRoleDefinitionResource

Object

Azure Cosmos DB MongoMI ロール定義を作成および更新するためのパラメーター。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.assignableScopes	string[]	このロール定義を使用して MongoMI ロールの割り当てを作成できる完全修飾スコープのセット。これにより、データベースアカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。少なくとも 1 つの要素が必要です。データベースアカウントより高いスコープは、割り当て可能なスコープとして適用できません。割り当て可能なスコープで参照されるリソースは存在する必要はありません。
properties.id	string	ロール定義のパス ID。
properties.permissions	Permission[]	このロール定義で許可される操作のセット。
properties.roleName	string	ロール定義のわかりやすい名前。データベースアカウントに対して一意である必要があります。
properties.type	RoleDefinitionType	ロール定義が組み込まれているか、ユーザーが作成されたかを示します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

Permission

Object

このロール定義で許可されるデータプレーン操作のセット。

名前	型	説明
dataActions	string[]	許可されるデータアクションの配列。
id	string	アクセス許可の ID。
notDataActions	string[]	拒否されるデータアクションの配列。

RoleDefinitionType

列挙

ロール定義が組み込まれているか、ユーザーが作成されたかを示します。

値	説明
BuiltInRole
CustomRole

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

次の方法で共有

Mongo MI Resources - Create Update Mongo MI Role Definition

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

CosmosDBMongoMIRoleDefinitionCreateUpdate

要求のサンプル

応答のサンプル

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MongoMIRoleDefinitionResource

Permission

RoleDefinitionType

systemData