Freigeben über

Add-AzEnvironment

  • Referenz
Modul:
Az.Accounts

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

Syntax

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

Beschreibung

Das Add-AzEnvironment-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

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
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               :
AzureAttestationServiceEndpointSuffix             :
AzureAttestationServiceEndpointResourceId         :
AzureSynapseAnalyticsEndpointSuffix               :
AzureSynapseAnalyticsEndpointResourceId           :
VersionProfiles                                   : {}
ExtendedProperties                                : {}
BatchEndpointResourceId                           :

In diesem Beispiel erstellen wir eine neue Azure-Umgebung mit Beispielendpunkten mit Add-AzEnvironment und ändern dann den Wert der ActiveDirectoryEndpoint- und GraphEndpoint-Attribute der erstellten Umgebung mithilfe des Cmdlets Set-AzEnvironment.

Beispiel 2: Ermitteln einer neuen Umgebung über URI

<#
Uri https://configuredmetadata.net returns an array of environment metadata. The following example contains a payload for the AzureCloud default environment.

[
  {
    "portal": "https://portal.azure.com",
    "authentication": {
      "loginEndpoint": "https://login.microsoftonline.com/",
      "audiences": [
        "https://management.core.windows.net/"
      ],
      "tenant": "common",
      "identityProvider": "AAD"
    },
    "media": "https://rest.media.azure.net",
    "graphAudience": "https://graph.windows.net/",
    "graph": "https://graph.windows.net/",
    "name": "AzureCloud",
    "suffixes": {
      "azureDataLakeStoreFileSystem": "azuredatalakestore.net",
      "acrLoginServer": "azurecr.io",
      "sqlServerHostname": ".database.windows.net",
      "azureDataLakeAnalyticsCatalogAndJob": "azuredatalakeanalytics.net",
      "keyVaultDns": "vault.azure.net",
      "storage": "core.windows.net",
      "azureFrontDoorEndpointSuffix": "azurefd.net"
    },
    "batch": "https://batch.core.windows.net/",
    "resourceManager": "https://management.azure.com/",
    "vmImageAliasDoc": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/arm-compute/quickstart-templates/aliases.json",
    "activeDirectoryDataLake": "https://datalake.azure.net/",
    "sqlManagement": "https://management.core.windows.net:8443/",
    "gallery": "https://gallery.azure.com/"
  },
……
]
#>

Add-AzEnvironment -AutoDiscover -Uri https://configuredmetadata.net

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

In diesem Beispiel entdecken wir eine neue Azure-Umgebung aus dem https://configuredmetadata.net URI.

Parameter

-ActiveDirectoryEndpoint

Gibt die Basisautorität für die Azure Active Directory-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

-AutoDiscover

Ermittelt Umgebungen über den Standard- oder konfigurierten Endpunkt.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-AzureAnalysisServicesEndpointResourceId

Der Ressourcenbezeichner der Azure Analysis Services-Ressource.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-AzureAnalysisServicesEndpointSuffix

Der Endpunkt, der bei der Kommunikation mit der Azure Log Analytics-API verwendet werden soll.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-AzureAttestationServiceEndpointResourceId

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

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

-AzureAttestationServiceEndpointSuffix

Dns-Suffix des Azure-Nachweisdiensts.

Typ:String
Position:Named
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

Dns-Suffix des Azure Key Vault-Diensts. Beispiel ist vault-int.azure-int.net

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

-AzureKeyVaultServiceEndpointResourceId

Ressourcenbezeichner des Azure Key Vault-Datendiensts, der der Empfänger des angeforderten Tokens ist.

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

-AzureOperationalInsightsEndpoint

Der Endpunkt, der bei der Kommunikation mit der Azure Log Analytics-API verwendet werden soll.

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

-AzureOperationalInsightsEndpointResourceId

Die Zielgruppe für Token, die mit der Azure Log Analytics-API authentifiziert werden.

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

-AzureSynapseAnalyticsEndpointResourceId

Der Ressourcenbezeichner der Azure Synapse Analytics, die der Empfänger des angeforderten Tokens ist.

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

-AzureSynapseAnalyticsEndpointSuffix

Dns-Suffix von Azure Synapse Analytics.

Typ:String
Position:Named
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

-ContainerRegistryEndpointSuffix

Suffix der Azure-Containerregistrierung.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
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

Anmeldeinformationen, Mandant und Abonnement, die für die Kommunikation mit Azure verwendet werden

Typ:IAzureContextContainer
Aliase:AzContext, 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. Der Parameter ist das Festlegen des Werts von GalleryUrl .PSAzureEnvironment Wie GalleryUrl aus ArmMetadata entfernt, stellt Azure PowerShell den Wert nicht mehr bereit und es wird daher nicht mehr empfohlen, den Wert festzulegen GalleryEndpoint .

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

-MicrosoftGraphEndpointResourceId

Der Ressourcenbezeichner von Microsoft Graph

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

-MicrosoftGraphUrl

Microsoft Graph-URL

Typ:String
Position:Named
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

-Uri

Gibt den URI der Internetressource an, um Umgebungen abzurufen.

Typ:Uri
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
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