Add-AzEnvironment

Добавляет конечные точки и метаданные для экземпляра 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.

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

-ActiveDirectoryServiceEndpointResourceId

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

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

-AdTenant

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

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

-ARMEndpoint

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

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

-AutoDiscover

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

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-AzureAnalysisServicesEndpointResourceId

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

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

-AzureAnalysisServicesEndpointSuffix

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

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

-AzureAttestationServiceEndpointResourceId

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

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

-AzureAttestationServiceEndpointSuffix

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

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

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

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

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

-AzureDataLakeStoreFileSystemEndpointSuffix

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

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

-AzureKeyVaultDnsSuffix

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

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

-AzureKeyVaultServiceEndpointResourceId

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

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

-AzureOperationalInsightsEndpoint

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

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

-AzureOperationalInsightsEndpointResourceId

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

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

-AzureSynapseAnalyticsEndpointResourceId

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

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

-AzureSynapseAnalyticsEndpointSuffix

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

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

-BatchEndpointResourceId

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

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

-Confirm

Запрос подтверждения перед выполнением командлета.

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

-ContainerRegistryEndpointSuffix

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

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

-DataLakeAudience

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

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

-DefaultProfile

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

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

-EnableAdfsAuthentication

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

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

-GalleryEndpoint

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

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

-GraphAudience

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

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

-GraphEndpoint

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

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

-ManagementPortalUrl

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

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

-MicrosoftGraphEndpointResourceId

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

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

-MicrosoftGraphUrl

URL-адрес Microsoft Graph

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

-Name

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

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

-PublishSettingsFileUrl

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

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

-ResourceManagerEndpoint

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

Type:String
Aliases:ResourceManager, ResourceManagerUrl
Position:6
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Scope

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

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

-ServiceEndpoint

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

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

-SqlDatabaseDnsSuffix

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

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

-StorageEndpoint

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

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

-TrafficManagerDnsSuffix

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

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

-Uri

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

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

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

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

String

SwitchParameter

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

PSAzureEnvironment