Role Assignments - Create
スコープと名前でロールの割り当てを作成または更新します。
PUT https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}?api-version=2022-04-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
role
|
path | True |
string |
ロールの割り当ての名前。 任意の有効な GUID を指定できます。 |
|
scope
|
path | True |
string |
リソースの完全資格を持つAzureリソースマネージャー識別子。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| properties.principalId | True |
string |
プリンシパル ID。 |
| properties.roleDefinitionId | True |
string |
ロール定義 ID。 |
| properties.condition |
string |
ロールの割り当ての条件。 これにより割り当てられるリソースが制限されます。例:@Resource[Microsoft。Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' |
|
| properties.conditionVersion |
string |
条件のバージョン。 現在、受け入れ可能な値は '2.0' のみです |
|
| properties.delegatedManagedIdentityResourceId |
string |
委任されたマネージド ID リソースの ID |
|
| properties.description |
string |
ロールの割り当ての説明 |
|
| properties.principalType |
割り当てられたプリンシパル ID のプリンシパルの種類。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
リソース「RoleAssignment」更新操作が成功しました |
|
| 201 Created |
リソース「RoleAssignment」作成操作が成功しました |
|
| Other Status Codes |
予期しないエラー応答。 |
アクセス許可
この API を呼び出すには、次のアクセス許可を持つロールがお客様に割り当てられている必要があります。 詳細については、Azure の組み込みロールに関するページを参照してください。
Microsoft.Authorization/roleAssignments/write
セキュリティ
azure_auth
Azure Active Directory OAuth2 Flow.
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
| Create role assignment for resource |
| Create role assignment for resource group |
| Create role assignment for subscription |
Create role assignment for resource
要求のサンプル
PUT https://management.azure.com/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg/providers/Microsoft.DocumentDb/databaseAccounts/test-db-account/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff?api-version=2022-04-01
{
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d"
}
}
応答のサンプル
{
"name": "05c5a614-a7d6-4502-b150-c2fb455033ff",
"type": "Microsoft.Authorization/roleAssignments",
"id": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg/providers/Microsoft.DocumentDb/databaseAccounts/test-db-account/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff",
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d",
"scope": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg/providers/Microsoft.DocumentDb/databaseAccounts/test-db-account"
}
}
{
"name": "05c5a614-a7d6-4502-b150-c2fb455033ff",
"type": "Microsoft.Authorization/roleAssignments",
"id": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg/providers/Microsoft.DocumentDb/databaseAccounts/test-db-account/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff",
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d",
"scope": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg/providers/Microsoft.DocumentDb/databaseAccounts/test-db-account"
}
}
Create role assignment for resource group
要求のサンプル
PUT https://management.azure.com/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff?api-version=2022-04-01
{
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d"
}
}
応答のサンプル
{
"name": "05c5a614-a7d6-4502-b150-c2fb455033ff",
"type": "Microsoft.Authorization/roleAssignments",
"id": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff",
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d",
"scope": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg"
}
}
{
"name": "05c5a614-a7d6-4502-b150-c2fb455033ff",
"type": "Microsoft.Authorization/roleAssignments",
"id": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff",
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d",
"scope": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/resourceGroups/testrg"
}
}
Create role assignment for subscription
要求のサンプル
PUT https://management.azure.com/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff?api-version=2022-04-01
{
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d"
}
}
応答のサンプル
{
"name": "05c5a614-a7d6-4502-b150-c2fb455033ff",
"type": "Microsoft.Authorization/roleAssignments",
"id": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff",
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d",
"scope": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2"
}
}
{
"name": "05c5a614-a7d6-4502-b150-c2fb455033ff",
"type": "Microsoft.Authorization/roleAssignments",
"id": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2/providers/Microsoft.Authorization/roleAssignments/05c5a614-a7d6-4502-b150-c2fb455033ff",
"properties": {
"principalId": "ce2ce14e-85d7-4629-bdbc-454d0519d987",
"principalType": "User",
"roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/0b5fe924-9a61-425c-96af-cfe6e287ca2d",
"scope": "/subscriptions/a925f2f7-5c63-4b7b-8799-25a5f97bc3b2"
}
}
定義
| 名前 | 説明 |
|---|---|
|
created |
リソースを作成した ID の種類。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Principal |
割り当てられたプリンシパル ID のプリンシパルの種類。 |
|
Role |
ロールの割り当て |
|
Role |
ロールの割り当てによってパラメーターが作成されます。 |
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
PrincipalType
割り当てられたプリンシパル ID のプリンシパルの種類。
| 値 | 説明 |
|---|---|
| User |
User |
| Group |
グループ |
| ServicePrincipal |
サービスプリンシパル |
| ForeignGroup |
フォレイングループ |
| Device |
デバイス |
RoleAssignment
ロールの割り当て
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
| name |
string |
リソースの名前 |
|
| properties.condition |
string |
ロールの割り当ての条件。 これにより割り当てられるリソースが制限されます。例:@Resource[Microsoft。Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' |
|
| properties.conditionVersion |
string |
条件のバージョン。 現在、受け入れ可能な値は '2.0' のみです |
|
| properties.createdBy |
string |
割り当てを作成したユーザーの ID |
|
| properties.createdOn |
string (date-time) |
作成された時刻 |
|
| properties.delegatedManagedIdentityResourceId |
string |
委任されたマネージド ID リソースの ID |
|
| properties.description |
string |
ロールの割り当ての説明 |
|
| properties.principalId |
string |
プリンシパル ID。 |
|
| properties.principalType | User |
割り当てられたプリンシパル ID のプリンシパルの種類。 |
|
| properties.roleDefinitionId |
string |
ロール定義 ID。 |
|
| properties.scope |
string |
ロールの割り当てスコープ。 |
|
| properties.updatedBy |
string |
割り当てを更新したユーザーの ID |
|
| properties.updatedOn |
string (date-time) |
更新された時刻 |
|
| systemData |
create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。 |
||
| type |
string |
リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」 |
RoleAssignmentCreateParameters
ロールの割り当てによってパラメーターが作成されます。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| properties.condition |
string |
ロールの割り当ての条件。 これにより割り当てられるリソースが制限されます。例:@Resource[Microsoft。Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' |
|
| properties.conditionVersion |
string |
条件のバージョン。 現在、受け入れ可能な値は '2.0' のみです |
|
| properties.createdBy |
string |
割り当てを作成したユーザーの ID |
|
| properties.createdOn |
string (date-time) |
作成された時刻 |
|
| properties.delegatedManagedIdentityResourceId |
string |
委任されたマネージド ID リソースの ID |
|
| properties.description |
string |
ロールの割り当ての説明 |
|
| properties.principalId |
string |
プリンシパル ID。 |
|
| properties.principalType | User |
割り当てられたプリンシパル ID のプリンシパルの種類。 |
|
| properties.roleDefinitionId |
string |
ロール定義 ID。 |
|
| properties.scope |
string |
ロールの割り当てスコープ。 |
|
| properties.updatedBy |
string |
割り当てを更新したユーザーの ID |
|
| properties.updatedOn |
string (date-time) |
更新された時刻 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |