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=2024-03-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
environmentName
path True

string

Nome do Ambiente.

resourceGroupName
path True

string

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

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

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

Respostas

Nome Tipo Description
200 OK

ManagedEnvironment

OK

Other Status Codes

DefaultErrorResponse

Resposta de erro comum.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Get environments by name

Sample Request

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

Sample Response

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

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 das propriedades de configuração

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

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

Mtls

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

PeerAuthentication

Configurações de autenticação de pares 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.

VnetConfiguration

Propriedades de configuração para o ambiente de aplicativos ingressar em um 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 de 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'

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CustomDomainConfiguration

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

Nome Tipo Description
certificatePassword

string

Senha de certificado

certificateValue

string

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 de ambiente

expirationDate

string

Data de validade do certificado.

subjectName

string

Nome da entidade do certificado.

thumbprint

string

Impressão digital do certificado.

DaprConfiguration

Componente Dapr das propriedades de configuração

Nome Tipo Description
version

string

A versão do Dapr

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Nome Tipo Description
error

Error

Modelo de erro.

Details

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

target

string

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

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.

Nome Tipo Description
Canceled

string

Failed

string

InfrastructureSetupComplete

string

InfrastructureSetupInProgress

string

InitializationInProgress

string

ScheduledForDelete

string

Succeeded

string

UpgradeFailed

string

UpgradeRequested

string

Waiting

string

Error

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

target

string

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

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

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

string

Tipo de Ambiente.

location

string

A localização geográfica em que 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 um destino. Atualmente, há suporte apenas para "log-analytics"

properties.customDomainConfiguration

CustomDomainConfiguration

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

properties.daprAIConnectionString

string

Application Insights cadeia de conexão usado pelo Dapr para exportar telemetria de comunicação de serviço para serviço

properties.daprAIInstrumentationKey

string

Chave de instrumentação do Azure Monitor usada pelo Dapr para exportar a telemetria de comunicação de Serviço para 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.kedaConfiguration

KedaConfiguration

A configuração do componente Keda.

properties.peerAuthentication

PeerAuthentication

Configurações de autenticação de pares 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

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

tags

object

Marcas de recurso.

type

string

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

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 pares para o Ambiente Gerenciado

Nome Tipo Description
mtls

Mtls

Configurações de autenticação 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

systemData

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

Nome Tipo Description
createdAt

string

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

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.

VnetConfiguration

Propriedades de configuração para o ambiente de aplicativos ingressar em um 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 nenhum outro intervalo de IP fornecido.

infrastructureSubnetId

string

ID de recurso de uma sub-rede para componentes de infraestrutura. Não deve se sobrepor a nenhum outro intervalo de IP fornecido.

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 nenhum outro intervalo de IP fornecido.

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

A capacidade máxima.

minimumCount

integer

A capacidade mínima.

name

string

Tipo de perfil de carga de trabalho para as cargas de trabalho em que executar.

workloadProfileType

string

Tipo de perfil de carga de trabalho para as cargas de trabalho em que executar.