Remove-AzSynapseWorkspaceKey

Tar bort en arbetsytenyckel.

Syntax

DeleteByNameParameterSet (Standard)

Remove-AzSynapseWorkspaceKey
    -WorkspaceName <String>
    -Name <String>
    [-ResourceGroupName <String>]
    [-PassThru]
    [-AsJob]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeleteByParentObjectParameterSet

Remove-AzSynapseWorkspaceKey
    -Name <String>
    -WorkspaceObject <PSSynapseWorkspace>
    [-PassThru]
    [-AsJob]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeleteByInputObjectParameterSet

Remove-AzSynapseWorkspaceKey
    -InputObject <PSWorkspaceKey>
    [-PassThru]
    [-AsJob]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DeleteByResourceIdParameterSet

Remove-AzSynapseWorkspaceKey
    -ResourceId <String>
    [-PassThru]
    [-AsJob]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Remove-AzSynapseWorkspaceKey tar bort en arbetsytenyckel

Exempel

Exempel 1

Remove-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoKeyName

Det här kommandot tar bort en arbetsytenyckel under en Azure Synapse Analytics-arbetsyta.

Exempel 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Remove-AzSynapseWorkspaceKey -Name ContosoKeyName

Det här kommandot tar bort en arbetsytenyckel under en Azure Synapse Analytics-arbetsyta via pipeline.

Exempel 3

Remove-AzSynapseWorkspaceKey -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/ContosoKeyName

Det här kommandot tar bort en Azure Synapse Analytics-arbetsytenyckel via pipeline med det angivna resurs-ID:t.

Parametrar

-AsJob

Kör cmdlet i bakgrunden

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Parameteregenskaper

Typ:IAzureContextContainer
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Force

Be inte om bekräftelse.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-InputObject

Indataobjekt för arbetsytans nyckel, skickas vanligtvis via pipelinen.

Parameteregenskaper

Typ:PSWorkspaceKey
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

DeleteByInputObjectParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Name

Namnet på arbetsytans krypteringsnyckel.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Nyckelnamn

Parameteruppsättningar

DeleteByNameParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False
DeleteByParentObjectParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-PassThru

Den här cmdleten returnerar inte ett objekt som standard. Om den här växeln har angetts returneras true om den lyckas.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceGroupName

Namn på resursgrupp.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

DeleteByNameParameterSet
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceId

Resursidentifieraren för Synapse SQL-pool.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

DeleteByResourceIdParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WorkspaceName

Namnet på Synapse-arbetsytan.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

DeleteByNameParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WorkspaceObject

indataobjekt för arbetsytan, som vanligtvis skickas via pipelinen.

Parameteregenskaper

Typ:PSSynapseWorkspace
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

DeleteByParentObjectParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

PSSynapseWorkspace

PSWorkspaceKey

String

Utdata

Boolean