Managed Environments - Get

Servicio:

Azure Container Apps

Versión de la API:

2024-03-01

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 no 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 la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ManagedEnvironment	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error común.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get environments by name

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for ManagedEnvironments GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_Get.json
     */
    /**
     * Sample code: Get environments by name.
     * 
     * @param manager Entry point to ContainerAppsApiManager.
     */
    public static void getEnvironmentsByName(com.azure.resourcemanager.appcontainers.ContainerAppsApiManager manager) {
        manager.managedEnvironments().getByResourceGroupWithResponse("examplerg", "jlaw-demo1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.appcontainers import ContainerAppsAPIClient
"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appcontainers
# USAGE
    python managed_environments_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
    client = ContainerAppsAPIClient(
        credential=DefaultAzureCredential(),
        subscription_id="8efdecc5-919e-44eb-b179-915dca89ebf9",
    )

    response = client.managed_environments.get(
        resource_group_name='examplerg',
        environment_name='jlaw-demo1',
    )
    print(response)

# x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_Get.json
if __name__ == "__main__":
    main()
n__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappcontainers_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/edf14cc0a577f6b9c4e3ce018cec0c383e64b7b0/specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_Get.json
func ExampleManagedEnvironmentsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappcontainers.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewManagedEnvironmentsClient().Get(ctx, "examplerg", "jlaw-demo1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ManagedEnvironment = armappcontainers.ManagedEnvironment{
	// 	Name: to.Ptr("jlaw-demo1"),
	// 	Type: to.Ptr("Microsoft.App/managedEnvironments"),
	// 	ID: to.Ptr("/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1"),
	// 	Location: to.Ptr("North Central US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armappcontainers.ManagedEnvironmentProperties{
	// 		CustomDomainConfiguration: &armappcontainers.CustomDomainConfiguration{
	// 			CustomDomainVerificationID: to.Ptr("custom domain verification id"),
	// 			DNSSuffix: to.Ptr("www.my-name.com"),
	// 			ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-06T04:00:00.000Z"); return t}()),
	// 			SubjectName: to.Ptr("CN=www.my-name.com"),
	// 			Thumbprint: to.Ptr("CERTIFICATE_THUMBPRINT"),
	// 		},
	// 		DaprConfiguration: &armappcontainers.DaprConfiguration{
	// 			Version: to.Ptr("1.9"),
	// 		},
	// 		DefaultDomain: to.Ptr("jlaw-demo1.k4apps.io"),
	// 		EventStreamEndpoint: to.Ptr("testEndpoint"),
	// 		InfrastructureResourceGroup: to.Ptr("capp-svc-jlaw-demo1-northcentralus"),
	// 		KedaConfiguration: &armappcontainers.KedaConfiguration{
	// 			Version: to.Ptr("2.8.1"),
	// 		},
	// 		PeerAuthentication: &armappcontainers.ManagedEnvironmentPropertiesPeerAuthentication{
	// 			Mtls: &armappcontainers.Mtls{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		PeerTrafficConfiguration: &armappcontainers.ManagedEnvironmentPropertiesPeerTrafficConfiguration{
	// 			Encryption: &armappcontainers.ManagedEnvironmentPropertiesPeerTrafficConfigurationEncryption{
	// 				Enabled: to.Ptr(true),
	// 			},
	// 		},
	// 		ProvisioningState: to.Ptr(armappcontainers.EnvironmentProvisioningStateSucceeded),
	// 		StaticIP: to.Ptr("20.42.33.145"),
	// 		VnetConfiguration: &armappcontainers.VnetConfiguration{
	// 			InfrastructureSubnetID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1"),
	// 		},
	// 		WorkloadProfiles: []*armappcontainers.WorkloadProfile{
	// 			{
	// 				Name: to.Ptr("My-GP-01"),
	// 				MaximumCount: to.Ptr[int32](12),
	// 				MinimumCount: to.Ptr[int32](3),
	// 				WorkloadProfileType: to.Ptr("GeneralPurpose"),
	// 			},
	// 			{
	// 				Name: to.Ptr("My-MO-01"),
	// 				MaximumCount: to.Ptr[int32](6),
	// 				MinimumCount: to.Ptr[int32](3),
	// 				WorkloadProfileType: to.Ptr("MemoryOptimized"),
	// 			},
	// 			{
	// 				Name: to.Ptr("My-CO-01"),
	// 				MaximumCount: to.Ptr[int32](6),
	// 				MinimumCount: to.Ptr[int32](3),
	// 				WorkloadProfileType: to.Ptr("ComputeOptimized"),
	// 			},
	// 			{
	// 				Name: to.Ptr("My-consumption-01"),
	// 				WorkloadProfileType: to.Ptr("Consumption"),
	// 		}},
	// 		ZoneRedundant: to.Ptr(true),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ContainerAppsAPIClient } = require("@azure/arm-appcontainers");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the properties of a Managed Environment used to host container apps.
 *
 * @summary Get the properties of a Managed Environment used to host container apps.
 * x-ms-original-file: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_Get.json
 */
async function getEnvironmentsByName() {
  const subscriptionId =
    process.env["APPCONTAINERS_SUBSCRIPTION_ID"] || "8efdecc5-919e-44eb-b179-915dca89ebf9";
  const resourceGroupName = process.env["APPCONTAINERS_RESOURCE_GROUP"] || "examplerg";
  const environmentName = "jlaw-demo1";
  const credential = new DefaultAzureCredential();
  const client = new ContainerAppsAPIClient(credential, subscriptionId);
  const result = await client.managedEnvironments.get(resourceGroupName, environmentName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppContainers.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppContainers;

// Generated from example definition: specification/app/resource-manager/Microsoft.App/stable/2024-03-01/examples/ManagedEnvironments_Get.json
// this example is just showing the usage of "ManagedEnvironments_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ContainerAppManagedEnvironmentResource created on azure
// for more information of creating ContainerAppManagedEnvironmentResource, please refer to the document of ContainerAppManagedEnvironmentResource
string subscriptionId = "8efdecc5-919e-44eb-b179-915dca89ebf9";
string resourceGroupName = "examplerg";
string environmentName = "jlaw-demo1";
ResourceIdentifier containerAppManagedEnvironmentResourceId = ContainerAppManagedEnvironmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, environmentName);
ContainerAppManagedEnvironmentResource containerAppManagedEnvironment = client.GetContainerAppManagedEnvironmentResource(containerAppManagedEnvironmentResourceId);

// invoke the operation
ContainerAppManagedEnvironmentResource result = await containerAppManagedEnvironment.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ContainerAppManagedEnvironmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

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

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	Respuesta de error de App Service.
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 relativos a la creación y última modificación del recurso.
VnetConfiguration	Propiedades de configuración para que el entorno de aplicaciones se una a una red virtual
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	Destino de 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 de 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

Respuesta de error de App Service.

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 para el 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 al demonio de registro exportar los registros de la aplicación al destino configurado.
properties.customDomainConfiguration	CustomDomainConfiguration	Configuración de dominio personalizada para el entorno
properties.daprAIConnectionString	string	Cadena de conexión de Application Insights usada por 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 datos de telemetría de comunicación de servicio a servicio
properties.daprConfiguration	DaprConfiguration	Configuración del componente Dapr.
properties.defaultDomain	string	Nombre de dominio predeterminado para el clúster
properties.deploymentErrors	string	Los errores que se produjeron durante la implementación o la 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 administrados 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 createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del 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 relativos a la creación y ú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 para que el entorno de aplicaciones se una a una red virtual

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 para que se ejecuten las cargas de trabajo.
workloadProfileType	string	Tipo de perfil de carga de trabajo para que se ejecuten las cargas de trabajo.