Udostępnij za pośrednictwem


Set-AzureRmEnvironment

Ustawia właściwości środowiska platformy Azure.

Ostrzeżenie

Moduł AzureRM PowerShell jest oficjalnie przestarzały od 29 lutego 2024 r. Zaleca się migrowanie użytkowników z modułu AzureRM do modułu Az programu PowerShell w celu zapewnienia ciągłej obsługi i aktualizacji.

Mimo że moduł AzureRM może nadal działać, nie jest już utrzymywany ani obsługiwany, umieszczając wszelkie dalsze zastosowania według uznania i ryzyka użytkownika. Zapoznaj się z naszymi zasobami migracji, aby uzyskać wskazówki dotyczące przejścia do modułu Az.

Składnia

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>]

Opis

Polecenie cmdlet Set-AzureRMEnvironment ustawia punkty końcowe i metadane na potrzeby nawiązywania połączenia z wystąpieniem platformy Azure.

Przykłady

Przykład 1. Tworzenie i modyfikowanie nowego środowiska

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        :

W tym przykładzie tworzysz nowe środowisko platformy Azure z przykładowymi punktami końcowymi przy użyciu polecenia cmdlet Add-AzureRmEnvironment, a następnie zmieniamy wartość atrybutów ActiveDirectoryEndpoint i GraphEndpoint utworzonego środowiska przy użyciu polecenia cmdlet Set-AzureRmEnvironment.

Parametry

-ActiveDirectoryEndpoint

Określa podstawowy urząd uwierzytelniania firmy Microsoft Entra.

Typ:String
Aliasy:AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:5
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ActiveDirectoryServiceEndpointResourceId

Określa odbiorców tokenów uwierzytelniania żądań do punktów końcowych usługi Azure Resource Manager lub zarządzania usługami (RDFE).

Typ:String
Position:8
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AdTenant

Określa domyślną dzierżawę usługi Active Directory.

Typ:String
Position:17
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ARMEndpoint

Punkt końcowy usługi Azure Resource Manager.

Typ:String
Aliasy:ArmUrl
Position:1
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AzureAnalysisServicesEndpointSuffix

Sufiks DNS punktów końcowych usługi Azure Analysis Services

Typ:String
Position:15
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Sufiks DNS zadań i usług katalogu usługi Azure Data Lake Analytics

Typ:String
Position:15
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AzureDataLakeStoreFileSystemEndpointSuffix

Sufiks DNS systemu plików usługi Azure Data Lake Store. Przykład: azuredatalake.net

Typ:String
Position:14
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AzureKeyVaultDnsSuffix

Określa sufiks nazwy domeny dla usług Key Vault.

Typ:String
Position:10
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AzureKeyVaultServiceEndpointResourceId

Określa odbiorców tokenów dostępu, które autoryzuje żądania usług Key Vault.

Typ:String
Position:11
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AzureOperationalInsightsEndpoint

Określa punkt końcowy dostępu do zapytań usługi Operational Insights.

Typ:String
Position:22
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-AzureOperationalInsightsEndpointResourceId

Określa odbiorców tokenów dostępu, które autoryzuje żądania usług Operational Insights.

Typ:String
Position:21
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-BatchEndpointResourceId

Identyfikator zasobu usługi Azure Batch, który jest adresatem żądanego tokenu

Typ:String
Aliasy:BatchResourceId, BatchAudience
Position:20
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-DataLakeAudience

Odbiorcy tokenów uwierzytelniających się za pomocą punktu końcowego usług AD Data Lake Services.

Typ:String
Aliasy:DataLakeEndpointResourceId, DataLakeResourceId
Position:19
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-EnableAdfsAuthentication

Wskazuje, że uwierzytelnianie lokalne usług Active Directory Federation Services (ADFS) jest dozwolone.

Typ:SwitchParameter
Aliasy:OnPremise
Position:16
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-GalleryEndpoint

Określa punkt końcowy dla galerii szablonów wdrażania usługi Azure Resource Manager.

Typ:String
Aliasy:Gallery, GalleryUrl
Position:7
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-GraphAudience

Odbiorcy tokenów uwierzytelniających się za pomocą punktu końcowego programu AD Graph.

Typ:String
Aliasy:GraphEndpointResourceId, GraphResourceId
Position:18
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-GraphEndpoint

Określa adres URL żądań programu Graph (metadanych usługi Active Directory).

Typ:String
Aliasy:Graph, GraphUrl
Position:9
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ManagementPortalUrl

Określa adres URL portalu zarządzania.

Typ:String
Position:3
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Name

Określa nazwę środowiska do zmodyfikowania.

Typ:String
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-PublishSettingsFileUrl

Określa adres URL, z którego można pobrać pliki publishsettings.

Typ:String
Position:1
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ResourceManagerEndpoint

Określa adres URL żądań usługi Azure Resource Manager.

Typ:String
Aliasy:ResourceManager, ResourceManagerUrl
Position:6
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Scope

Określa na przykład zakres zmian kontekstu, czy zmiany mają zastosowanie tylko do bieżącego procesu, czy do wszystkich sesji uruchomionych przez tego użytkownika.

Typ:ContextModificationScope
Dopuszczalne wartości:Process, CurrentUser
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ServiceEndpoint

Określa punkt końcowy dla żądań zarządzania usługami (RDFE).

Typ:String
Aliasy:ServiceManagement, ServiceManagementUrl
Position:2
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-SqlDatabaseDnsSuffix

Określa sufiks nazwy domeny dla serwerów usługi Azure SQL Database.

Typ:String
Position:13
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-StorageEndpoint

Określa punkt końcowy dla dostępu do magazynu (obiektu blob, tabeli, kolejki i pliku).

Typ:String
Aliasy:StorageEndpointSuffix
Position:4
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-TrafficManagerDnsSuffix

Określa sufiks nazwy domeny dla usług Azure Traffic Manager.

Typ:String
Position:12
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

String

SwitchParameter

Dane wyjściowe

PSAzureEnvironment