Share via

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 weiterhin funktioniert, wird es nicht mehr Standard tained oder unterstützt, wobei eine fortgesetzte Verwendung nach Ermessen und Risiko des Benutzers erfolgt. 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.

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

-ActiveDirectoryServiceEndpointResourceId

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

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

-AdTenant

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

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

-ARMEndpoint

Der Azure Resource Manager-Endpunkt

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

-AzureAnalysisServicesEndpointSuffix

Dns-Suffix von Azure Analysis Services-Dienstendpunkten

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

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

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

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

-AzureDataLakeStoreFileSystemEndpointSuffix

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

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

-AzureKeyVaultDnsSuffix

Gibt das Do Standard Namenssuffix für Key Vault-Dienste an.

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

-AzureKeyVaultServiceEndpointResourceId

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

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

-AzureOperationalInsightsEndpoint

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

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

-AzureOperationalInsightsEndpointResourceId

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

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

-BatchEndpointResourceId

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

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

-Confirm

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

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

-DataLakeAudience

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

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

-DefaultProfile

Die credeetnails, tenant and subscription used for communication with azure

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

-EnableAdfsAuthentication

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

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

-GalleryEndpoint

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

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

-GraphAudience

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

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

-GraphEndpoint

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

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

-ManagementPortalUrl

Gibt die URL für das Verwaltungsportal an.

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

-Name

Gibt den Namen der hinzuzufügenden Umgebung an.

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

-PublishSettingsFileUrl

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

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

-ResourceManagerEndpoint

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

Type:String
Aliases:ResourceManager, ResourceManagerUrl
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

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

-ServiceEndpoint

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

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

-SqlDatabaseDnsSuffix

Gibt das Do Standard namensuffix für Azure SQL-Datenbank Server an.

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

-StorageEndpoint

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

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

-TrafficManagerDnsSuffix

Gibt das Suffix "do Standard name" für Azure Traffic Manager-Dienste an.

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

-WhatIf

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

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

Eingaben

String

SwitchParameter

Ausgaben

PSAzureEnvironment