Managed Environments - Get

Servizio:

Azure Container Apps

Versione API:

2024-03-01

Ottenere le proprietà di un ambiente gestito usato per ospitare app contenitore.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
environmentName	path	True	string	Nome dell'ambiente.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ManagedEnvironment	OK
Other Status Codes	DefaultErrorResponse	Risposta di errore comune.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get environments by name

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
AppLogsConfiguration	Configurazione dei log dell'applicazione
createdByType	Tipo di identità che ha creato la risorsa.
CustomDomainConfiguration	Proprietà di configurazione per il dominio personalizzato dell'ambiente delle app
DaprConfiguration	Componente Dapr delle proprietà di configurazione
DefaultErrorResponse	Risposta di errore del servizio app.
Details	Dettagli o errore
Encryption	Impostazioni di crittografia del traffico peer per l'ambiente gestito
EnvironmentProvisioningState	Stato di provisioning dell'ambiente.
Error	Modello di errore.
KedaConfiguration	Componente Keda delle proprietà di configurazione
LogAnalyticsConfiguration	La configurazione di Log Analytics deve essere fornita solo quando la destinazione è configurata come "log-analytics"
ManagedEnvironment	Un ambiente per l'hosting di app contenitore
Mtls	Proprietà di configurazione per l'autenticazione TLS reciproca
PeerAuthentication	Impostazioni di autenticazione peer per l'ambiente gestito
PeerTrafficConfiguration	Impostazioni del traffico peer per l'ambiente gestito
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
VnetConfiguration	Proprietà di configurazione per l'ambiente delle app per l'aggiunta a una rete virtuale
WorkloadProfile	Profilo del carico di lavoro per definire l'ambito dell'esecuzione dell'app contenitore.

AppLogsConfiguration

Configurazione dei log dell'applicazione

Nome	Tipo	Descrizione
destination	string	La destinazione dei log può essere "log-analytics", "azure-monitor" o "none"
logAnalyticsConfiguration	LogAnalyticsConfiguration	La configurazione di Log Analytics deve essere fornita solo quando la destinazione è configurata come "log-analytics"

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomainConfiguration

Proprietà di configurazione per il dominio personalizzato dell'ambiente delle app

Nome	Tipo	Descrizione
certificatePassword	string	Password del certificato
certificateValue	string	BLOB PFX o PEM
customDomainVerificationId	string	ID usato per verificare la proprietà del nome di dominio
dnsSuffix	string	Suffisso DNS per il dominio dell'ambiente
expirationDate	string	Data di scadenza del certificato.
subjectName	string	Nome soggetto del certificato.
thumbprint	string	Identificazione personale del certificato.

DaprConfiguration

Componente Dapr delle proprietà di configurazione

Nome	Tipo	Descrizione
version	string	Versione di Dapr

DefaultErrorResponse

Risposta di errore del servizio app.

Nome	Tipo	Descrizione
error	Error	Modello di errore.

Details

Dettagli o errore

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

Encryption

Impostazioni di crittografia del traffico peer per l'ambiente gestito

Nome	Tipo	Descrizione
enabled	boolean	Valore booleano che indica se la crittografia del traffico peer è abilitata

EnvironmentProvisioningState

Stato di provisioning dell'ambiente.

Nome	Tipo	Descrizione
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

Error

Modello di errore.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
details	Details[]	Dettagli o errore
innererror	string	Altre informazioni per eseguire il debug dell'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

KedaConfiguration

Componente Keda delle proprietà di configurazione

Nome	Tipo	Descrizione
version	string	La versione di Keda

LogAnalyticsConfiguration

La configurazione di Log Analytics deve essere fornita solo quando la destinazione è configurata come "log-analytics"

Nome	Tipo	Descrizione
customerId	string	ID cliente di Log Analytics
sharedKey	string	Chiave del cliente di Log Analytics

ManagedEnvironment

Un ambiente per l'hosting di app contenitore

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Tipo di ambiente.
location	string	Posizione geografica in cui risiede la risorsa
name	string	Nome della risorsa
properties.appLogsConfiguration	AppLogsConfiguration	Configurazione del cluster che consente al daemon di log di esportare i log delle app nella destinazione configurata.
properties.customDomainConfiguration	CustomDomainConfiguration	Configurazione del dominio personalizzato per l'ambiente
properties.daprAIConnectionString	string	Stringa di connessione di Application Insights usata da Dapr per esportare i dati di telemetria di comunicazione da servizio a servizio
properties.daprAIInstrumentationKey	string	Chiave di strumentazione di Monitoraggio di Azure usata da Dapr per esportare i dati di telemetria di comunicazione da servizio a servizio
properties.daprConfiguration	DaprConfiguration	Configurazione del componente Dapr.
properties.defaultDomain	string	Nome di dominio predefinito per il cluster
properties.deploymentErrors	string	Eventuali errori che si sono verificati durante la distribuzione o la convalida della distribuzione
properties.eventStreamEndpoint	string	Endpoint del flusso di eventi dell'ambiente.
properties.infrastructureResourceGroup	string	Nome del gruppo di risorse gestito dalla piattaforma creato per l'ambiente gestito per ospitare le risorse dell'infrastruttura. Se viene specificato un ID subnet, questo gruppo di risorse verrà creato nella stessa sottoscrizione della subnet.
properties.kedaConfiguration	KedaConfiguration	Configurazione del componente Keda.
properties.peerAuthentication	PeerAuthentication	Impostazioni di autenticazione peer per l'ambiente gestito
properties.peerTrafficConfiguration	PeerTrafficConfiguration	Impostazioni del traffico peer per l'ambiente gestito
properties.provisioningState	EnvironmentProvisioningState	Stato di provisioning dell'ambiente.
properties.staticIp	string	IP statico dell'ambiente
properties.vnetConfiguration	VnetConfiguration	Configurazione della rete virtuale per l'ambiente
properties.workloadProfiles	WorkloadProfile[]	Profili di carico di lavoro configurati per l'ambiente gestito.
properties.zoneRedundant	boolean	Indica se questo ambiente gestito è con ridondanza della zona.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
tags	object	Tag di risorsa.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

Mtls

Proprietà di configurazione per l'autenticazione TLS reciproca

Nome	Tipo	Descrizione
enabled	boolean	Valore booleano che indica se l'autenticazione TLS reciproca è abilitata

PeerAuthentication

Impostazioni di autenticazione peer per l'ambiente gestito

Nome	Tipo	Descrizione
mtls	Mtls	Impostazioni di autenticazione TLS reciproca per l'ambiente gestito

PeerTrafficConfiguration

Impostazioni del traffico peer per l'ambiente gestito

Nome	Tipo	Descrizione
encryption	Encryption	Impostazioni di crittografia del traffico peer per l'ambiente gestito

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

VnetConfiguration

Proprietà di configurazione per l'ambiente delle app per l'aggiunta a una rete virtuale

Nome	Tipo	Descrizione
dockerBridgeCidr	string	Intervallo IP di notazione CIDR assegnato al bridge Docker, rete. Non deve sovrapporsi ad altri intervalli IP forniti.
infrastructureSubnetId	string	ID risorsa di una subnet per i componenti dell'infrastruttura. Non deve sovrapporsi ad altri intervalli IP forniti.
internal	boolean	Valore booleano che indica che l'ambiente dispone solo di un servizio di bilanciamento del carico interno. Questi ambienti non hanno una risorsa IP statica pubblica. Devono fornire infrastructureSubnetId se si abilita questa proprietà
platformReservedCidr	string	Intervallo IP nella notazione CIDR che può essere riservato per gli indirizzi IP dell'infrastruttura dell'ambiente. Non deve sovrapporsi ad altri intervalli IP forniti.
platformReservedDnsIP	string	Indirizzo IP dall'intervallo IP definito da platformReservedCidr che verrà riservato per il server DNS interno.

WorkloadProfile

Profilo del carico di lavoro per definire l'ambito dell'esecuzione dell'app contenitore.

Nome	Tipo	Descrizione
maximumCount	integer	Capacità massima.
minimumCount	integer	Capacità minima.
name	string	Tipo di profilo del carico di lavoro in cui eseguire i carichi di lavoro.
workloadProfileType	string	Tipo di profilo del carico di lavoro in cui eseguire i carichi di lavoro.