Partager via


New-AzSynapseRoleAssignment

Crée une attribution de rôle Synapse Analytics.

Syntaxe

NewByWorkspaceNameAndNameParameterSet (Par défaut)

New-AzSynapseRoleAssignment
    -WorkspaceName <String>
    -RoleDefinitionName <String>
    -SignInName <String>
    [-ItemType <WorkspaceItemType>]
    [-Item <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByWorkspaceNameAndIdParameterSet

New-AzSynapseRoleAssignment
    -WorkspaceName <String>
    -RoleDefinitionName <String>
    -ObjectId <String>
    [-ItemType <WorkspaceItemType>]
    [-Item <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet

New-AzSynapseRoleAssignment
    -WorkspaceName <String>
    -RoleDefinitionId <String>
    -ObjectId <String>
    [-ItemType <WorkspaceItemType>]
    [-Item <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByWorkspaceNameAndServicePrincipalNameParameterSet

New-AzSynapseRoleAssignment
    -WorkspaceName <String>
    -RoleDefinitionName <String>
    -ServicePrincipalName <String>
    [-ItemType <WorkspaceItemType>]
    [-Item <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByWorkspaceObjectAndNameParameterSet

New-AzSynapseRoleAssignment
    -WorkspaceObject <PSSynapseWorkspace>
    -RoleDefinitionName <String>
    -SignInName <String>
    [-ItemType <WorkspaceItemType>]
    [-Item <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByWorkspaceObjectAndIdParameterSet

New-AzSynapseRoleAssignment
    -WorkspaceObject <PSSynapseWorkspace>
    -RoleDefinitionName <String>
    -ObjectId <String>
    [-ItemType <WorkspaceItemType>]
    [-Item <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet

New-AzSynapseRoleAssignment
    -WorkspaceObject <PSSynapseWorkspace>
    -RoleDefinitionId <String>
    -ObjectId <String>
    [-ItemType <WorkspaceItemType>]
    [-Item <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

NewByWorkspaceObjectAndServicePrincipalNameParameterSet

New-AzSynapseRoleAssignment
    -WorkspaceObject <PSSynapseWorkspace>
    -RoleDefinitionName <String>
    -ServicePrincipalName <String>
    [-ItemType <WorkspaceItemType>]
    [-Item <String>]
    [-AsJob]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

L’applet de commande New-AzSynapseRoleAssignment crée une attribution de rôle Azure Synapse Analytics.

L’applet de commande peut appeler sous l’API Microsoft Graph en fonction des paramètres d’entrée :

  • GET /users/{id}
  • GET /servicePrincipals/{id}

Note

Pour créer une attribution de rôle pour un principal de service, transmettez l’ID d’objet du principal dans le paramètre ObjectId. Lorsque vous êtes un utilisateur autorisé à gérer l’attribution de rôle RBAC Azure sur l’espace de travail, mais pas un administrateur Synapse, Créez le rôle Administrateur Synapse par -RoleDefinitionId et -ObjectId directement, mais pas par -RoleDefinitionName, pour l’administrateur Synapse, RoleDefinitionId est « 00001111-aaaa-2222-bbbb-3333cccc4444 », veuillez prendre l’exemple 5 ci-dessous comme référence. C’est pourquoi, lorsque vous essayez d’ajouter un rôle « Administrateur Synapse », l’applet de commande doit obtenir l’ID de rôle à partir du nom du rôle qui nécessite l’autorisation de lecture de l’espace de travail, que l’utilisateur actuel n’a pas.

Exemples

Exemple 1

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName

Cette commande affecte ContosoRole à l’utilisateur dont le nom principal est ContosoName.

Exemple 2

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem

Cette commande affecte ContosoRole à l’utilisateur dont le nom principal est ContosoName et le type d’élément contosoItemType, l’élément est ContosoItem.

Exemple 3

New-AzSynapseRoleAssignment -WorkspaceName ContosoWorkspace -RoleDefinitionName ContosoRole -SignInName ContosoName -ItemType ContosoItemType -Item ContosoItem

Cette commande affecte ContosoRole à l’utilisateur dont le nom principal est ContosoName et le type d’élément contosoItemType, l’élément est ContosoItem.

Exemple 4

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseRoleAssignment -RoleDefinitionName ContosoRole -SignInName ContosoName

Cette commande affecte ContosoRole à l’utilisateur dont le nom principal est ContosoName via le pipeline.

Exemple 5

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | New-AzSynapseRoleAssignment -RoleDefinitionId "00001111-aaaa-2222-bbbb-3333cccc4444" -ObjectId ContosoObjectId

Cette commande affecte le rôle Administrateur Synapse à l’utilisateur dont l’ID d’objet est ContosoObjectId via le pipeline.

Paramètres

-AsJob

Exécuter l’applet de commande en arrière-plan

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Item

Élément de l’espace de travail.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ItemType

Type d’élément d’espace de travail.

Propriétés du paramètre

Type:Microsoft.Azure.Commands.Synapse.Models.SynapseConstants+WorkspaceItemType
Valeur par défaut:None
Valeurs acceptées:ApacheSparkPool, IntegrationRuntime, LinkedService, Credential
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ObjectId

Microsoft Entra ObjectId de l’utilisateur, du groupe ou du principal du service.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Id, PrincipalId

Jeux de paramètres

NewByWorkspaceNameAndIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RoleDefinitionId

ID du rôle affecté au principal.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NewByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RoleDefinitionName

Nom du rôle affecté au principal.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NewByWorkspaceNameAndNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceNameAndIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceNameAndServicePrincipalNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndServicePrincipalNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ServicePrincipalName

ServicePrincipalName du principal de service.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NewByWorkspaceNameAndServicePrincipalNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndServicePrincipalNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SignInName

Adresse e-mail ou nom d’utilisateur principal de l’utilisateur.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Messagerie électronique, Nom Principal de l'Utilisateur

Jeux de paramètres

NewByWorkspaceNameAndNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WorkspaceName

Nom de l’espace de travail Synapse.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NewByWorkspaceNameAndNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceNameAndIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceNameAndRoleDefinitionIdAndObjectIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceNameAndServicePrincipalNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WorkspaceObject

objet d’entrée d’espace de travail, généralement passé par le pipeline.

Propriétés du paramètre

Type:PSSynapseWorkspace
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

NewByWorkspaceObjectAndNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndRoleDefinitionIdAndObjectIdParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
NewByWorkspaceObjectAndServicePrincipalNameParameterSet
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

PSSynapseWorkspace

Sorties

PSRoleAssignmentDetails