Share via


Managed Environments - Get

Obtenga las propiedades de un entorno administrado que se usa para hospedar aplicaciones de contenedor.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
environmentName
path True

string

Nombre del entorno.

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

ManagedEnvironment

Aceptar

Other Status Codes

DefaultErrorResponse

Respuesta de error común.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre Description
AppLogsConfiguration

Configuración de registros de aplicaciones

createdByType

Tipo de identidad que creó el recurso.

CustomDomainConfiguration

Propiedades de configuración para el dominio personalizado del entorno de aplicaciones

DaprConfiguration

Componente Dapr de propiedades de configuración

DefaultErrorResponse

App Service respuesta de error.

Details

Detalles o el error

Encryption

Configuración de cifrado del tráfico del mismo nivel para el entorno administrado

EnvironmentProvisioningState

Estado de aprovisionamiento del entorno.

Error

Modelo de error.

KedaConfiguration

Componente Keda de propiedades de configuración

LogAnalyticsConfiguration

La configuración de Log Analytics solo se debe proporcionar cuando el destino está configurado como "log-analytics".

ManagedEnvironment

Un entorno para hospedar aplicaciones de contenedor

Mtls

Propiedades de configuración para la autenticación TLS mutua

PeerAuthentication

Configuración de autenticación del mismo nivel para el entorno administrado

PeerTrafficConfiguration

Configuración del tráfico del mismo nivel para el entorno administrado

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

VnetConfiguration

Propiedades de configuración del entorno de aplicaciones para unir una Virtual Network

WorkloadProfile

Perfil de carga de trabajo para definir el ámbito de la ejecución de la aplicación contenedora.

AppLogsConfiguration

Configuración de registros de aplicaciones

Nombre Tipo Description
destination

string

El destino de los registros puede ser "log-analytics", "azure-monitor" o "none".

logAnalyticsConfiguration

LogAnalyticsConfiguration

La configuración de Log Analytics solo se debe proporcionar cuando el destino está configurado como "log-analytics".

createdByType

Tipo de identidad que creó el recurso.

Nombre Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

CustomDomainConfiguration

Propiedades de configuración para el dominio personalizado del entorno de aplicaciones

Nombre Tipo Description
certificatePassword

string

Contraseña del certificado

certificateValue

string

Blob PFX o PEM

customDomainVerificationId

string

Identificador usado para comprobar la propiedad del nombre de dominio

dnsSuffix

string

Sufijo DNS para el dominio de entorno

expirationDate

string

Fecha de expiración del certificado.

subjectName

string

Nombre del firmante del certificado.

thumbprint

string

Huella digital del certificado.

DaprConfiguration

Componente Dapr de propiedades de configuración

Nombre Tipo Description
version

string

La versión de Dapr

DefaultErrorResponse

App Service respuesta de error.

Nombre Tipo Description
error

Error

Modelo de error.

Details

Detalles o el error

Nombre Tipo Description
code

string

Cadena estandarizada para identificar mediante programación el error.

message

string

Descripción detallada del error e información de depuración.

target

string

Descripción detallada del error e información de depuración.

Encryption

Configuración de cifrado del tráfico del mismo nivel para el entorno administrado

Nombre Tipo Description
enabled

boolean

Boolean que indica si el cifrado de tráfico del mismo nivel está habilitado

EnvironmentProvisioningState

Estado de aprovisionamiento del entorno.

Nombre 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 error.

Nombre Tipo Description
code

string

Cadena estandarizada para identificar mediante programación el error.

details

Details[]

Detalles o el error

innererror

string

Más información para depurar el error.

message

string

Descripción detallada del error e información de depuración.

target

string

Descripción detallada del error e información de depuración.

KedaConfiguration

Componente Keda de propiedades de configuración

Nombre Tipo Description
version

string

La versión de Keda

LogAnalyticsConfiguration

La configuración de Log Analytics solo se debe proporcionar cuando el destino está configurado como "log-analytics".

Nombre Tipo Description
customerId

string

Identificador de cliente de Log Analytics

sharedKey

string

Clave de cliente de Log Analytics

ManagedEnvironment

Un entorno para hospedar aplicaciones de contenedor

Nombre Tipo Description
id

string

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

string

Tipo de entorno.

location

string

Ubicación geográfica donde reside el recurso

name

string

Nombre del recurso.

properties.appLogsConfiguration

AppLogsConfiguration

Configuración del clúster que permite que el demonio de registro exporte los registros de la aplicación a un destino. Actualmente solo se admite "log-analytics"

properties.customDomainConfiguration

CustomDomainConfiguration

Configuración de dominio personalizada para el entorno

properties.daprAIConnectionString

string

Application Insights cadena de conexión que usa Dapr para exportar datos de telemetría de comunicación de servicio a servicio

properties.daprAIInstrumentationKey

string

Clave de instrumentación de Azure Monitor usada por Dapr para exportar la telemetría de comunicación del servicio al servicio

properties.daprConfiguration

DaprConfiguration

Configuración del componente Dapr.

properties.defaultDomain

string

Nombre de dominio predeterminado para el clúster

properties.deploymentErrors

string

Errores que se produjeron durante la implementación o validación de la implementación

properties.eventStreamEndpoint

string

Punto de conexión de la secuencia de eventos del entorno.

properties.infrastructureResourceGroup

string

Nombre del grupo de recursos administrado por la plataforma creado para el entorno administrado para hospedar recursos de infraestructura. Si se proporciona un identificador de subred, este grupo de recursos se creará en la misma suscripción que la subred.

properties.kedaConfiguration

KedaConfiguration

Configuración del componente Keda.

properties.peerAuthentication

PeerAuthentication

Configuración de autenticación del mismo nivel para el entorno administrado

properties.peerTrafficConfiguration

PeerTrafficConfiguration

Configuración del tráfico del mismo nivel para el entorno administrado

properties.provisioningState

EnvironmentProvisioningState

Estado de aprovisionamiento del entorno.

properties.staticIp

string

Dirección IP estática del entorno

properties.vnetConfiguration

VnetConfiguration

Configuración de red virtual para el entorno

properties.workloadProfiles

WorkloadProfile[]

Perfiles de carga de trabajo configurados para el entorno administrado.

properties.zoneRedundant

boolean

Si este entorno administrado es o no con redundancia de zona.

systemData

systemData

Metadatos de Azure Resource Manager que contienen información sobre los valores de createdBy y modifiedBy.

tags

object

Etiquetas del recurso.

type

string

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

Mtls

Propiedades de configuración para la autenticación TLS mutua

Nombre Tipo Description
enabled

boolean

Boolean que indica si la autenticación TLS mutua está habilitada

PeerAuthentication

Configuración de autenticación del mismo nivel para el entorno administrado

Nombre Tipo Description
mtls

Mtls

Configuración de autenticación TLS mutua para el entorno administrado

PeerTrafficConfiguration

Configuración del tráfico del mismo nivel para el entorno administrado

Nombre Tipo Description
encryption

Encryption

Configuración de cifrado del tráfico del mismo nivel para el entorno administrado

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre Tipo Description
createdAt

string

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.

VnetConfiguration

Propiedades de configuración del entorno de aplicaciones para unir una Virtual Network

Nombre Tipo Description
dockerBridgeCidr

string

Intervalo IP de notación CIDR asignado al puente de Docker, red. No debe superponerse con ningún otro intervalo IP proporcionado.

infrastructureSubnetId

string

Identificador de recurso de una subred para los componentes de infraestructura. No debe superponerse con ningún otro intervalo IP proporcionado.

internal

boolean

Boolean que indica que el entorno solo tiene un equilibrador de carga interno. Estos entornos no tienen un recurso de DIRECCIÓN IP estática pública. Deben proporcionar infrastructureSubnetId si habilita esta propiedad.

platformReservedCidr

string

Intervalo IP en notación CIDR que se puede reservar para direcciones IP de infraestructura de entorno. No debe superponerse con ningún otro intervalo IP proporcionado.

platformReservedDnsIP

string

Una dirección IP del intervalo IP definido por platformReservedCidr que se reservará para el servidor DNS interno.

WorkloadProfile

Perfil de carga de trabajo para definir el ámbito de la ejecución de la aplicación contenedora.

Nombre Tipo Description
maximumCount

integer

Capacidad máxima.

minimumCount

integer

Capacidad mínima.

name

string

Tipo de perfil de carga de trabajo en el que se ejecutarán las cargas de trabajo.

workloadProfileType

string

Tipo de perfil de carga de trabajo en el que se ejecutarán las cargas de trabajo.