Set-EntraDirectoryRoleDefinition
既存のMicrosoft Entra ID roleDefinition を更新します。
構文
Default (既定)
Set-EntraDirectoryRoleDefinition
[-TemplateId <String>]
[-DisplayName <String>]
[-RolePermissions <System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RolePermission]>]
-UnifiedRoleDefinitionId <String>
[-Description <String>]
[-Version <String>]
[-IsEnabled <Boolean>]
[-ResourceScopes <System.Collections.Generic.List`1[System.String]>]
[<CommonParameters>]
説明
ID で識別Microsoft Entra roleDefinition オブジェクトを更新します。 組み込みロールを更新することはできません。 この機能には、Microsoft Entra ID P1 または P2 ライセンスが必要です。
委任されたシナリオでは、サインインしているユーザーには、サポートされているMicrosoft Entraロールまたは必要なアクセス許可を持つカスタム ロールが必要です。 この操作に必要な最小ロールは次のとおりです。
- 特権ロール管理者
例
例 1: roleDefinition を更新する
Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -DisplayName 'UpdatedDisplayName'
次の使用例は、Microsoft Entra IDで指定されたロール定義を更新します。
-
-UnifiedRoleDefinitionIdパラメーターは roleDefinition オブジェクト ID を指定します。 -
-DisplayNameパラメーターは、ロール定義の表示名を指定します。
例 2: 説明を使用して roleDefinition を更新する
Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -Description 'MYROLEUPDATE1S'
次の使用例は、Microsoft Entra IDで指定されたロール定義の説明を更新します。
-
-UnifiedRoleDefinitionIdパラメーターは roleDefinition オブジェクト ID を指定します。 -
-Descriptionパラメーターは、ロール定義の説明を指定します。
例 3: IsEnabled を使用して roleDefinition を更新する
Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
Set-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $roleDefinition.Id -IsEnabled $true
次の使用例は、Microsoft Entra IDで指定されたロール定義の IsEnabled を更新します。
-
-UnifiedRoleDefinitionIdパラメーターは roleDefinition オブジェクト ID を指定します。 -
-IsEnabledパラメーターは、ロール定義を有効にするかどうかを指定します。
例 4: roleDefinition を更新する
Connect-Entra -Scopes 'RoleManagement.ReadWrite.Directory'
$roleDefinition = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq '<Role-Definition-Name>'"
$rolePermissions = New-object Microsoft.Open.MSGraph.Model.RolePermission
$rolePermissions.AllowedResourceActions = @("microsoft.directory/applications/standard/read")
$params = @{
UnifiedRoleDefinitionId = $roleDefinition.Id
Description = 'Update'
DisplayName = 'Update'
ResourceScopes = '/'
IsEnabled = $false
RolePermissions = $rolePermissions
TemplateId = 'f2ef992c-3afb-46b9-b7cf-a126ee74c451'
Version = 2
}
Set-EntraDirectoryRoleDefinition @params
次の使用例は、Microsoft Entra IDで指定されたロール定義の RolePermissions、TemplateId、TemplateId、ResourceScopes を更新します。
-
-UnifiedRoleDefinitionIdパラメーターは roleDefinition オブジェクト ID を指定します。 -
-RolePermissionsパラメーターは、ロール定義のアクセス許可を指定します。 -
-IsEnabledパラメーターは、ロール定義を有効にするかどうかを指定します。 -
-DisplayNameパラメーターは、ロール定義の表示名を指定します。 -
-Descriptionパラメーターは、ロール定義の説明を指定します。 -
-ResourceScopesパラメーターは、ロール定義のリソース スコープを指定します。 -
-TemplateIdパラメーターは、ロール定義のテンプレート ID を指定します。 -
-Versionパラメーターは、ロール定義のバージョンを指定します。
パラメーター
-Description
ロール定義の説明を指定します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DisplayName
ロール定義の表示名を指定します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IsEnabled
ロール定義を有効にするかどうかを指定します。 ロールが割り当てに対して有効になっているかどうかを示すフラグ。 false の場合、ロールは割り当てに使用できません。
isBuiltInが true の場合は読み取り専用です。
パラメーターのプロパティ
| 型: | System.Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceScopes
ロール定義のリソース スコープを指定します。
パラメーターのプロパティ
| 型: | System.Collections.Generic.List`1[System.String] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RolePermissions
ロール定義のアクセス許可を指定します。 ロールに含まれるアクセス許可の一覧。
isBuiltInがtrueされている場合は読み取り専用です。
パラメーターのプロパティ
| 型: | System.Collections.Generic.List`1[Microsoft.Open.MSGraph.Model.RolePermission] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TemplateId
ロール定義のテンプレート ID を指定します。 カスタム テンプレート ID は、 isBuiltIn が falseされたときに設定できます。 この ID は通常、異なるディレクトリ間で同じ識別子を保持するために使用されます。
isBuiltInがtrueされている場合は読み取り専用です。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UnifiedRoleDefinitionId
roleDefinition オブジェクト ID を指定します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Id |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Version
ロール定義のバージョンを指定します。 ロール定義のバージョンを示します。
isBuiltInがtrueされている場合は読み取り専用です。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
System.String
出力
System.Object
メモ
Set-EntraRoleDefinition は Set-EntraDirectoryRoleDefintion の別名です。