Set-AzureRmEnvironment

Mengatur properti untuk lingkungan Azure.

Peringatan

Modul AzureRM PowerShell telah resmi tidak digunakan lagi per 29 Februari 2024. Pengguna disarankan untuk bermigrasi dari AzureRM ke modul Az PowerShell untuk memastikan dukungan dan pembaruan yang berkelanjutan.

Meskipun modul AzureRM mungkin masih berfungsi, modul tersebut tidak lagi dipertahankan atau didukung, menempatkan penggunaan berkelanjutan berdasarkan kebijaksanaan dan risiko pengguna. Silakan merujuk ke sumber daya migrasi kami untuk panduan tentang transisi ke modul Az.

Sintaks

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>]
   [[-DataLakeAudience] <String>]
   [[-BatchEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpoint] <String>]
   [[-AzureAnalysisServicesEndpointSuffix] <String>]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmEnvironment
   [-Name] <String>
   [[-StorageEndpoint] <String>]
   [-ARMEndpoint] <String>
   [[-AzureKeyVaultDnsSuffix] <String>]
   [[-AzureKeyVaultServiceEndpointResourceId] <String>]
   [[-DataLakeAudience] <String>]
   [[-BatchEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpoint] <String>]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Deskripsi

Cmdlet Set-AzureRMEnvironment mengatur titik akhir dan metadata untuk menyambungkan ke instans Azure.

Contoh

Contoh 1: Membuat dan memodifikasi lingkungan baru

PS C:\> Add-AzureRmEnvironment -Name TestEnvironment `
        -ActiveDirectoryEndpoint TestADEndpoint `
        -ActiveDirectoryServiceEndpointResourceId TestADApplicationId `
        -ResourceManagerEndpoint TestRMEndpoint `
        -GalleryEndpoint TestGalleryEndpoint `
        -GraphEndpoint TestGraphEndpoint

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

PS C:\> Set-AzureRmEnvironment -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        :

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

Parameter

-ActiveDirectoryEndpoint

Menentukan otoritas dasar untuk autentikasi Microsoft Entra.

Type:String
Aliases:AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:5
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ActiveDirectoryServiceEndpointResourceId

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

Type:String
Position:8
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AdTenant

Menentukan penyewa Direktori Aktif default.

Type:String
Position:17
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ARMEndpoint

Titik akhir Azure Resource Manager.

Type:String
Aliases:ArmUrl
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-AzureAnalysisServicesEndpointSuffix

Akhiran Dns titik akhir layanan Azure Analysis Services

Type:String
Position:15
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Akhiran Dns layanan pekerjaan dan katalog Azure Data Lake Analytics

Type:String
Position:15
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureDataLakeStoreFileSystemEndpointSuffix

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

Type:String
Position:14
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureKeyVaultDnsSuffix

Menentukan akhiran nama domain untuk layanan Key Vault.

Type:String
Position:10
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureKeyVaultServiceEndpointResourceId

Menentukan audiens untuk token akses yang mengotorisasi permintaan untuk layanan Key Vault.

Type:String
Position:11
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureOperationalInsightsEndpoint

Menentukan titik akhir untuk akses kueri Operational Insights.

Type:String
Position:22
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureOperationalInsightsEndpointResourceId

Menentukan audiens untuk token akses yang mengotorisasi permintaan untuk layanan Operational Insights.

Type:String
Position:21
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-BatchEndpointResourceId

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

Type:String
Aliases:BatchResourceId, BatchAudience
Position:20
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DataLakeAudience

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

Type:String
Aliases:DataLakeEndpointResourceId, DataLakeResourceId
Position:19
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableAdfsAuthentication

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

Type:SwitchParameter
Aliases:OnPremise
Position:16
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-GalleryEndpoint

Menentukan titik akhir untuk galeri templat penyebaran Azure Resource Manager.

Type:String
Aliases:Gallery, GalleryUrl
Position:7
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-GraphAudience

Audiens untuk token yang mengautentikasi dengan Ad Graph Endpoint.

Type:String
Aliases:GraphEndpointResourceId, GraphResourceId
Position:18
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-GraphEndpoint

Menentukan URL untuk permintaan Graph (metadata Direktori Aktif).

Type:String
Aliases:Graph, GraphUrl
Position:9
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ManagementPortalUrl

Menentukan URL untuk Portal Manajemen.

Type:String
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Menentukan nama lingkungan yang akan diubah.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PublishSettingsFileUrl

Menentukan URL tempat file .publishsettings dapat diunduh.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceManagerEndpoint

Menentukan URL untuk permintaan Azure Resource Manager.

Type:String
Aliases:ResourceManager, ResourceManagerUrl
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Scope

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

Type:ContextModificationScope
Accepted values:Process, CurrentUser
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServiceEndpoint

Menentukan titik akhir untuk permintaan Manajemen Layanan (RDFE).

Type:String
Aliases:ServiceManagement, ServiceManagementUrl
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SqlDatabaseDnsSuffix

Menentukan akhiran nama domain untuk server Azure SQL Database.

Type:String
Position:13
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageEndpoint

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

Type:String
Aliases:StorageEndpointSuffix
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrafficManagerDnsSuffix

Menentukan akhiran nama domain untuk layanan Azure Traffic Manager.

Type:String
Position:12
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Menunjukkan apa yang akan terjadi jika cmdlet berjalan. Cmdlet tidak dijalankan.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Input

String

SwitchParameter

Output

PSAzureEnvironment