New-AzSynapseRoleAssignment
Synapse Analytics ロールの割り当てを作成します。
構文
New-AzSynapseRoleAssignment
-WorkspaceName <String>
-RoleDefinitionName <String>
-SignInName <String>
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseRoleAssignment
-WorkspaceName <String>
-RoleDefinitionName <String>
-ObjectId <String>
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseRoleAssignment
-WorkspaceName <String>
-RoleDefinitionId <String>
-ObjectId <String>
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseRoleAssignment
-WorkspaceName <String>
-RoleDefinitionName <String>
-ServicePrincipalName <String>
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
-RoleDefinitionName <String>
-SignInName <String>
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
-RoleDefinitionName <String>
-ObjectId <String>
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
-RoleDefinitionId <String>
-ObjectId <String>
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzSynapseRoleAssignment
-WorkspaceObject <PSSynapseWorkspace>
-RoleDefinitionName <String>
-ServicePrincipalName <String>
[-ItemType <WorkspaceItemType>]
[-Item <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
New-AzSynapseRoleAssignment コマンドレットは、Azure Synapse Analytics ロールの割り当てを作成します。
このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。
- GET /users/{id}
- GET /servicePrincipals/{id}
Note
サービス プリンシパルのロールの割り当てを作成するには、ObjectId パラメーターでプリンシパルのオブジェクト ID を渡します。 ワークスペースで Azure RBAC ロールの割り当てを管理するアクセス許可を持つユーザーであり、Synapse 管理istrator ではない場合は、 Synapse 管理istrator role by -RoleDefinitionId と -ObjectId を直接作成してください。-RoleDefinitionName では作成できません。Synapse 管理istrator の場合、RoleDefinitionId は "6e4bf58a-b8e1-4cc3-bbf9-d73143322b78" であり、以下の例 5 を参考にしてください。 その理由は、"Synapse 管理istrator" ロールを追加しようとすると、コマンドレットは、現在のユーザーが持っていないワークスペースの読み取りアクセス許可を必要とするロール名からロール ID を取得する必要があります。
例
例 1
New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoNameこのコマンドは、プリンシパル名が ContosoName であるユーザーに ContosoRole を割り当てます。
例 2
New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItemこのコマンドは、プリンシパル名が ContosoName で項目の種類が ContosoItemType、項目が ContosoItem であるユーザーに ContosoRole を割り当てます。
例 3
New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItemこのコマンドは、プリンシパル名が ContosoName で項目の種類が ContosoItemType、項目が ContosoItem であるユーザーに ContosoRole を割り当てます。
例 4
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseRoleAssignment -RoleDefinitionName ContosoRole -SignInName ContosoNameこのコマンドは、パイプライン経由でプリンシパル名が ContosoName であるユーザーに ContosoRole を割り当てます。
例 5
$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseRoleAssignment -RoleDefinitionId "6e4bf58a-b8e1-4cc3-bbf9-d73143322b78" -ObjectId ContosoObjectIdこのコマンドは、Synapse 管理istrator ロールを、パイプライン経由でオブジェクト ID が ContosoObjectId であるユーザーに割り当てます。
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行する
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Item
ワークスペース項目。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ItemType
ワークスペース項目の種類。
| Type: | Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType |
| Accepted values: | ApacheSparkPool, IntegrationRuntime, LinkedService, Credential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ObjectId
ユーザー、グループ、またはサービス プリンシパルの Microsoft Entra ObjectId。
| Type: | String |
| Aliases: | Id, PrincipalId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RoleDefinitionId
プリンシパルに割り当てられているロールの ID。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RoleDefinitionName
プリンシパルに割り当てられているロールの名前。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServicePrincipalName
サービス プリンシパルの ServicePrincipalName。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SignInName
ユーザーの電子メール アドレスまたはユーザー プリンシパル名。
| Type: | String |
| Aliases: | Email, UserPrincipalName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceName
Synapse ワークスペースの名前。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WorkspaceObject
ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。
| Type: | PSSynapseWorkspace |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
出力
Azure PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示