Compartilhar via


Managed Environments - Get

Obtenha as propriedades de um Ambiente Gerenciado usado para hospedar aplicativos de contêiner.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
environmentName
path True

string

Nome do Ambiente.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

A ID da assinatura de destino.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

ManagedEnvironment

OKEY

Other Status Codes

ErrorResponse

Resposta de erro comum.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Get environments by name

Solicitação de exemplo

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

Resposta de exemplo

{
  "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",
    "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"
      }
    ],
    "kedaConfiguration": {
      "version": "2.8.1"
    },
    "daprConfiguration": {
      "version": "1.9"
    },
    "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus",
    "peerAuthentication": {
      "mtls": {
        "enabled": true
      }
    },
    "peerTrafficConfiguration": {
      "encryption": {
        "enabled": true
      }
    },
    "ingressConfiguration": {
      "workloadProfileName": "My-CO-01",
      "terminationGracePeriodSeconds": 3600,
      "headerCountLimit": 30,
      "requestIdleTimeout": 5
    }
  }
}

Definições

Nome Description
AppLogsConfiguration

Configuração de logs de aplicativos

CertificateKeyVaultProperties

Propriedades de um certificado armazenado em um Key Vault.

createdByType

O tipo de identidade que criou o recurso.

CustomDomainConfiguration

Propriedades de configuração para o domínio personalizado do ambiente de aplicativos

DaprConfiguration

Componente dapr de propriedades de configuração

Encryption

Configurações de criptografia de tráfego par para o Ambiente Gerenciado

EnvironmentProvisioningState

Estado de provisionamento do Ambiente.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

IngressConfiguration

Configurações para o componente de entrada, incluindo perfil de carga de trabalho, dimensionamento e manipulação de conexão.

KedaConfiguration

Componente Keda das propriedades de configuração

LogAnalyticsConfiguration

A configuração do Log Analytics só deve ser fornecida quando o destino é configurado como "log-analytics"

ManagedEnvironment

Um ambiente para hospedar aplicativos de contêiner

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

Mtls

Propriedades de configuração para autenticação TLS mútua

PeerAuthentication

Configurações de autenticação de par para o Ambiente Gerenciado

PeerTrafficConfiguration

Configurações de tráfego par para o Ambiente Gerenciado

PrivateEndpoint

O recurso de ponto de extremidade privado.

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

PrivateEndpointServiceConnectionStatus

O status da conexão do ponto de extremidade privado.

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

PublicNetworkAccess

Propriedade para permitir ou bloquear todo o tráfego público. Valores permitidos: 'Habilitado', 'Desabilitado'.

systemData

Metadados relativos à criação e última modificação do recurso.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

VnetConfiguration

Propriedades de configuração para o ambiente de aplicativos ingressar em uma Rede Virtual

WorkloadProfile

Perfil de carga de trabalho para a execução do aplicativo de contêiner de escopo.

AppLogsConfiguration

Configuração de logs de aplicativos

Nome Tipo Description
destination

string

O destino dos logs pode ser 'log-analytics', 'azure-monitor' ou 'none'

logAnalyticsConfiguration

LogAnalyticsConfiguration

A configuração do Log Analytics só deve ser fornecida quando o destino é configurado como "log-analytics"

CertificateKeyVaultProperties

Propriedades de um certificado armazenado em um Key Vault.

Nome Tipo Description
identity

string

ID de recurso de uma identidade gerenciada para autenticar com Azure Key Vault ou Sistema para usar uma identidade atribuída pelo sistema.

keyVaultUrl

string (uri)

URL apontando para o segredo do Azure Key Vault que contém o certificado.

createdByType

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

CustomDomainConfiguration

Propriedades de configuração para o domínio personalizado do ambiente de aplicativos

Nome Tipo Description
certificateKeyVaultProperties

CertificateKeyVaultProperties

Certificado armazenado no Azure Key Vault.

certificatePassword

string

Senha do certificado

certificateValue

string (byte)

Blob PFX ou PEM

customDomainVerificationId

string

ID usado para verificar a propriedade do nome de domínio

dnsSuffix

string

Sufixo Dns para o domínio do ambiente

expirationDate

string (date-time)

Data de validade do certificado.

subjectName

string

Nome da entidade do certificado.

thumbprint

string

Impressão digital do certificado.

DaprConfiguration

Componente dapr de propriedades de configuração

Nome Tipo Description
version

string

A versão do Dapr

Encryption

Configurações de criptografia de tráfego par para o Ambiente Gerenciado

Nome Tipo Description
enabled

boolean

Booliano indicando se a criptografia de tráfego par está habilitada

EnvironmentProvisioningState

Estado de provisionamento do Ambiente.

Valor Description
Succeeded
Failed
Canceled
Waiting
InitializationInProgress
InfrastructureSetupInProgress
InfrastructureSetupComplete
ScheduledForDelete
UpgradeRequested
UpgradeFailed

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

IngressConfiguration

Configurações para o componente de entrada, incluindo perfil de carga de trabalho, dimensionamento e manipulação de conexão.

Nome Tipo Description
headerCountLimit

integer (int32)

Número máximo de cabeçalhos por solicitação permitidos pela entrada. Deve ser pelo menos 1. O padrão é 100.

requestIdleTimeout

integer (int32)

Duração (em minutos) antes que as solicitações ociosas atinjam o tempo limite. Deve ter entre 4 e 30 inclusive. O padrão é 4 minutos.

terminationGracePeriodSeconds

integer (int32)

Tempo (em segundos) para permitir que as conexões ativas sejam concluídas no encerramento. Deve estar entre 0 e 3600. O padrão é 480 segundos.

workloadProfileName

string

Nome do perfil de carga de trabalho usado pelo componente de entrada. Obrigatório

KedaConfiguration

Componente Keda das propriedades de configuração

Nome Tipo Description
version

string

A versão do Keda

LogAnalyticsConfiguration

A configuração do Log Analytics só deve ser fornecida quando o destino é configurado como "log-analytics"

Nome Tipo Description
customerId

string

ID do cliente do Log Analytics

sharedKey

string

Chave do cliente do Log Analytics

ManagedEnvironment

Um ambiente para hospedar aplicativos de contêiner

Nome Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

ManagedServiceIdentity

Identidades gerenciadas para o Ambiente Gerenciado interagir com outros serviços do Azure sem manter segredos ou credenciais no código.

kind

string

Tipo de Ambiente.

location

string

A localização geográfica onde o recurso reside

name

string

O nome do recurso

properties.appLogsConfiguration

AppLogsConfiguration

Configuração de cluster que permite que o daemon de log exporte logs de aplicativo para o destino configurado.

properties.customDomainConfiguration

CustomDomainConfiguration

Configuração de domínio personalizado para o ambiente

properties.daprAIConnectionString

string

Application Insights connection string usado pelo Dapr para exportar telemetria de comunicação de serviço para serviço

properties.daprAIInstrumentationKey

string

Azure Monitor chave de instrumentação usada pelo Dapr para exportar a telemetria de comunicação do Serviço para o Serviço

properties.daprConfiguration

DaprConfiguration

A configuração do componente Dapr.

properties.defaultDomain

string

Nome de domínio padrão para o cluster

properties.deploymentErrors

string

Quaisquer erros ocorridos durante a implantação ou validação da implantação

properties.eventStreamEndpoint

string

O ponto de extremidade do fluxo de eventos do Ambiente.

properties.infrastructureResourceGroup

string

Nome do grupo de recursos gerenciado pela plataforma criado para o Ambiente Gerenciado hospedar recursos de infraestrutura. Se uma ID de sub-rede for fornecida, esse grupo de recursos será criado na mesma assinatura que a sub-rede.

properties.ingressConfiguration

IngressConfiguration

Configuração de entrada para o ambiente gerenciado.

properties.kedaConfiguration

KedaConfiguration

A configuração do componente Keda.

properties.peerAuthentication

PeerAuthentication

Configurações de autenticação de par para o Ambiente Gerenciado

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Configurações de tráfego par para o Ambiente Gerenciado

properties.privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado com o recurso.

properties.provisioningState

EnvironmentProvisioningState

Estado de provisionamento do Ambiente.

properties.publicNetworkAccess

PublicNetworkAccess

Propriedade para permitir ou bloquear todo o tráfego público. Valores permitidos: 'Habilitado', 'Desabilitado'.

properties.staticIp

string

IP estático do ambiente

properties.vnetConfiguration

VnetConfiguration

Configuração de Vnet para o ambiente

properties.workloadProfiles

WorkloadProfile[]

Perfis de carga de trabalho configurados para o Ambiente Gerenciado.

properties.zoneRedundant

boolean

Se esse Ambiente Gerenciado tem ou não redundância de zona.

systemData

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.

tags

object

Tags de recursos.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ManagedServiceIdentity

Identidade de serviço gerenciada (identidades atribuídas pelo sistema e/ou pelo usuário)

Nome Tipo Description
principalId

string (uuid)

A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.

tenantId

string (uuid)

A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.

type

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

userAssignedIdentities

<string,  UserAssignedIdentity>

Identidades de User-Assigned
O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores do dicionário podem ser objetos vazios ({}) em solicitações.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (em que os tipos SystemAssigned e UserAssigned são permitidos).

Valor Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Mtls

Propriedades de configuração para autenticação TLS mútua

Nome Tipo Description
enabled

boolean

Booliano indicando se a autenticação TLS mútua está habilitada

PeerAuthentication

Configurações de autenticação de par para o Ambiente Gerenciado

Nome Tipo Description
mtls

Mtls

Configurações de autenticação de TLS mútuas para o Ambiente Gerenciado

PeerTrafficConfiguration

Configurações de tráfego par para o Ambiente Gerenciado

Nome Tipo Description
encryption

Encryption

Configurações de criptografia de tráfego par para o Ambiente Gerenciado

PrivateEndpoint

O recurso de ponto de extremidade privado.

Nome Tipo Description
id

string (arm-id)

O identificador do ARM para Ponto de Extremidade Privado

PrivateEndpointConnection

O recurso conexão de ponto de extremidade privado.

Nome Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

O nome do recurso

properties.groupIds

string[]

As IDs de grupo para o recurso de ponto de extremidade privado.

properties.privateEndpoint

PrivateEndpoint

O recurso do ponto de extremidade privado.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

O estado de provisionamento do recurso de conexão de ponto de extremidade privado.

systemData

systemData

Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Valor Description
Succeeded
Failed
Canceled
Waiting
Updating
Deleting
Pending

PrivateEndpointServiceConnectionStatus

O status da conexão do ponto de extremidade privado.

Valor Description
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.

Nome Tipo Description
actionsRequired

string

Uma mensagem que indica se as alterações no provedor de serviços exigem atualizações no consumidor.

description

string

O motivo da aprovação/rejeição da conexão.

status

PrivateEndpointServiceConnectionStatus

Indica se a conexão foi aprovada/rejeitada/removida pelo proprietário do serviço.

PublicNetworkAccess

Propriedade para permitir ou bloquear todo o tráfego público. Valores permitidos: 'Habilitado', 'Desabilitado'.

Valor Description
Enabled
Disabled

systemData

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Nome Tipo Description
clientId

string (uuid)

A ID do cliente da identidade atribuída.

principalId

string (uuid)

A ID da entidade de segurança da identidade atribuída.

VnetConfiguration

Propriedades de configuração para o ambiente de aplicativos ingressar em uma Rede Virtual

Nome Tipo Description
dockerBridgeCidr

string

Intervalo de IP de notação CIDR atribuído à ponte do Docker, rede. Não deve se sobrepor a outros intervalos de IP fornecidos.

infrastructureSubnetId

string

ID de recurso de uma sub-rede para componentes de infraestrutura. Não deve se sobrepor a outros intervalos de IP fornecidos.

internal

boolean

Booliano indicando que o ambiente tem apenas um balanceador de carga interno. Esses ambientes não têm um recurso ip estático público. Eles devem fornecer infrastructureSubnetId se habilitar essa propriedade

platformReservedCidr

string

Intervalo de IP na notação CIDR que pode ser reservado para endereços IP de infraestrutura de ambiente. Não deve se sobrepor a outros intervalos de IP fornecidos.

platformReservedDnsIP

string

Um endereço IP do intervalo de IP definido por platformReservedCidr que será reservado para o servidor DNS interno.

WorkloadProfile

Perfil de carga de trabalho para a execução do aplicativo de contêiner de escopo.

Nome Tipo Description
maximumCount

integer (int32)

A capacidade máxima.

minimumCount

integer (int32)

A capacidade mínima.

name

string

Tipo de perfil de carga de trabalho para as cargas de trabalho em execução.

workloadProfileType

string

Tipo de perfil de carga de trabalho para as cargas de trabalho em execução.