Azure PowerShell for AzureStack の Set-AzureRmEnvironment コマンドレットについて

スポンサーリンク

Set-AzureRmEnvironment コマンドレットに関するヘルプ情報について、「Get-Help」コマンドレットの -Full オプションを用いて実行した結果を編集、意訳しています。
※Azure PowerShell for AzureStack v1.2.10 で確認

Set-AzureRmEnvironment コマンドレットについて

名前

Set-AzureRmEnvironment

構文

Set-AzureRmEnvironment [-Name] <string> [[-PublishSettingsFileUrl] <string>] [[-ServiceEndpoint] <string>] [[-ManagementPortalUrl] <string>] [[-StorageEndpoint] <string>] [[-ActiveDirectoryEndpoint] <string>] [[-ResourceManagerEndpoint] <string>] [[-GalleryEndpoint] <string>] [[-ActiveDirectoryServiceEndpointResourceId] <string>] [[-GraphEndpoint] <string>] [[-AzureKeyVaultDnsSuffix] <string>] [[-AzureKeyVaultServiceEndpointResourceId] <string>] [[-TrafficManagerDnsSuffix] <string>] [[-SqlDatabaseDnsSuffix] <string>] [[-AzureDataLakeStoreFileSystemEndpointSuffix] <string>] [[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] <string>] [[-EnableAdfsAuthentication]] [[-AdTenant] <string>] [[-GraphAudience] <string>] [-WhatIf] [-Confirm] [<CommonParameters>]

Set-AzureRmEnvironment [-Name] <string> [-ARMEndpoint] <string> [-WhatIf] [-Confirm] [<CommonParameters>]

エイリアス

なし

パラメーター

-ARMEndpoint <string>

Azure Resource Manager エンドポイントを指定します。

必須true
位置1
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名ARMEndpoint
エイリアスArmUrl
動的false

-ActiveDirectoryEndpoint <string>

この環境の Active Directory サービスの URI を指定します。

必須false
位置5
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスAdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
動的false

-ActiveDirectoryServiceEndpointResourceId <string>

要求されたトークンの宛先であるターゲット リソース ID を指定します。

必須false
位置8
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-AdTenant <string>

この環境の既定のテナントを指定します。

必須false
位置17
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix <string>

Azure Data Lake Analytics ジョブとカタログ サービスの DNS サフィックスを指定します。

必須false
位置15
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-AzureDataLakeStoreFileSystemEndpointSuffix <string>

Azure Data Lake Store FileSystem の DNS サフィックスを指定します。例 : azuredatalake.net

必須false
位置14
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-AzureKeyVaultDnsSuffix <string>

Azure Key Vault サービスの DNS サフィックスを指定します。例 : vault-int.azure-int.net

必須false
位置10
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-AzureKeyVaultServiceEndpointResourceId <string>

要求されたトークンの宛先である Azure Key Vault データ サービスのリソース ID を指定します。

必須false
位置11
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-Confirm

必須false
位置named
パイプライン入力を許可するfalse
パラメーター セット名(All)
エイリアスcf
動的false

-EnableAdfsAuthentication

権限の検証が無効化されている ADFS 認証を有効化する場合に指定します。

ADFS 認証を有効にする、もしくは代わりに AAD 認証を使用するかどうかを設定する場合に指定します。この値は通常、Azure Stack エンドポイントでのみ true となります。

必須false
位置16
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスOnPremise
動的false

-GalleryEndpoint <string>

公開ギャラリーのエンドポイントを指定します。

必須false
位置7
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスGallery, GalleryUrl
動的false

-GraphAudience <string>

AD Graph エンドポイントで認証するトークンの対象ユーザーを指定します。

必須false
位置18
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスGraphEndpointResourceId, GraphResourceId
動的false

-GraphEndpoint <string>

AD Graph エンドポイントを指定します。

必須false
位置9
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスGraph, GraphUrl
動的false

-ManagementPortalUrl <string>

必須false
位置3
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-Name <string>

必須true
位置0
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名(All)
エイリアスNone
動的false

-PublishSettingsFileUrl <string>

必須false
位置1
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-ResourceManagerEndpoint <string>

クラウド サービス エンドポイントを指定します。

必須false
位置6
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスResourceManager, ResourceManagerUrl
動的false

-ServiceEndpoint <string>

必須false
位置2
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスServiceManagement, ServiceManagementUrl
動的false

-SqlDatabaseDnsSuffix <string>

この環境で作成された SQL データベースの DNS サフィックスを指定します。

必須false
位置13
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-StorageEndpoint <string>

ストレージ エンドポイントを指定します。

必須false
位置4
パイプライン入力を許可するfalse
パラメーター セット名Name
エイリアスStorageEndpointSuffix
動的false

-TrafficManagerDnsSuffix <string>

Traffic Manager サービスの DNS サフィックスを指定します。

必須false
位置12
パイプライン入力を許可するtrue (ByPropertyName)
パラメーター セット名Name
エイリアスNone
動的false

-WhatIf

必須false
位置named
パイプライン入力を許可するfalse
パラメーター セット名(All)
エイリアスwi
動的false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose-Debug-ErrorAction-ErrorVariable-WarningAction-WarningVariable-OutBuffer-PipelineVariable、および -OutVariable。詳細については、about_CommonParameters を参照してください。

入力

  • System.String
  • System.Management.Automation.SwitchParameter

出力

  • Microsoft.Azure.Commands.Profile.Models.PSAzureEnvironment

備考

  • なし

参考