Managed Environments Diagnostics - Get Root

サービス:

Azure Container Apps

API バージョン:

2024-03-01

コンテナー アプリのホストに使用されるマネージド環境のプロパティを取得します。

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

URI パラメーター

名前	/	必須	型	説明
environmentName	path	True	string	環境の名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ManagedEnvironment	わかりました
Other Status Codes	DefaultErrorResponse	一般的なエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Get environments by name

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/detectorProperties/rootApi/?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

応答のサンプル

状態コード:

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

定義

名前	説明
AppLogsConfiguration	アプリケーション ログの構成
createdByType	リソースを作成した ID の種類。
CustomDomainConfiguration	アプリ環境カスタム ドメインの構成プロパティ
DaprConfiguration	構成プロパティ Dapr コンポーネント
DefaultErrorResponse	App Service エラー応答。
Details	詳細またはエラー
Encryption	マネージド環境のピア トラフィック暗号化設定
EnvironmentProvisioningState	環境のプロビジョニング状態。
Error	エラー モデル。
KedaConfiguration	構成プロパティ Keda コンポーネント
LogAnalyticsConfiguration	Log Analytics の構成は、宛先が 'log-analytics' として構成されている場合にのみ指定する必要があります
ManagedEnvironment	コンテナー アプリをホストするための環境
Mtls	相互 TLS 認証の構成プロパティ
PeerAuthentication	マネージド環境のピア認証設定
PeerTrafficConfiguration	マネージド環境のピア トラフィック設定
systemData	リソースの作成と最後の変更に関連するメタデータ。
VnetConfiguration	仮想ネットワークに参加するためのアプリ環境の構成プロパティ
WorkloadProfile	コンテナー アプリの実行をスコープにするワークロード プロファイル。

AppLogsConfiguration

Object

アプリケーション ログの構成

名前	型	説明
destination	string	ログの宛先は、"log-analytics"、"azure-monitor"、または "none" にすることができます
logAnalyticsConfiguration	LogAnalyticsConfiguration	Log Analytics の構成は、宛先が 'log-analytics' として構成されている場合にのみ指定する必要があります

createdByType

列挙

リソースを作成した ID の種類。

値	説明
Application
Key
ManagedIdentity
User

CustomDomainConfiguration

Object

アプリ環境カスタム ドメインの構成プロパティ

名前	型	説明
certificatePassword	string	証明書のパスワード
certificateValue	string (byte)	PFX または PEM BLOB
customDomainVerificationId	string	ドメイン名の所有権を確認するために使用される ID
dnsSuffix	string	環境ドメインの DNS サフィックス
expirationDate	string (date-time)	証明書の有効期限。
subjectName	string	証明書のサブジェクト名。
thumbprint	string	証明書の拇印。

DaprConfiguration

Object

構成プロパティ Dapr コンポーネント

名前	型	説明
version	string	Dapr のバージョン

DefaultErrorResponse

Object

App Service エラー応答。

名前	型	説明
error	Error	エラー モデル。

Details

Object

詳細またはエラー

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

Encryption

Object

マネージド環境のピア トラフィック暗号化設定

名前	型	説明
enabled	boolean	ピア トラフィック暗号化が有効かどうかを示すブール値

EnvironmentProvisioningState

列挙

環境のプロビジョニング状態。

値	説明
Canceled
Failed
InfrastructureSetupComplete
InfrastructureSetupInProgress
InitializationInProgress
ScheduledForDelete
Succeeded
UpgradeFailed
UpgradeRequested
Waiting

Error

Object

エラー モデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細またはエラー
innererror	string	デバッグ エラーの詳細。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

KedaConfiguration

Object

構成プロパティ Keda コンポーネント

名前	型	説明
version	string	Keda のバージョン

LogAnalyticsConfiguration

Object

Log Analytics の構成は、宛先が 'log-analytics' として構成されている場合にのみ指定する必要があります

名前	型	説明
customerId	string	Log Analytics の顧客 ID
sharedKey	string	Log Analytics カスタマー キー

ManagedEnvironment

Object

コンテナー アプリをホストするための環境

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	環境の種類。
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.appLogsConfiguration	AppLogsConfiguration	ログ デーモンが構成された宛先にアプリ ログをエクスポートできるようにするクラスター構成。
properties.customDomainConfiguration	CustomDomainConfiguration	環境のカスタム ドメイン構成
properties.daprAIConnectionString	string	サービスからサービスへの通信テレメトリのエクスポートに Dapr によって使用される Application Insights 接続文字列
properties.daprAIInstrumentationKey	string	サービス間通信テレメトリをエクスポートするために Dapr によって使用される Azure Monitor インストルメンテーション キー
properties.daprConfiguration	DaprConfiguration	Dapr コンポーネントの構成。
properties.defaultDomain	string	クラスターの既定のドメイン名
properties.deploymentErrors	string	デプロイまたはデプロイの検証中に発生したエラー
properties.eventStreamEndpoint	string	環境のイベントストリームのエンドポイント。
properties.infrastructureResourceGroup	string	インフラストラクチャ リソースをホストするために Managed Environment 用に作成されたプラットフォームマネージド リソース グループの名前。 サブネット ID が指定されている場合、このリソース グループはサブネットと同じサブスクリプションに作成されます。
properties.kedaConfiguration	KedaConfiguration	Keda コンポーネントの構成。
properties.peerAuthentication	PeerAuthentication	マネージド環境のピア認証設定
properties.peerTrafficConfiguration	PeerTrafficConfiguration	マネージド環境のピア トラフィック設定
properties.provisioningState	EnvironmentProvisioningState	環境のプロビジョニング状態。
properties.staticIp	string	環境の静的 IP
properties.vnetConfiguration	VnetConfiguration	環境の Vnet 構成
properties.workloadProfiles	WorkloadProfile[]	マネージド環境用に構成されたワークロード プロファイル。
properties.zoneRedundant	boolean	このマネージド環境がゾーン冗長であるかどうか。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

Mtls

Object

相互 TLS 認証の構成プロパティ

名前	型	説明
enabled	boolean	相互 TLS 認証が有効かどうかを示すブール値

PeerAuthentication

Object

マネージド環境のピア認証設定

名前	型	説明
mtls	Mtls	マネージド環境の相互 TLS 認証設定

PeerTrafficConfiguration

Object

マネージド環境のピア トラフィック設定

名前	型	説明
encryption	Encryption	マネージド環境のピア トラフィック暗号化設定

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

VnetConfiguration

Object

仮想ネットワークに参加するためのアプリ環境の構成プロパティ

名前	型	説明
dockerBridgeCidr	string	Docker ブリッジ、ネットワークに割り当てられた CIDR 表記 IP 範囲。 他の指定された IP 範囲と重複してはなりません。
infrastructureSubnetId	string	インフラストラクチャ コンポーネントのサブネットのリソース ID。 他の指定された IP 範囲と重複してはなりません。
internal	boolean	環境に内部ロード バランサーのみが存在することを示すブール値。 これらの環境には、パブリック静的 IP リソースがありません。 このプロパティを有効にする場合は、infrastructureSubnetId を指定する必要があります
platformReservedCidr	string	環境インフラストラクチャの IP アドレス用に予約できる CIDR 表記の IP 範囲。 他の指定された IP 範囲と重複してはなりません。
platformReservedDnsIP	string	内部 DNS サーバー用に予約される platformReservedCidr によって定義された IP 範囲の IP アドレス。

WorkloadProfile

Object

コンテナー アプリの実行をスコープにするワークロード プロファイル。

名前	型	説明
maximumCount	integer (int32)	最大容量。
minimumCount	integer (int32)	最小容量。
name	string	実行するワークロードのワークロード プロファイルの種類。
workloadProfileType	string	実行するワークロードのワークロード プロファイルの種類。