Set-AzEnvironment

Mengatur properti untuk lingkungan Azure.

Sintaks

Name (Default)

Set-AzEnvironment
    [-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>]
    [[-AdTenant] <String>]
    [[-GraphAudience] <String>]
    [[-DataLakeAudience] <String>]
    [[-BatchEndpointResourceId] <String>]
    [[-AzureOperationalInsightsEndpointResourceId] <String>]
    [[-AzureOperationalInsightsEndpoint] <String>]
    [-EnableAdfsAuthentication]
    [-AzureAnalysisServicesEndpointSuffix <String>]
    [-AzureAnalysisServicesEndpointResourceId <String>]
    [-AzureAttestationServiceEndpointSuffix <String>]
    [-AzureAttestationServiceEndpointResourceId <String>]
    [-AzureSynapseAnalyticsEndpointSuffix <String>]
    [-ContainerRegistryEndpointSuffix <String>]
    [-AzureSynapseAnalyticsEndpointResourceId <String>]
    [-MicrosoftGraphEndpointResourceId <String>]
    [-MicrosoftGraphUrl <String>]
    [-SshAuthScope <String>]
    [-Scope <ContextModificationScope>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ARMEndpoint

Set-AzEnvironment
    [-Name] <String>
    [[-StorageEndpoint] <String>]
    [-ARMEndpoint] <String>
    [[-AzureKeyVaultDnsSuffix] <String>]
    [[-AzureKeyVaultServiceEndpointResourceId] <String>]
    [[-DataLakeAudience] <String>]
    [[-BatchEndpointResourceId] <String>]
    [[-AzureOperationalInsightsEndpointResourceId] <String>]
    [[-AzureOperationalInsightsEndpoint] <String>]
    [-AzureAnalysisServicesEndpointSuffix <String>]
    [-AzureAnalysisServicesEndpointResourceId <String>]
    [-AzureAttestationServiceEndpointSuffix <String>]
    [-AzureAttestationServiceEndpointResourceId <String>]
    [-AzureSynapseAnalyticsEndpointSuffix <String>]
    [-ContainerRegistryEndpointSuffix <String>]
    [-AzureSynapseAnalyticsEndpointResourceId <String>]
    [-Scope <ContextModificationScope>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Deskripsi

cmdlet Set-AzEnvironment mengatur titik akhir dan metadata untuk menyambungkan ke instans Azure.

Contoh

Contoh 1: Membuat dan memodifikasi lingkungan baru

Add-AzEnvironment -Name TestEnvironment `
        -ActiveDirectoryEndpoint TestADEndpoint `
        -ActiveDirectoryServiceEndpointResourceId TestADApplicationId `
        -ResourceManagerEndpoint TestRMEndpoint `
        -GalleryEndpoint TestGalleryEndpoint `
        -GraphEndpoint TestGraphEndpoint

Name            Resource Manager Url ActiveDirectory Authority
----            -------------------- -------------------------
TestEnvironment TestRMEndpoint       TestADEndpoint/

Set-AzEnvironment -Name TestEnvironment `
        -ActiveDirectoryEndpoint NewTestADEndpoint `
        -GraphEndpoint NewTestGraphEndpoint | Format-List

Name                                              : TestEnvironment
EnableAdfsAuthentication                          : False
ActiveDirectoryServiceEndpointResourceId          : TestADApplicationId
AdTenant                                          :
GalleryUrl                                        : TestGalleryEndpoint
ManagementPortalUrl                               :
ServiceManagementUrl                              :
PublishSettingsFileUrl                            :
ResourceManagerUrl                                : TestRMEndpoint
SqlDatabaseDnsSuffix                              :
StorageEndpointSuffix                             :
ActiveDirectoryAuthority                          : NewTestADEndpoint
GraphUrl                                          : NewTestGraphEndpoint
GraphEndpointResourceId                           :
TrafficManagerDnsSuffix                           :
AzureKeyVaultDnsSuffix                            :
AzureDataLakeStoreFileSystemEndpointSuffix        :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId            :
BatchEndpointResourceId                           :
AzureOperationalInsightsEndpoint                  :
AzureOperationalInsightsEndpointResourceId        :
AzureAttestationServiceEndpointSuffix             :
AzureAttestationServiceEndpointResourceId         :
AzureSynapseAnalyticsEndpointSuffix               :
AzureSynapseAnalyticsEndpointResourceId           :

Dalam contoh ini kita membuat lingkungan Azure baru dengan titik akhir sampel menggunakan Add-AzEnvironment, lalu kita mengubah nilai atribut ActiveDirectoryEndpoint dan GraphEndpoint dari lingkungan yang dibuat menggunakan cmdlet Set-AzEnvironment.

Parameter

-ActiveDirectoryEndpoint

Menentukan otoritas dasar untuk autentikasi Azure Active Directory.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:AdEndpointUrl, Direktori Aktif, ActiveDirectoryAuthority

Kumpulan parameter

Name
Position:5
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ActiveDirectoryServiceEndpointResourceId

Menentukan audiens untuk token yang mengautentikasi permintaan ke titik akhir Azure Resource Manager atau Manajemen Layanan (RDFE).

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:8
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AdTenant

Menentukan penyewa Direktori Aktif default.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:17
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ARMEndpoint

Titik akhir Azure Resource Manager.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:ArmUrl

Kumpulan parameter

ARMEndpoint
Position:1
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureAnalysisServicesEndpointResourceId

Pengidentifikasi sumber daya sumber daya Azure Analysis Services.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-AzureAnalysisServicesEndpointSuffix

Titik akhir yang akan digunakan saat berkomunikasi dengan AZURE Log Analytics API.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-AzureAttestationServiceEndpointResourceId

Pengidentifikasi sumber daya layanan Azure Attestation yang merupakan penerima token yang diminta.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureAttestationServiceEndpointSuffix

Akhiran dns layanan Azure Attestation.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Akhiran Dns layanan pekerjaan dan katalog Azure Data Lake Analytics

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:15
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureDataLakeStoreFileSystemEndpointSuffix

Akhiran Dns Azure Data Lake Store FileSystem. Contoh: azuredatalake.net

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:14
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureKeyVaultDnsSuffix

Akhiran dns layanan Azure Key Vault. Contohnya adalah vault-int.azure-int.net

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:10
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureKeyVaultServiceEndpointResourceId

Pengidentifikasi sumber daya layanan data Azure Key Vault yang merupakan penerima token yang diminta.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:11
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureOperationalInsightsEndpoint

Titik akhir yang akan digunakan saat berkomunikasi dengan AZURE Log Analytics API.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:22
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureOperationalInsightsEndpointResourceId

Audiens untuk token yang mengautentikasi dengan AZURE Log Analytics API.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:21
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureSynapseAnalyticsEndpointResourceId

Pengidentifikasi sumber daya Azure Synapse Analytics yang merupakan penerima token yang diminta.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-AzureSynapseAnalyticsEndpointSuffix

Akhiran dns Azure Synapse Analytics.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-BatchEndpointResourceId

Pengidentifikasi sumber daya layanan Azure Batch yang merupakan penerima token yang diminta

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:BatchResourceId, BatchAudience

Kumpulan parameter

(All)
Position:20
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Confirm

Meminta konfirmasi sebelum menjalankan cmdlet.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:Cf

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ContainerRegistryEndpointSuffix

Akhiran Azure Container Registry.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-DataLakeAudience

Audiens untuk token yang mengautentikasi dengan Titik Akhir layanan AD Data Lake.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:DataLakeEndpointResourceId, DataLakeResourceId

Kumpulan parameter

(All)
Position:19
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-DefaultProfile

Kredensial, akun, penyewa, dan langganan yang digunakan untuk komunikasi dengan azure.

Properti parameter

Jenis:IAzureContextContainer
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-EnableAdfsAuthentication

Menunjukkan bahwa autentikasi lokal Active Directory Federation Services (ADFS) diizinkan.

Properti parameter

Jenis:SwitchParameter
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:OnPremise

Kumpulan parameter

Name
Position:16
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-GalleryEndpoint

Menentukan titik akhir untuk galeri templat penyebaran Azure Resource Manager. Parameternya adalah mengatur nilai ke GalleryUrl dari PSAzureEnvironment. Seperti GalleryUrl yang dihapus dari ArmMetadata, Azure PowerShell tidak akan lagi menyediakan nilai sehingga tidak disarankan untuk diatur GalleryEndpoint lagi.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Gallery, GalleryUrl

Kumpulan parameter

Name
Position:7
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-GraphAudience

Audiens untuk token yang mengautentikasi dengan Ad Graph Endpoint.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:GraphEndpointResourceId, GraphResourceId

Kumpulan parameter

Name
Position:18
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-GraphEndpoint

Menentukan URL untuk permintaan Graph (metadata Direktori Aktif).

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:Graph, GraphUrl

Kumpulan parameter

Name
Position:9
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ManagementPortalUrl

Menentukan URL untuk Portal Manajemen.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:3
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-MicrosoftGraphEndpointResourceId

Pengidentifikasi sumber daya Microsoft Graph

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-MicrosoftGraphUrl

Microsoft Graph Url

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Name

Menentukan nama lingkungan yang akan diubah.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:0
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-PublishSettingsFileUrl

Menentukan URL tempat file .publishsettings dapat diunduh.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:1
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ResourceManagerEndpoint

Menentukan URL untuk permintaan Azure Resource Manager.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:ResourceManager, ResourceManagerUrl

Kumpulan parameter

Name
Position:6
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Scope

Menentukan cakupan perubahan konteks, misalnya, apakah perubahan hanya berlaku untuk proses saat ini, atau untuk semua sesi yang dimulai oleh pengguna ini.

Properti parameter

Jenis:ContextModificationScope
Nilai default:None
Nilai yang diterima:Process, CurrentUser
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ServiceEndpoint

Menentukan titik akhir untuk permintaan Manajemen Layanan (RDFE).

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:ServiceManagement, ServiceManagementUrl

Kumpulan parameter

Name
Position:2
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-SqlDatabaseDnsSuffix

Menentukan akhiran nama domain untuk server Azure SQL Database.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:13
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-SshAuthScope

Cakupan untuk autentikasi saat SSH ke Azure VM.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-StorageEndpoint

Menentukan titik akhir untuk akses penyimpanan (blob, tabel, antrean, dan file).

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False
Alias:StorageEndpointSuffix

Kumpulan parameter

(All)
Position:4
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-TrafficManagerDnsSuffix

Menentukan akhiran nama domain untuk layanan Azure Traffic Manager.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Kumpulan parameter

Name
Position:12
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-WhatIf

Menunjukkan apa yang akan terjadi ketika cmdlet dijalankan. Cmdlet tidak dijalankan.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:wi

Kumpulan parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

Input

String

SwitchParameter

Output

PSAzureEnvironment