Add-AzEnvironment

Модуль:

Az.Accounts

Добавляет конечные точки и метаданные для экземпляра Azure Resource Manager.

Синтаксис

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

Описание

Командлет Add-AzEnvironment добавляет конечные точки и метаданные, чтобы разрешить командлетам Azure Resource Manager подключаться к новому экземпляру Azure Resource Manager. Встроенные среды AzureCloud и AzureChinaCloud предназначены для существующих общедоступных экземпляров Azure Resource Manager.

Примеры

Пример 1. Создание и изменение новой среды

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                           :

В этом примере мы создадим новую среду Azure с примерами конечных точек с помощью Add-AzEnvironment, а затем мы изменим значение атрибутов ActiveDirectoryEndpoint и GraphEndpoint созданной среды с помощью командлета Set-AzEnvironment.

Пример 2. Обнаружение новой среды с помощью 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/

В этом примере мы обнаруживаем новую среду Azure из https://configuredmetadata.net URI.

Параметры

-ActiveDirectoryEndpoint

Указывает базовый центр проверки подлинности Azure Active Directory.

Тип:	String
Aliases:	AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:	5
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ActiveDirectoryServiceEndpointResourceId

Указывает аудиторию маркеров, прошедших проверку подлинности запросов к конечным точкам Azure Resource Manager или Service Management (RDFE).

Тип:	String
Position:	8
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AdTenant

Указывает клиент Active Directory по умолчанию.

Тип:	String
Position:	17
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ARMEndpoint

Конечная точка Azure Resource Manager

Тип:	String
Aliases:	ArmUrl
Position:	1
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AutoDiscover

Обнаруживает среды с помощью конечной точки по умолчанию или настроенной конечной точки.

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-AzureAnalysisServicesEndpointResourceId

Идентификатор ресурса ресурса Azure Analysis Services.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-AzureAnalysisServicesEndpointSuffix

Конечная точка, используемая при взаимодействии с API Azure Log Analytics.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-AzureAttestationServiceEndpointResourceId

Идентификатор ресурса службы аттестации Azure, которая является получателем запрошенного токена.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureAttestationServiceEndpointSuffix

Суффикс Dns службы аттестации Azure.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Dns-суффикс заданий и служб каталога Azure Data Lake Analytics

Тип:	String
Position:	15
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureDataLakeStoreFileSystemEndpointSuffix

Dns-суффикс файловой системы Azure Data Lake Store. Пример: azuredatalake.net

Тип:	String
Position:	14
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureKeyVaultDnsSuffix

Суффикс Dns службы Azure Key Vault. Примером является vault-int.azure-int.net

Тип:	String
Position:	10
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureKeyVaultServiceEndpointResourceId

Идентификатор ресурса службы данных Azure Key Vault, которая является получателем запрошенного маркера.

Тип:	String
Position:	11
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureOperationalInsightsEndpoint

Конечная точка, используемая при взаимодействии с API Azure Log Analytics.

Тип:	String
Position:	22
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureOperationalInsightsEndpointResourceId

Аудитория для проверки подлинности маркеров с помощью API Azure Log Analytics.

Тип:	String
Position:	21
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureSynapseAnalyticsEndpointResourceId

Идентификатор ресурса Azure Synapse Analytics, который является получателем запрошенного токена.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AzureSynapseAnalyticsEndpointSuffix

Суффикс Dns в Azure Synapse Analytics.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-BatchEndpointResourceId

Идентификатор ресурса пакетной службы Azure, который является получателем запрошенного маркера.

Тип:	String
Aliases:	BatchResourceId, BatchAudience
Position:	20
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ContainerRegistryEndpointSuffix

Суффикс реестра контейнеров Azure.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-DataLakeAudience

Аудитория маркеров проверки подлинности с помощью конечной точки служб AD Data Lake.

Тип:	String
Aliases:	DataLakeEndpointResourceId, DataLakeResourceId
Position:	19
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-DefaultProfile

Учетные данные, клиент и подписка, используемые для обмена данными с Azure

Тип:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-EnableAdfsAuthentication

Указывает, что локальная проверка подлинности служб федерации Active Directory (ADFS) разрешена.

Тип:	SwitchParameter
Aliases:	OnPremise
Position:	16
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-GalleryEndpoint

Указывает конечную точку для коллекции шаблонов развертывания Azure Resource Manager. Параметр — задать значение GalleryUrlPSAzureEnvironment. Так как GalleryUrl удаляется из ArmMetadata, Azure PowerShell больше не будет предоставлять значение и поэтому больше не рекомендуется задавать GalleryEndpoint.

Тип:	String
Aliases:	Gallery, GalleryUrl
Position:	7
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-GraphAudience

Аудитория для маркеров проверки подлинности с помощью конечной точки Graph AD.

Тип:	String
Aliases:	GraphEndpointResourceId, GraphResourceId
Position:	18
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-GraphEndpoint

Задает URL-адрес для запросов метаданных Graph (Active Directory).

Тип:	String
Aliases:	Graph, GraphUrl
Position:	9
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ManagementPortalUrl

Указывает URL-адрес портала управления.

Тип:	String
Position:	3
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-MicrosoftGraphEndpointResourceId

Идентификатор ресурса Microsoft Graph

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-MicrosoftGraphUrl

URL-адрес Microsoft Graph

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Name

Указывает имя добавляемой среды.

Тип:	String
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-PublishSettingsFileUrl

Указывает URL-адрес, из которого можно скачать файлы publishsettings.

Тип:	String
Position:	1
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ResourceManagerEndpoint

Указывает URL-адрес запросов Azure Resource Manager.

Тип:	String
Aliases:	ResourceManager, ResourceManagerUrl
Position:	6
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Scope

Определяет область изменений контекста, например, применяются ли изменения только к текущему процессу или ко всем сеансам, запущенным этим пользователем.

Тип:	ContextModificationScope
Допустимые значения:	Process, CurrentUser
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-ServiceEndpoint

Указывает конечную точку для запросов управления службами (RDFE).

Тип:	String
Aliases:	ServiceManagement, ServiceManagementUrl
Position:	2
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-SqlDatabaseDnsSuffix

Указывает суффикс доменного имени для серверов базы данных SQL Azure.

Тип:	String
Position:	13
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-StorageEndpoint

Указывает конечную точку для доступа к хранилищу (BLOB-объектам, таблицам, очередям и файлам).

Тип:	String
Aliases:	StorageEndpointSuffix
Position:	4
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-TrafficManagerDnsSuffix

Указывает суффикс доменного имени для служб Диспетчера трафика Azure.

Тип:	String
Position:	12
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Uri

Задает универсальный код ресурса Интернета для получения сред.

Тип:	Uri
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

Тип:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

Входные данные

String

SwitchParameter

Выходные данные

PSAzureEnvironment

Связанные ссылки

• Get-AzEnvironment
• Remove-AzEnvironment
• Set-AzEnvironment