Sync-AzSynapseIntegrationRuntimeCredential

  • Reference
Module:
Az.Synapse

Synchronizes credentials among integration runtime nodes.

Syntax

Sync-AzSynapseIntegrationRuntimeCredential
    [-ResourceGroupName <String>]
    -WorkspaceName <String>
    -IntegrationRuntimeName <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Sync-AzSynapseIntegrationRuntimeCredential
    -IntegrationRuntimeName <String>
    -WorkspaceObject <PSSynapseWorkspace>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Sync-AzSynapseIntegrationRuntimeCredential
    -ResourceId <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Sync-AzSynapseIntegrationRuntimeCredential
    -InputObject <PSIntegrationRuntime>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Sync-AzSynapseIntegrationRuntimeCredential cmdlet synchronizes on-premises credentials among integration runtime nodes, which forces the credentials to be identical in all nodes.

Examples

Example 1

Sync-AzSynapseIntegrationRuntimeCredential -WorkspaceName ContosoWorkspace -IntegrationRuntimeName 'test-selfhost-ir'

Synchronizes credentials among integration runtime nodes.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Don't ask for confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

The integration runtime object.

Type:PSIntegrationRuntime
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IntegrationRuntimeName

The integration runtime name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Resource group name.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

Resource identifier of Synapse integration runtime.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceName

Name of Synapse workspace.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type:PSSynapseWorkspace
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PSSynapseWorkspace

PSIntegrationRuntime

Outputs

Void