Поделиться через


Managed Environments - List By Resource Group

Получите все среды в группе ресурсов.
Получите все управляемые среды в группе ресурсов.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments?api-version=2026-01-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя регистронезависимо.

subscriptionId
path True

string

minLength: 1

Идентификатор целевой подписки.

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

ManagedEnvironmentsCollection

ХОРОШО

Other Status Codes

ErrorResponse

Распространенная реакция на ошибки.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation Выдача себя за свою учетную запись пользователя

Примеры

List environments by resource group

Образец запроса

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments?api-version=2026-01-01

Пример ответа

{
  "value": [
    {
      "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1",
      "name": "jlaw-demo1",
      "type": "Microsoft.App/managedEnvironments",
      "location": "North Central US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "deploymentErrors": null,
        "defaultDomain": "jlaw-demo1.k4apps.io",
        "staticIp": "20.42.33.145",
        "appLogsConfiguration": null,
        "zoneRedundant": true,
        "vnetConfiguration": {
          "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"
        },
        "customDomainConfiguration": {
          "customDomainVerificationId": "custom domain verification id",
          "dnsSuffix": "www.my-name.com",
          "subjectName": "CN=www.my-name.com",
          "expirationDate": "2022-11-06T04:00:00Z",
          "thumbprint": "CERTIFICATE_THUMBPRINT"
        },
        "eventStreamEndpoint": "testEndpoint",
        "workloadProfiles": [
          {
            "name": "My-GP-01",
            "workloadProfileType": "GeneralPurpose",
            "minimumCount": 3,
            "maximumCount": 12
          },
          {
            "name": "My-MO-01",
            "workloadProfileType": "MemoryOptimized",
            "minimumCount": 3,
            "maximumCount": 6
          },
          {
            "name": "My-CO-01",
            "workloadProfileType": "ComputeOptimized",
            "minimumCount": 3,
            "maximumCount": 6
          },
          {
            "name": "My-consumption-01",
            "workloadProfileType": "Consumption"
          }
        ],
        "ingressConfiguration": {
          "workloadProfileName": "My-GP-01",
          "terminationGracePeriodSeconds": 600,
          "headerCountLimit": 50,
          "requestIdleTimeout": null
        },
        "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus"
      }
    },
    {
      "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/demo1",
      "name": "demo1",
      "type": "Microsoft.App/managedEnvironments",
      "location": "North Central US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "deploymentErrors": null,
        "defaultDomain": "demo1.k4apps.io",
        "staticIp": "52.142.21.61",
        "appLogsConfiguration": null,
        "zoneRedundant": true,
        "customDomainConfiguration": {
          "customDomainVerificationId": "custom domain verification id",
          "dnsSuffix": "www.my-name2.com",
          "subjectName": "CN=www.my-name2.com",
          "expirationDate": "2022-11-06T04:00:00Z",
          "thumbprint": "CERTIFICATE_THUMBPRINT"
        },
        "eventStreamEndpoint": "testEndpoint",
        "vnetConfiguration": {
          "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"
        },
        "ingressConfiguration": null,
        "infrastructureResourceGroup": "capp-svc-demo1-northcentralus"
      }
    }
  ]
}

Определения

Имя Описание
AppLogsConfiguration

Настройка журналов приложений

CertificateKeyVaultProperties

Свойства сертификата, хранящегося в Key Vault.

createdByType

Тип удостоверения, создавшего ресурс.

CustomDomainConfiguration

Свойства конфигурации для пользовательского домена среды приложений

DaprConfiguration

Компонент Dapr свойств конфигурации

Encryption

Параметры шифрования однорангового трафика для управляемой среды

EnvironmentProvisioningState

Состояние подготовки среды.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Ответ на ошибку

IngressConfiguration

Параметры компонента входящего трафика, включая профиль рабочей нагрузки, масштабирование и обработку подключений.

KedaConfiguration

Компонент Keda свойств конфигурации

LogAnalyticsConfiguration

Конфигурация Log Analytics должна быть предоставлена только в том случае, если назначение настроено как log-analytics.

ManagedEnvironment

Среда для размещения приложений контейнеров

ManagedEnvironmentsCollection

Коллекция сред

ManagedServiceIdentity

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Mtls

Свойства конфигурации для взаимной проверки подлинности TLS

PeerAuthentication

Параметры одноранговой проверки подлинности для управляемой среды

PeerTrafficConfiguration

Параметры однорангового трафика для управляемой среды

PrivateEndpoint

Ресурс частной конечной точки.

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

PrivateLinkServiceConnectionState

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

PublicNetworkAccess

Свойство, позволяющее разрешить или заблокировать весь общедоступный трафик. Допустимые значения: "Включено", "Отключено".

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

UserAssignedIdentity

Свойства назначаемого пользователем удостоверения

VnetConfiguration

Свойства конфигурации среды приложений для присоединения к виртуальной сети

WorkloadProfile

Профиль рабочей нагрузки для области выполнения приложения контейнера.

AppLogsConfiguration

Настройка журналов приложений

Имя Тип Описание
destination

string

Назначение журналов может быть "log-analytics", "azure-monitor" или "none"

logAnalyticsConfiguration

LogAnalyticsConfiguration

Конфигурация Log Analytics должна быть предоставлена только в том случае, если назначение настроено как log-analytics.

CertificateKeyVaultProperties

Свойства сертификата, хранящегося в Key Vault.

Имя Тип Описание
identity

string

Идентификатор ресурса управляемого удостоверения для проверки подлинности с помощью Azure Key Vault или системы для использования назначаемого системой удостоверения.

keyVaultUrl

string (uri)

URL-адрес, указывающий на секрет Azure Key Vault, содержащий сертификат.

createdByType

Тип удостоверения, создавшего ресурс.

Значение Описание
User
Application
ManagedIdentity
Key

CustomDomainConfiguration

Свойства конфигурации для пользовательского домена среды приложений

Имя Тип Описание
certificateKeyVaultProperties

CertificateKeyVaultProperties

Сертификат, хранящийся в Azure Key Vault.

certificatePassword

string

Пароль сертификата

certificateValue

string (byte)

Большой двоичный объект PFX или PEM

customDomainVerificationId

string

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

dnsSuffix

string

Dns-суффикс для домена среды

expirationDate

string (date-time)

Дата окончания срока действия сертификата.

subjectName

string

Имя субъекта сертификата.

thumbprint

string

Отпечаток сертификата.

DaprConfiguration

Компонент Dapr свойств конфигурации

Имя Тип Описание
version

string

Версия Dapr

Encryption

Параметры шифрования однорангового трафика для управляемой среды

Имя Тип Описание
enabled

boolean

Логическое значение, указывающее, включена ли шифрование однорангового трафика

EnvironmentProvisioningState

Состояние подготовки среды.

Значение Описание
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Дополнительный тип сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

IngressConfiguration

Параметры компонента входящего трафика, включая профиль рабочей нагрузки, масштабирование и обработку подключений.

Имя Тип Описание
headerCountLimit

integer (int32)

Максимальное количество заголовков на запрос, разрешенное входящим трафиком. Должно быть не менее 1. Значение по умолчанию — 100.

requestIdleTimeout

integer (int32)

Продолжительность (в минутах) до истечения времени ожидания неактивных запросов. Должно быть от 4 до 30 включительно. По умолчанию 4 минуты.

terminationGracePeriodSeconds

integer (int32)

Время (в секундах) для завершения активных соединений при завершении. Должно быть в диапазоне от 0 до 3600. По умолчанию 480 секунд.

workloadProfileName

string

Имя профиля рабочей нагрузки, используемого компонентом входящего трафика. Обязательно.

KedaConfiguration

Компонент Keda свойств конфигурации

Имя Тип Описание
version

string

Версия Кеда

LogAnalyticsConfiguration

Конфигурация Log Analytics должна быть предоставлена только в том случае, если назначение настроено как log-analytics.

Имя Тип Описание
customerId

string

Идентификатор клиента Log Analytics

sharedKey

string

Ключ клиента Log Analytics

ManagedEnvironment

Среда для размещения приложений контейнеров

Имя Тип Описание
id

string (arm-id)

Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

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

kind

string

Тип среды.

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса

properties.appLogsConfiguration

AppLogsConfiguration

Конфигурация кластера, которая позволяет управляющей программе журнала экспортировать журналы приложений в настроенное назначение.

properties.customDomainConfiguration

CustomDomainConfiguration

Конфигурация личного домена для среды

properties.daprAIConnectionString

string

Application Insights connection string, используемый Dapr для экспорта службы в данные телеметрии связи службы

properties.daprAIInstrumentationKey

string

Azure Monitor ключ инструментирования, используемый Dapr для экспорта службы в данные телеметрии связи службы

properties.daprConfiguration

DaprConfiguration

Конфигурация компонента Dapr.

properties.defaultDomain

string

Доменное имя по умолчанию для кластера

properties.deploymentErrors

string

Любые ошибки, возникшие во время развертывания или проверки развертывания

properties.eventStreamEndpoint

string

Конечная точка потока событий среды.

properties.infrastructureResourceGroup

string

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

properties.ingressConfiguration

IngressConfiguration

Конфигурация входящего трафика для управляемой среды.

properties.kedaConfiguration

KedaConfiguration

Конфигурация компонента Keda.

properties.peerAuthentication

PeerAuthentication

Параметры одноранговой проверки подлинности для управляемой среды

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Параметры однорангового трафика для управляемой среды

properties.privateEndpointConnections

PrivateEndpointConnection[]

Подключения частной конечной точки к ресурсу.

properties.provisioningState

EnvironmentProvisioningState

Состояние подготовки среды.

properties.publicNetworkAccess

PublicNetworkAccess

Свойство, позволяющее разрешить или заблокировать весь общедоступный трафик. Допустимые значения: "Включено", "Отключено".

properties.staticIp

string

Статический IP среды

properties.vnetConfiguration

VnetConfiguration

Конфигурация виртуальной сети для среды

properties.workloadProfiles

WorkloadProfile[]

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

properties.zoneRedundant

boolean

Независимо от того, является ли эта управляемая среда избыточной по зонам.

systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ManagedEnvironmentsCollection

Коллекция сред

Имя Тип Описание
nextLink

string

Ссылка на следующую страницу ресурсов.

value

ManagedEnvironment[]

Сбор ресурсов.

ManagedServiceIdentity

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

Имя Тип Описание
principalId

string (uuid)

Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.

tenantId

string (uuid)

Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.

type

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

userAssignedIdentities

<string,  UserAssignedIdentity>

удостоверения User-Assigned
Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Mtls

Свойства конфигурации для взаимной проверки подлинности TLS

Имя Тип Описание
enabled

boolean

Логическое значение, указывающее, включена ли взаимная проверка подлинности TLS

PeerAuthentication

Параметры одноранговой проверки подлинности для управляемой среды

Имя Тип Описание
mtls

Mtls

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

PeerTrafficConfiguration

Параметры однорангового трафика для управляемой среды

Имя Тип Описание
encryption

Encryption

Параметры шифрования однорангового трафика для управляемой среды

PrivateEndpoint

Ресурс частной конечной точки.

Имя Тип Описание
id

string (arm-id)

Идентификатор ARM для частной конечной точки

PrivateEndpointConnection

Ресурс подключения к частной конечной точке.

Имя Тип Описание
id

string (arm-id)

Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

Имя ресурса

properties.groupIds

string[]

Идентификаторы группы для ресурса частной конечной точки.

properties.privateEndpoint

PrivateEndpoint

Ресурс частной конечной точки.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

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

properties.provisioningState

PrivateEndpointConnectionProvisioningState

Состояние подготовки ресурса подключения частной конечной точки.

systemData

systemData

Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

Текущее состояние подготовки.

Значение Описание
Succeeded
Failed
Canceled
Waiting
Updating
Deleting
Pending

PrivateEndpointServiceConnectionStatus

Состояние подключения к частной конечной точке.

Значение Описание
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

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

Имя Тип Описание
actionsRequired

string

Сообщение, указывающее, требуются ли изменения в поставщике услуг, требуются какие-либо обновления для потребителя.

description

string

Причина утверждения или отклонения подключения.

status

PrivateEndpointServiceConnectionStatus

Указывает, утверждено ли подключение, отклонено или удалено владельцем службы.

PublicNetworkAccess

Свойство, позволяющее разрешить или заблокировать весь общедоступный трафик. Допустимые значения: "Включено", "Отключено".

Значение Описание
Enabled
Disabled

systemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя Тип Описание
createdAt

string (date-time)

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string (date-time)

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Идентификатор, который последний раз изменил ресурс.

lastModifiedByType

createdByType

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

UserAssignedIdentity

Свойства назначаемого пользователем удостоверения

Имя Тип Описание
clientId

string (uuid)

Идентификатор клиента назначенного удостоверения.

principalId

string (uuid)

Основной идентификатор назначенного удостоверения.

VnetConfiguration

Свойства конфигурации среды приложений для присоединения к виртуальной сети

Имя Тип Описание
dockerBridgeCidr

string

Диапазон IP-адресов ciDR, назначенный мосту Docker, сети. Не должны перекрываться с другими предоставленными диапазонами IP-адресов.

infrastructureSubnetId

string

Идентификатор ресурса подсети для компонентов инфраструктуры. Не должны перекрываться с другими предоставленными диапазонами IP-адресов.

internal

boolean

Логическое значение, указывающее, что среда имеет только внутреннюю подсистему балансировки нагрузки. В этих средах нет ресурса общедоступного статического IP-адреса. При включении этого свойства они должны предоставить инфраструктуруSubnetId.

platformReservedCidr

string

Диапазон IP-адресов в нотации CIDR, который можно зарезервировать для IP-адресов инфраструктуры среды. Не должны перекрываться с другими предоставленными диапазонами IP-адресов.

platformReservedDnsIP

string

IP-адрес из диапазона IP-адресов, определенный платформойReservedCidr, который будет зарезервирован для внутреннего DNS-сервера.

WorkloadProfile

Профиль рабочей нагрузки для области выполнения приложения контейнера.

Имя Тип Описание
maximumCount

integer (int32)

Максимальная емкость.

minimumCount

integer (int32)

Минимальная емкость.

name

string

Тип профиля рабочей нагрузки для рабочих нагрузок для запуска рабочих нагрузок.

workloadProfileType

string

Тип профиля рабочей нагрузки для рабочих нагрузок для запуска рабочих нагрузок.