Partilhar via


Managed Environments - Get

Obtenha as propriedades de um Ambiente Gerido utilizado para alojar aplicações de contentor.

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

Parâmetros do URI

Name Em Necessário Tipo Description
environmentName
path True

string

Nome do Ambiente.

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

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

Respostas

Name Tipo Description
200 OK

ManagedEnvironment

OK

Other Status Codes

DefaultErrorResponse

Resposta de erro comum.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

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

Name Description
AppLogsConfiguration

Configuração dos registos de aplicações

createdByType

O tipo de identidade que criou o recurso.

CustomDomainConfiguration

Propriedades de configuração para o domínio personalizado do ambiente de aplicações

DaprConfiguration

Componente Dapr das propriedades de configuração

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Details

Detalhes ou o erro

Encryption

Definições de encriptação de tráfego de peering para o Ambiente Gerido

EnvironmentProvisioningState

Estado de aprovisionamento do Ambiente.

Error

Modelo de erro.

KedaConfiguration

Componente Keda das propriedades de configuração

LogAnalyticsConfiguration

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

ManagedEnvironment

Um ambiente para alojar aplicações de contentor

Mtls

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

PeerAuthentication

Definições de autenticação de peering para o Ambiente Gerido

PeerTrafficConfiguration

Definições de tráfego de peering para o Ambiente Gerido

systemData

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

VnetConfiguration

Propriedades de configuração para o ambiente de aplicações aderir a um Rede Virtual

WorkloadProfile

Perfil de carga de trabalho para definir o âmbito da execução de aplicações de contentor.

AppLogsConfiguration

Configuração dos registos de aplicações

Name Tipo Description
destination

string

O destino dos registos pode ser "log-analytics", "azure-monitor" ou "none"

logAnalyticsConfiguration

LogAnalyticsConfiguration

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

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CustomDomainConfiguration

Propriedades de configuração para o domínio personalizado do ambiente de aplicações

Name Tipo Description
certificatePassword

string

Palavra-passe do certificado

certificateValue

string

Blob PFX ou PEM

customDomainVerificationId

string

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

dnsSuffix

string

Sufixo Dns para o domínio de ambiente

expirationDate

string

Data de expiração do certificado.

subjectName

string

Nome do requerente do certificado.

thumbprint

string

Thumbprint do certificado.

DaprConfiguration

Componente Dapr das propriedades de configuração

Name Tipo Description
version

string

A versão da Dapr

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name Tipo Description
error

Error

Modelo de erro.

Details

Detalhes ou o erro

Name Tipo Description
code

string

Cadeia padronizada para identificar programaticamente o erro.

message

string

Descrição detalhada do erro e informações de depuração.

target

string

Descrição detalhada do erro e informações de depuração.

Encryption

Definições de encriptação de tráfego de peering para o Ambiente Gerido

Name Tipo Description
enabled

boolean

Valor booleano que indica se a encriptação de tráfego do elemento da rede está ativada

EnvironmentProvisioningState

Estado de aprovisionamento do Ambiente.

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

Name Tipo Description
code

string

Cadeia padronizada para identificar programaticamente o erro.

details

Details[]

Detalhes ou o erro

innererror

string

Mais informações para depurar o erro.

message

string

Descrição detalhada do erro e informações de depuração.

target

string

Descrição detalhada do erro e informações de depuração.

KedaConfiguration

Componente Keda das propriedades de configuração

Name Tipo Description
version

string

A versão de Keda

LogAnalyticsConfiguration

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

Name Tipo Description
customerId

string

ID do cliente do Log Analytics

sharedKey

string

Chave de cliente do Log Analytics

ManagedEnvironment

Um ambiente para alojar aplicações de contentor

Name Tipo Description
id

string

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

kind

string

Tipo de Ambiente.

location

string

A localização geográfica onde o recurso se encontra

name

string

O nome do recurso

properties.appLogsConfiguration

AppLogsConfiguration

Configuração do cluster que permite ao daemon de registo exportar registos de aplicações para um destino. Atualmente, apenas é suportada a "análise de registos"

properties.customDomainConfiguration

CustomDomainConfiguration

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

properties.daprAIConnectionString

string

O Application Insights cadeia de ligação utilizado pela 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 utilizada 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 Predefinido para o cluster

properties.deploymentErrors

string

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

properties.eventStreamEndpoint

string

O ponto final do eventstream do Ambiente.

properties.infrastructureResourceGroup

string

Nome do grupo de recursos gerido pela plataforma criado para o Ambiente Gerido alojar recursos de infraestrutura. Se for fornecido um ID de sub-rede, este grupo de recursos será criado na mesma subscrição que a sub-rede.

properties.kedaConfiguration

KedaConfiguration

A configuração do componente Keda.

properties.peerAuthentication

PeerAuthentication

Definições de autenticação de peering para o Ambiente Gerido

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Definições de tráfego de peering para o Ambiente Gerido

properties.provisioningState

EnvironmentProvisioningState

Estado de aprovisionamento do Ambiente.

properties.staticIp

string

IP Estático do Ambiente

properties.vnetConfiguration

VnetConfiguration

Configuração da Vnet para o ambiente

properties.workloadProfiles

WorkloadProfile[]

Perfis de carga de trabalho configurados para o Ambiente Gerido.

properties.zoneRedundant

boolean

Se este Ambiente Gerido tem ou não redundância entre zonas.

systemData

systemData

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

tags

object

Etiquetas de recursos.

type

string

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

Mtls

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

Name Tipo Description
enabled

boolean

Valor booleano que indica se a autenticação TLS mútua está ativada

PeerAuthentication

Definições de autenticação de peering para o Ambiente Gerido

Name Tipo Description
mtls

Mtls

Definições de autenticação TLS Mútua para o Ambiente Gerido

PeerTrafficConfiguration

Definições de tráfego de peering para o Ambiente Gerido

Name Tipo Description
encryption

Encryption

Definições de encriptação de tráfego de peering para o Ambiente Gerido

systemData

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

Name 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 aplicações aderir a um Rede Virtual

Name Tipo Description
dockerBridgeCidr

string

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

infrastructureSubnetId

string

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

internal

boolean

Valor booleano que indica que o ambiente tem apenas um balanceador de carga interno. Estes ambientes não têm um recurso IP estático público. Têm de fornecer infrastructureSubnetId se ativar esta propriedade

platformReservedCidr

string

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

platformReservedDnsIP

string

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

WorkloadProfile

Perfil de carga de trabalho para definir o âmbito da execução de aplicações de contentor.

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

workloadProfileType

string

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