Freigeben über

Add-AzureRmEnvironment

  • Referenz
Modul:
AzureRM.Profile

Fügt Endpunkte und Metadaten für eine Instanz von Azure Resource Manager hinzu.

Warnung

Das AzureRM PowerShell-Modul ist seit dem 29. Februar 2024 offiziell veraltet. Benutzern wird empfohlen, von AzureRM zum Az PowerShell-Modul zu migrieren, um weiterhin Support und Updates zu erhalten.

Obwohl das AzureRM-Modul möglicherweise weiterhin funktioniert, wird es nicht mehr gewartet, und es wird kein Support mehr angeboten. Die weitere Nutzung erfolgt daher nach Ermessen und Risiko des Benutzers. Weitere Informationen zum Übergang zum Az-Modul finden Sie in unseren Migrationsressourcen.

Syntax

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

Beschreibung

Das Add-AzureRmEnvironment-Cmdlet fügt Endpunkte und Metadaten hinzu, um Azure Resource Manager-Cmdlets für die Verbindung mit einer neuen Instanz von Azure Resource Manager zu ermöglichen. Die integrierten Umgebungen AzureCloud und AzureChinaCloud zielen auf vorhandene öffentliche Instanzen von Azure Resource Manager ab.

Beispiele

Beispiel 1: Erstellen und Ändern einer neuen Umgebung

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
OnPremise                                         : False
ActiveDirectoryServiceEndpointResourceId          : TestADApplicationId
AdTenant                                          :
GalleryUrl                                        : TestGalleryEndpoint
ManagementPortalUrl                               :
ServiceManagementUrl                              :
PublishSettingsFileUrl                            :
ResourceManagerUrl                                : TestRMEndpoint
SqlDatabaseDnsSuffix                              :
StorageEndpointSuffix                             :
ActiveDirectoryAuthority                          : NewTestADEndpoint
GraphUrl                                          : NewTestGraphEndpoint
GraphEndpointResourceId                           :
TrafficManagerDnsSuffix                           :
AzureKeyVaultDnsSuffix                            :
DataLakeEndpointResourceId                        :
AzureDataLakeStoreFileSystemEndpointSuffix        :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId            :
AzureOperationalInsightsEndpointResourceId        :
AzureOperationalInsightsEndpoint                  :
AzureAnalysisServicesEndpointSuffix               :
VersionProfiles                                   : {}
ExtendedProperties                                : {}
BatchEndpointResourceId                           :

In this example we are creating a new Azure environment with sample endpoints using Add-AzureRmEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzureRmEnvironment.

Parameter

-ActiveDirectoryEndpoint

Gibt die Basisautorität für die Microsoft Entra-Authentifizierung an.

Typ:String
Aliase:AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:5
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ActiveDirectoryServiceEndpointResourceId

Gibt die Zielgruppe für Token an, die Anforderungen an Azure Resource Manager- oder Dienstverwaltungsendpunkte (RDFE) authentifizieren.

Typ:String
Position:8
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AdTenant

Gibt den Standardmäßigen Active Directory-Mandanten an.

Typ:String
Position:17
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ARMEndpoint

Der Azure Resource Manager-Endpunkt

Typ:String
Aliase:ArmUrl
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AzureAnalysisServicesEndpointSuffix

Dns-Suffix von Azure Analysis Services-Dienstendpunkten

Typ:String
Position:15
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Dns-Suffix von Azure Data Lake Analytics-Auftrags- und Katalogdiensten

Typ:String
Position:15
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AzureDataLakeStoreFileSystemEndpointSuffix

Dns-Suffix des Azure Data Lake Store FileSystem. Beispiel: azuredatalake.net

Typ:String
Position:14
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AzureKeyVaultDnsSuffix

Gibt das Domänennamensuffix für Key Vault-Dienste an.

Typ:String
Position:10
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AzureKeyVaultServiceEndpointResourceId

Gibt die Zielgruppe für Zugriffstoken an, die Anforderungen für Key Vault-Dienste autorisieren.

Typ:String
Position:11
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AzureOperationalInsightsEndpoint

Gibt den Endpunkt für den Operational Insights-Abfragezugriff an.

Typ:String
Position:22
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-AzureOperationalInsightsEndpointResourceId

Gibt die Zielgruppe für Zugriffstoken an, die Anforderungen für Operational Insights-Dienste autorisieren.

Typ:String
Position:21
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-BatchEndpointResourceId

Der Ressourcenbezeichner des Azure-Batchdiensts, der der Empfänger des angeforderten Tokens ist

Typ:String
Aliase:BatchResourceId, BatchAudience
Position:20
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DataLakeAudience

Die Zielgruppe für Token, die mit dem AD Data Lake-Dienstendpunkt authentifiziert werden.

Typ:String
Aliase:DataLakeEndpointResourceId, DataLakeResourceId
Position:19
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-DefaultProfile

Die credeetnails, tenant and subscription used for communication with azure

Typ:IAzureContextContainer
Aliase:AzureRmContext, AzureCredential
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-EnableAdfsAuthentication

Gibt an, dass Active Directory-Verbunddienste (AD FS) (ADFS) lokale Authentifizierung zulässig ist.

Typ:SwitchParameter
Aliase:OnPremise
Position:16
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-GalleryEndpoint

Gibt den Endpunkt für den Azure Resource Manager-Katalog von Bereitstellungsvorlagen an.

Typ:String
Aliase:Gallery, GalleryUrl
Position:7
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-GraphAudience

Die Zielgruppe für Token, die mit dem AD Graph-Endpunkt authentifiziert werden.

Typ:String
Aliase:GraphEndpointResourceId, GraphResourceId
Position:18
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-GraphEndpoint

Gibt die URL für Graph-Anforderungen (Active Directory-Metadaten) an.

Typ:String
Aliase:Graph, GraphUrl
Position:9
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ManagementPortalUrl

Gibt die URL für das Verwaltungsportal an.

Typ:String
Position:3
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Name

Gibt den Namen der hinzuzufügenden Umgebung an.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-PublishSettingsFileUrl

Gibt die URL an, aus der .publishsettings-Dateien heruntergeladen werden können.

Typ:String
Position:1
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ResourceManagerEndpoint

Gibt die URL für Azure Resource Manager-Anforderungen an.

Typ:String
Aliase:ResourceManager, ResourceManagerUrl
Position:6
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Scope

Bestimmt den Umfang von Kontextänderungen, z. B. ob Änderungen nur für den aktuellen Prozess gelten, oder für alle Sitzungen, die von diesem Benutzer gestartet wurden.

Typ:ContextModificationScope
Zulässige Werte:Process, CurrentUser
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ServiceEndpoint

Gibt den Endpunkt für RDFE-Anforderungen (Service Management) an.

Typ:String
Aliase:ServiceManagement, ServiceManagementUrl
Position:2
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-SqlDatabaseDnsSuffix

Gibt das Suffix "Domänenname" für Azure SQL-Datenbank Server an.

Typ:String
Position:13
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-StorageEndpoint

Gibt den Endpunkt für den Speicherzugriff (Blob, Tabelle, Warteschlange und Datei) an.

Typ:String
Aliase:StorageEndpointSuffix
Position:4
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-TrafficManagerDnsSuffix

Gibt das Suffix des Domänennamens für Azure Traffic Manager-Dienste an.

Typ:String
Position:12
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

String

SwitchParameter

Ausgaben

PSAzureEnvironment