Managed Environments - Get

Layanan:

Azure Container Apps

Versi API:

2024-03-01

Dapatkan properti Lingkungan Terkelola yang digunakan untuk menghosting aplikasi kontainer.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
environmentName	path	True	string	Nama Lingkungan.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ManagedEnvironment	OK
Other Status Codes	DefaultErrorResponse	Respons kesalahan umum.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get environments by name

Permintaan sampel

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
AppLogsConfiguration	Konfigurasi log aplikasi
createdByType	Jenis identitas yang membuat sumber daya.
CustomDomainConfiguration	Properti konfigurasi untuk domain kustom lingkungan aplikasi
DaprConfiguration	Komponen Dapr properti konfigurasi
DefaultErrorResponse	App Service respons kesalahan.
Details	Detail atau kesalahan
Encryption	Pengaturan enkripsi lalu lintas serekan untuk Lingkungan Terkelola
EnvironmentProvisioningState	Status penyediaan Lingkungan.
Error	Model kesalahan.
KedaConfiguration	Properti konfigurasi komponen Keda
LogAnalyticsConfiguration	Konfigurasi Log Analytics, hanya boleh disediakan saat tujuan dikonfigurasi sebagai 'log-analytics'
ManagedEnvironment	Lingkungan untuk menghosting aplikasi kontainer
Mtls	Properti konfigurasi untuk autentikasi TLS bersama
PeerAuthentication	Pengaturan autentikasi serekan untuk Lingkungan Terkelola
PeerTrafficConfiguration	Pengaturan lalu lintas serekan untuk Lingkungan Terkelola
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
VnetConfiguration	Properti konfigurasi untuk lingkungan aplikasi untuk bergabung dengan Virtual Network
WorkloadProfile	Profil beban kerja untuk mencakup eksekusi aplikasi kontainer.

AppLogsConfiguration

Konfigurasi log aplikasi

Nama	Jenis	Deskripsi
destination	string	Tujuan log, dapat berupa 'log-analytics', 'azure-monitor' atau 'none'
logAnalyticsConfiguration	LogAnalyticsConfiguration	Konfigurasi Log Analytics, hanya boleh disediakan saat tujuan dikonfigurasi sebagai 'log-analytics'

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

CustomDomainConfiguration

Properti konfigurasi untuk domain kustom lingkungan aplikasi

Nama	Jenis	Deskripsi
certificatePassword	string	Kata sandi sertifikat
certificateValue	string	Blob PFX atau PEM
customDomainVerificationId	string	Id yang digunakan untuk memverifikasi kepemilikan nama domain
dnsSuffix	string	Akhiran dns untuk domain lingkungan
expirationDate	string	Tanggal kedaluwarsa sertifikat.
subjectName	string	Nama subjek sertifikat.
thumbprint	string	Thumbprint sertifikat.

DaprConfiguration

Komponen Dapr properti konfigurasi

Nama	Jenis	Deskripsi
version	string	Versi Dapr

DefaultErrorResponse

App Service respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Model kesalahan.

Details

Detail atau kesalahan

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
message	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

Encryption

Pengaturan enkripsi lalu lintas serekan untuk Lingkungan Terkelola

Nama	Jenis	Deskripsi
enabled	boolean	Boolean menunjukkan apakah enkripsi lalu lintas serekan diaktifkan

EnvironmentProvisioningState

Status penyediaan Lingkungan.

Nama	Jenis	Deskripsi
Canceled	string
Failed	string
InfrastructureSetupComplete	string
InfrastructureSetupInProgress	string
InitializationInProgress	string
ScheduledForDelete	string
Succeeded	string
UpgradeFailed	string
UpgradeRequested	string
Waiting	string

Error

Model kesalahan.

Nama	Jenis	Deskripsi
code	string	String standar untuk mengidentifikasi kesalahan secara terprogram.
details	Details[]	Detail atau kesalahan
innererror	string	Informasi selengkapnya untuk men-debug kesalahan.
message	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.
target	string	Deskripsi kesalahan terperinci dan informasi penelusuran kesalahan.

KedaConfiguration

Properti konfigurasi komponen Keda

Nama	Jenis	Deskripsi
version	string	Versi Keda

LogAnalyticsConfiguration

Konfigurasi Log Analytics, hanya boleh disediakan saat tujuan dikonfigurasi sebagai 'log-analytics'

Nama	Jenis	Deskripsi
customerId	string	Id pelanggan analitik log
sharedKey	string	Kunci pelanggan analitik log

ManagedEnvironment

Lingkungan untuk menghosting aplikasi kontainer

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Jenis Lingkungan.
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya.
properties.appLogsConfiguration	AppLogsConfiguration	Konfigurasi kluster yang memungkinkan daemon log mengekspor log aplikasi ke tujuan. Saat ini hanya "log-analytics" yang didukung
properties.customDomainConfiguration	CustomDomainConfiguration	Konfigurasi domain kustom untuk lingkungan
properties.daprAIConnectionString	string	Application Insights string koneksi digunakan oleh Dapr untuk mengekspor telemetri komunikasi Layanan ke Layanan
properties.daprAIInstrumentationKey	string	Kunci instrumentasi Azure Monitor yang digunakan oleh Dapr untuk mengekspor telemetri komunikasi Layanan ke Layanan
properties.daprConfiguration	DaprConfiguration	Konfigurasi komponen Dapr.
properties.defaultDomain	string	Nama Domain Default untuk kluster
properties.deploymentErrors	string	Kesalahan apa pun yang terjadi selama penyebaran atau validasi penyebaran
properties.eventStreamEndpoint	string	Titik akhir eventstream Lingkungan.
properties.infrastructureResourceGroup	string	Nama grup sumber daya yang dikelola platform yang dibuat untuk Lingkungan Terkelola untuk menghosting sumber daya infrastruktur. Jika ID subnet disediakan, grup sumber daya ini akan dibuat dalam langganan yang sama dengan subnet.
properties.kedaConfiguration	KedaConfiguration	Konfigurasi komponen Keda.
properties.peerAuthentication	PeerAuthentication	Pengaturan autentikasi serekan untuk Lingkungan Terkelola
properties.peerTrafficConfiguration	PeerTrafficConfiguration	Pengaturan lalu lintas serekan untuk Lingkungan Terkelola
properties.provisioningState	EnvironmentProvisioningState	Status penyediaan Lingkungan.
properties.staticIp	string	IP Statis Lingkungan
properties.vnetConfiguration	VnetConfiguration	Konfigurasi Vnet untuk lingkungan
properties.workloadProfiles	WorkloadProfile[]	Profil beban kerja dikonfigurasi untuk Lingkungan Terkelola.
properties.zoneRedundant	boolean	Apakah Lingkungan Terkelola ini zona-redundan atau tidak.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

Mtls

Properti konfigurasi untuk autentikasi TLS bersama

Nama	Jenis	Deskripsi
enabled	boolean	Boolean menunjukkan apakah autentikasi TLS bersama diaktifkan

PeerAuthentication

Pengaturan autentikasi serekan untuk Lingkungan Terkelola

Nama	Jenis	Deskripsi
mtls	Mtls	Pengaturan autentikasi TLS bersama untuk Lingkungan Terkelola

PeerTrafficConfiguration

Pengaturan lalu lintas serekan untuk Lingkungan Terkelola

Nama	Jenis	Deskripsi
encryption	Encryption	Pengaturan enkripsi lalu lintas serekan untuk Lingkungan Terkelola

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

VnetConfiguration

Properti konfigurasi untuk lingkungan aplikasi untuk bergabung dengan Virtual Network

Nama	Jenis	Deskripsi
dockerBridgeCidr	string	Rentang IP notasi CIDR yang ditetapkan ke jembatan Docker, jaringan. Tidak boleh tumpang tindih dengan rentang IP lain yang disediakan.
infrastructureSubnetId	string	ID sumber daya subnet untuk komponen infrastruktur. Tidak boleh tumpang tindih dengan rentang IP lain yang disediakan.
internal	boolean	Boolean yang menunjukkan lingkungan hanya memiliki load balancer internal. Lingkungan ini tidak memiliki sumber daya IP statis publik. Mereka harus menyediakan infrastructureSubnetId jika mengaktifkan properti ini
platformReservedCidr	string	Rentang IP dalam notasi CIDR yang dapat dicadangkan untuk alamat IP infrastruktur lingkungan. Tidak boleh tumpang tindih dengan rentang IP lain yang disediakan.
platformReservedDnsIP	string	Alamat IP dari rentang IP yang ditentukan oleh platformReservedCidr yang akan dicadangkan untuk server DNS internal.

WorkloadProfile

Profil beban kerja untuk mencakup eksekusi aplikasi kontainer.

Nama	Jenis	Deskripsi
maximumCount	integer	Kapasitas maksimum.
minimumCount	integer	Kapasitas minimum.
name	string	Jenis profil beban kerja untuk menjalankan beban kerja.
workloadProfileType	string	Jenis profil beban kerja untuk menjalankan beban kerja.