Update-AzSynapseLinkConnectionLandingZoneCredential

Module:

Az.Synapse Module

Updates the landing zone credential of a link connection.

Syntax

UpdateByName (Default)

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

UpdateByObject

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

UpdateByInputObject

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.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

The information about the link connection.

Parameter properties

Type:	PSLinkConnectionResource
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateByInputObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LinkConnectionName

Name of link connection.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

UpdateByObject

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SasToken

Landing zone's sas token.

Parameter properties

Type:	SecureString
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceName

Name of Synapse workspace.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateByName

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

Type:	PSSynapseWorkspace
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

UpdateByObject

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSSynapseWorkspace

PSLinkConnectionResource

Outputs

Boolean