Set-AzHDInsightGatewayCredential
Azure HDInsight クラスターのゲートウェイ HTTP 資格情報を設定します。
構文
SetByNameParameterSet (既定)
Set-AzHDInsightGatewayCredential
[-Name] <String>
[[-HttpCredential] <PSCredential>]
[-ResourceGroupName <String>]
[-EntraUserIdentity <String[]>]
[-EntraUserFullInfo <Hashtable[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzHDInsightGatewayCredential
[[-HttpCredential] <PSCredential>]
-InputObject <AzureHDInsightCluster>
[-EntraUserIdentity <String[]>]
[-EntraUserFullInfo <Hashtable[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SetByResourceIdParameterSet
Set-AzHDInsightGatewayCredential
[[-HttpCredential] <PSCredential>]
-ResourceId <String>
[-EntraUserIdentity <String[]>]
[-EntraUserFullInfo <Hashtable[]>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Set-AzHDInsightGatewayCredential コマンドレットは、Azure HDInsight クラスターのゲートウェイ資格情報を設定します。
例
例 1: 名前パラメーター セットによる HDInsight クラスターのゲートウェイ資格情報の設定
# Cluster info
$clusterName = "your-hadoop-001"
$clusterCreds = Get-Credential
Set-AzHDInsightGatewayCredential `
-ClusterName $clusterName `
-HttpCredential $clusterCreds
例 2: ResourceId パラメーター セットによって HDInsight クラスターのゲートウェイ資格情報を設定する
Set-AzHDInsightGatewayCredential `
-ResourceId "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/your-hadoop-001" `
-HttpCredential $clusterCreds
# Cluster info
$clusterName = "your-hadoop-001"
$clusterCreds = Get-Credential
Get-AzHDInsightCluster -ClusterName $clusterName | Set-AzHDInsightGatewayCredential `
-HttpCredential $clusterCreds
例 4: EntraUser Full Info を使用して HDInsight クラスターのゲートウェイ エントラ ユーザーを設定する
# Cluster info
$clusterName = "your-hadoop-001"
$entraUserFullInfo = @(@{ObjectId = "ObjectId1"; Upn = "Upn1"; DisplayName = "DisplayName1"},@{ObjectId = "ObjectId2"; Upn = "Upn2"; DisplayName = "DisplayName2"})
Set-AzHDInsightGatewayCredential `
-ClusterName $clusterName `
-EntraUserFullInfo $entraUserFullInfo
-EntraUserFullInfo パラメーターを使用するには、各ユーザーの ObjectId、Upn、DisplayName を指定する必要があります。 この情報は、 Azure Portal で Microsoft Entra ID > Users の下でユーザーのプロファイルを表示するか、PowerShell の Az.Resources モジュールの Get-AzADUser コマンドレットを使用してプログラムで取得できます。 たとえば、 Get-AzADUser -UserPrincipalName "user@contoso.com" は、Id (ObjectId)、UserPrincipalName (Upn)、DisplayName などのフィールドを返します。 詳細については、公式ドキュメント Get-AzADUser を参照してください。
例 5: ObjectId または Upn を使用して HDInsight クラスターのゲートウェイ Entra ユーザーを設定する
# Cluster info
$clusterName = "your-hadoop-001"
$entraUserIdentity = @("user1@contoso.com","user2@contoso.com","objectid3","objectid4")
Set-AzHDInsightGatewayCredential `
-ClusterName $clusterName `
-EntraUserIdentity $entraUserIdentity
パラメーター
-AsJob
バックグラウンドでコマンドレットを実行します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EntraUserFullInfo
ハッシュテーブルの配列として Entra ユーザーの一覧を取得または設定します。 各ハッシュテーブルには、ObjectId、Upn、DisplayName などのキーが含まれている必要があります。
パラメーターのプロパティ
| 型: | Hashtable[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EntraUserIdentity
Entra ユーザー データを取得または設定します。 1 つ以上の ObjectId/Upn 値を受け入れます。
パラメーターのプロパティ
| 型: | String[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-HttpCredential
クラスターのユーザーのログインを取得または設定します。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
入力オブジェクトを取得または設定します。
SetByInputObjectParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
クラスターの名前を取得または設定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | クラスター名 |
パラメーター セット
SetByNameParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前を取得または設定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
SetByNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceId
リソース ID を取得または設定します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
SetByResourceIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
None
出力