Compartilhar via

Managed Environments - Get

  • Referência
Serviço:
Azure Container Apps
Versão da API:
2025-01-01

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=2025-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

DefaultErrorResponse

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=2025-01-01

Resposta de exemplo

Código de status:
200 
{
  "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
      }
    }
  }
}

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
DefaultErrorResponse

Resposta de erro do Serviço de Aplicativo.
Details

Detalhes ou o erro
Encryption

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

Estado de provisionamento do Ambiente.
Error

Modelo de erro.
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
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

Objeto

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

Objeto

Propriedades de um certificado armazenado em um Key Vault.

Nome Tipo Description
identity

string

ID de recurso de uma identidade gerenciada para autenticar com o Azure Key Vault ou o 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

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

CustomDomainConfiguration

Objeto

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

Objeto

Componente dapr de propriedades de configuração

Nome Tipo Description
version

string

A versão do Dapr

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome Tipo Description
error

Error

Modelo de erro.

Details

Objeto

Detalhes ou o erro

Nome Tipo Description
code

string

Cadeia de caracteres padronizada para identificar programaticamente o erro.
message

string

Informações detalhadas de descrição e depuração de erros.
target

string

Informações detalhadas de descrição e depuração de erros.

Encryption

Objeto

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

Enumeração

Estado de provisionamento do Ambiente.

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

Error

Objeto

Modelo de erro.

Nome Tipo Description
code

string

Cadeia de caracteres padronizada para identificar programaticamente o erro.
details

Details[]

Detalhes ou o erro
innererror

string

Mais informações para depurar o erro.
message

string

Informações detalhadas de descrição e depuração de erros.
target

string

Informações detalhadas de descrição e depuração de erros.

KedaConfiguration

Objeto

Componente Keda das propriedades de configuração

Nome Tipo Description
version

string

A versão do Keda

LogAnalyticsConfiguration

Objeto

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

Objeto

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

Cadeia de conexão do Application Insights usada pelo Dapr para exportar a telemetria de comunicação do Serviço para o Serviço
properties.daprAIInstrumentationKey

string

Chave de instrumentação do Azure Monitor usada pela 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

Todos os erros que ocorreram durante a implantação ou validação de 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.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.provisioningState

EnvironmentProvisioningState

Estado de provisionamento do Ambiente.
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

Marcas de recurso.
type

string

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

ManagedServiceIdentity

Objeto

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

Enumeração

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

Valor Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

Mtls

Objeto

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

Objeto

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

Objeto

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

systemData

Objeto

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

Objeto

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

Objeto

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

Objeto

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.