Partilhar 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 do URI

Name Em Necessá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 utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

ManagedEnvironment

OK

Other Status Codes

ErrorResponse

Resposta de erro comum.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Get environments by name

Pedido de amostra

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 da amostra

{
  "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

Name Description
AppLogsConfiguration

Configuração de logs de aplicativos

CertificateKeyVaultProperties

Propriedades de um certificado armazenado em um Cofre de Chaves.

createdByType

O tipo de identidade que criou o recurso.

CustomDomainConfiguration

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

DaprConfiguration

Propriedades de configuração do componente Dapr

Encryption

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

EnvironmentProvisioningState

Estado de provisionamento do Ambiente.

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

Propriedades de configuração do componente Keda

LogAnalyticsConfiguration

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

ManagedEnvironment

Um ambiente para hospedar aplicativos de contêiner

ManagedServiceIdentity

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

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (onde 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 ponto a ponto para o Ambiente Gerenciado

PeerTrafficConfiguration

Configurações de tráfego de mesmo nível para o Ambiente Gerenciado

PrivateEndpoint

O recurso Ponto Final Privado.

PrivateEndpointConnection

O recurso Private Endpoint Connection.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

PrivateEndpointServiceConnectionStatus

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

PrivateLinkServiceConnectionState

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.

PublicNetworkAccess

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

systemData

Metadados referentes à 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 execução do aplicativo de contêiner de escopo.

AppLogsConfiguration

Configuração de logs de aplicativos

Name 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 estiver configurado como 'log-analytics'

CertificateKeyVaultProperties

Propriedades de um certificado armazenado em um Cofre de Chaves.

Name Tipo Description
identity

string

ID de recurso de uma identidade gerida para autenticar com o Azure Key Vault, ou Sistema para usar uma identidade atribuída ao sistema.

keyVaultUrl

string (uri)

URL apontando para o segredo do Cofre da Chave do Azure 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 domínio personalizado do ambiente de aplicativos

Name Tipo Description
certificateKeyVaultProperties

CertificateKeyVaultProperties

Certificado armazenado no Cofre da Chave do Azure.

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 do assunto do certificado.

thumbprint

string

Impressão digital do certificado.

DaprConfiguration

Propriedades de configuração do componente Dapr

Name Tipo Description
version

string

A versão do Dapr

Encryption

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

Name Tipo Description
enabled

boolean

Booleano indicando se a criptografia de tráfego ponto a ponto está habilitada

EnvironmentProvisioningState

Estado de provisionamento do Ambiente.

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

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O alvo do erro.

ErrorResponse

Resposta de erro

Name 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.

Name Tipo Description
headerCountLimit

integer (int32)

Número máximo de cabeçalhos por solicitação permitido 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 é de 4 minutos.

terminationGracePeriodSeconds

integer (int32)

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

workloadProfileName

string

Nome do perfil de carga de trabalho usado pelo componente de ingresso. Required.

KedaConfiguration

Propriedades de configuração do componente Keda

Name Tipo Description
version

string

A versão de Keda

LogAnalyticsConfiguration

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

Name Tipo Description
customerId

string

ID do cliente do Log Analytics

sharedKey

string

Chave do cliente de análise de log

ManagedEnvironment

Um ambiente para hospedar aplicativos de contêiner

Name Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificado 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 geolocalização onde o recurso vive

name

string

O nome do recurso

properties.appLogsConfiguration

AppLogsConfiguration

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

properties.customDomainConfiguration

CustomDomainConfiguration

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

properties.daprAIConnectionString

string

Application Insights connection string usada pela Dapr para exportar telemetria de comunicação Service to Service

properties.daprAIInstrumentationKey

string

Chave de instrumentação Azure Monitor usada pela Dapr para exportar a telemetria de comunicação Service to Service

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 que ocorreram 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 para hospedar recursos de infraestrutura. Se um ID de sub-rede for fornecido, esse grupo de recursos será criado na mesma assinatura que a sub-rede.

properties.ingressConfiguration

IngressConfiguration

Configuração de ingresso para o Ambiente Gerenciado.

properties.kedaConfiguration

KedaConfiguration

A configuração do componente Keda.

properties.peerAuthentication

PeerAuthentication

Configurações de autenticação ponto a ponto para o Ambiente Gerenciado

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Configurações de tráfego de mesmo nível 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: 'Ativado', 'Desativado'.

properties.staticIp

string

IP estático do ambiente

properties.vnetConfiguration

VnetConfiguration

Configuração Vnet para o ambiente

properties.workloadProfiles

WorkloadProfile[]

Perfis de carga de trabalho configurados para o Ambiente Gerenciado.

properties.zoneRedundant

boolean

Se esse Ambiente Gerenciado é ou não redundante de zona.

systemData

systemData

Metadados do Azure Resource Manager contendo 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 do serviço gerenciado (identidades atribuídas pelo sistema e/ou pelo usuário)

Name Tipo Description
principalId

string (uuid)

O ID da entidade de serviço da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

tenantId

string (uuid)

O ID do locatário da identidade atribuída ao sistema. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

type

ManagedServiceIdentityType

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

userAssignedIdentities

<string,  UserAssignedIdentity>

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

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciado (onde 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

Name Tipo Description
enabled

boolean

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

PeerAuthentication

Configurações de autenticação ponto a ponto para o Ambiente Gerenciado

Name Tipo Description
mtls

Mtls

Configurações de autenticação TLS mútua para o ambiente gerenciado

PeerTrafficConfiguration

Configurações de tráfego de mesmo nível para o Ambiente Gerenciado

Name Tipo Description
encryption

Encryption

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

PrivateEndpoint

O recurso Ponto Final Privado.

Name Tipo Description
id

string (arm-id)

O identificador ARM para Private Endpoint

PrivateEndpointConnection

O recurso Private Endpoint Connection.

Name Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificado 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 final privado.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

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

systemData

systemData

Metadados do Azure Resource Manager contendo 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 de ponto de extremidade privado.

Valor Description
Pending
Approved
Rejected
Disconnected

PrivateLinkServiceConnectionState

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.

Name Tipo Description
actionsRequired

string

Uma mensagem indicando se as alterações no prestador de serviços exigem atualizações sobre o consumidor.

description

string

O motivo da aprovação/rejeição da ligaçã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: 'Ativado', 'Desativado'.

Valor Description
Enabled
Disabled

systemData

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

Name 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

Name Tipo Description
clientId

string (uuid)

O ID do cliente da identidade atribuída.

principalId

string (uuid)

O ID principal da identidade atribuída.

VnetConfiguration

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

Name Tipo Description
dockerBridgeCidr

string

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

infrastructureSubnetId

string

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

internal

boolean

Booleano 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 sobrepor-se a quaisquer 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 execução do aplicativo de contêiner de escopo.

Name 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 a serem executadas.

workloadProfileType

string

Tipo de perfil de carga de trabalho para as cargas de trabalho a serem executadas.