Update-AzSynapseLinkConnectionLandingZoneCredential

Module:

Az.Synapse

Updates the landing zone credential of a link connection.

Syntax

Update-AzSynapseLinkConnectionLandingZoneCredential
      -WorkspaceName <String>
      -LinkConnectionName <String>
      -SasToken <SecureString>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzSynapseLinkConnectionLandingZoneCredential
      -WorkspaceObject <PSSynapseWorkspace>
      -LinkConnectionName <String>
      -SasToken <SecureString>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzSynapseLinkConnectionLandingZoneCredential
      -InputObject <PSLinkConnectionResource>
      -SasToken <SecureString>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzSynapseLinkConnectionLandingZoneCredential cmdlet updates the landing zone credential of a link connection.

Examples

Example 1

Update-AzSynapseLinkConnectionLandingZoneCredential -WorkspaceName ContosoWorkspace -LinkConnectionName ContosoLinkConnection -SasToken "SampleSasToken"

This command updates the landing zone credential with sas token "exampleSasToken" of link connection ContosoLinkConnection in workspace ContosoWorkspace.

Example 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Update-AzSynapseLinkConnectionLandingZoneCredential -LinkConnectionName ContosoLinkConnection -SasToken "SampleSasToken"

This command updates the landing zone credential with sas token "exampleSasToken" of link connection ContosoLinkConnection in workspace ContosoWorkspace through pipeline.

Example 3

$lc = Get-AzSynapseLinkConnection -WorkspaceName ContosoWorkspace -Name ContosoLinkConnection
$lc | Update-AzSynapseLinkConnectionLandingZoneCredential -SasToken "SampleSasToken"

This command updates the landing zone credential with sas token "exampleSasToken" of a link connection through pipeline.

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

-InputObject

The information about the link connection.

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

-LinkConnectionName

Name of link connection.

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

-SasToken

Landing zone's sas token.

Type:	SecureString
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

PSLinkConnectionResource

Outputs

Boolean