次の方法で共有


Get-AzSynapseWorkspaceKey

ワークスペース キーを取得します。

構文

GetByNameParameterSet (既定)

Get-AzSynapseWorkspaceKey
    -WorkspaceName <String>
    [-ResourceGroupName <String>]
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByParentObjectParameterSet

Get-AzSynapseWorkspaceKey
    -WorkspaceObject <PSSynapseWorkspace>
    [-Name <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByResourceIdParameterSet

Get-AzSynapseWorkspaceKey
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

説明

Get-AzSynapseWorkspaceKey コマンドレットは、ワークスペース キーを取得します。

例 1

Get-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace

このコマンドは、ContosoWorkspace という名前のワークスペース内のすべてのワークスペース キーに関する情報を取得します。

例 2

Get-AzSynapseWorkspaceKey -WorkspaceName ContosoWorkspace -Name ContosoWorkspaceKey

このコマンドは、ContosoWorkspace という名前のワークスペース内の ContosoWorkspaceKey という名前のワークスペース キーに関する情報を取得します。

例 3

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseWorkspaceKey -Name ContosoWorkspaceKey

このコマンドは、パイプライン経由で ContosoWorkspace というワークスペース内の ContosoWorkspaceKey という名前のワークスペース キーに関する情報を取得します。

例 4

Get-AzSynapseSqlPool -ResourceId "/subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace/keys/ContosoWorkspaceKey"

このコマンドは、指定されたリソース ID を持つワークスペース キーを取得します。

パラメーター

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

パラメーターのプロパティ

型:IAzureContextContainer
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Name

ワークスペース暗号化キーの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:キー名

パラメーター セット

GetByNameParameterSet
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
GetByParentObjectParameterSet
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ResourceGroupName

リソース グループ名。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

GetByNameParameterSet
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ResourceId

Synapse SQL プールのリソース識別子。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

GetByResourceIdParameterSet
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WorkspaceName

Synapse ワークスペースの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

GetByNameParameterSet
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-WorkspaceObject

ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。

パラメーターのプロパティ

型:PSSynapseWorkspace
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

GetByParentObjectParameterSet
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

PSSynapseWorkspace

出力

PSWorkspaceKey