Managed Environments - Get
コンテナー アプリをホストするために使用される Managed Environment のプロパティを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}?api-version=2024-03-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
environment
|
path | True |
string |
環境の名前。 |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
一般的なエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Get environments by name
要求のサンプル
応答のサンプル
{
"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
}
}
}
}
定義
名前 | 説明 |
---|---|
App |
アプリケーション ログの構成 |
created |
リソースを作成した ID の種類。 |
Custom |
アプリ環境カスタム ドメインの構成プロパティ |
Dapr |
構成プロパティ Dapr コンポーネント |
Default |
エラー応答をApp Serviceします。 |
Details |
詳細またはエラー |
Encryption |
マネージド環境のピア トラフィック暗号化設定 |
Environment |
環境のプロビジョニング状態。 |
Error |
エラー モデル。 |
Keda |
構成プロパティ Keda コンポーネント |
Log |
Log Analytics の構成は、宛先が 'log-analytics' として構成されている場合にのみ指定する必要があります |
Managed |
コンテナー アプリをホストするための環境 |
Mtls |
相互 TLS 認証の構成プロパティ |
Peer |
マネージド環境のピア認証設定 |
Peer |
マネージド環境のピア トラフィック設定 |
system |
リソースの作成と最後の変更に関連するメタデータ。 |
Vnet |
Virtual Networkに参加するアプリ環境の構成プロパティ |
Workload |
コンテナー アプリの実行をスコープにするワークロード プロファイル。 |
AppLogsConfiguration
アプリケーション ログの構成
名前 | 型 | 説明 |
---|---|---|
destination |
string |
ログの宛先は、'log-analytics'、'azure-monitor'、または 'none' にすることができます |
logAnalyticsConfiguration |
Log Analytics の構成は、宛先が 'log-analytics' として構成されている場合にのみ指定する必要があります |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CustomDomainConfiguration
アプリ環境カスタム ドメインの構成プロパティ
名前 | 型 | 説明 |
---|---|---|
certificatePassword |
string |
Certificate password |
certificateValue |
string |
PFX または PEM BLOB |
customDomainVerificationId |
string |
ドメイン名の所有権を確認するために使用される ID |
dnsSuffix |
string |
環境ドメインの DNS サフィックス |
expirationDate |
string |
証明書の有効期限。 |
subjectName |
string |
証明書のサブジェクト名。 |
thumbprint |
string |
証明書のサムプリント。 |
DaprConfiguration
構成プロパティ Dapr コンポーネント
名前 | 型 | 説明 |
---|---|---|
version |
string |
Dapr のバージョン |
DefaultErrorResponse
エラー応答をApp Serviceします。
名前 | 型 | 説明 |
---|---|---|
error |
エラー モデル。 |
Details
詳細またはエラー
名前 | 型 | 説明 |
---|---|---|
code |
string |
プログラムによってエラーを識別するための標準化された文字列。 |
message |
string |
詳細なエラーの説明とデバッグ情報。 |
target |
string |
詳細なエラーの説明とデバッグ情報。 |
Encryption
マネージド環境のピア トラフィック暗号化設定
名前 | 型 | 説明 |
---|---|---|
enabled |
boolean |
ピア トラフィック暗号化が有効かどうかを示すブール値 |
EnvironmentProvisioningState
環境のプロビジョニング状態。
名前 | 型 | 説明 |
---|---|---|
Canceled |
string |
|
Failed |
string |
|
InfrastructureSetupComplete |
string |
|
InfrastructureSetupInProgress |
string |
|
InitializationInProgress |
string |
|
ScheduledForDelete |
string |
|
Succeeded |
string |
|
UpgradeFailed |
string |
|
UpgradeRequested |
string |
|
Waiting |
string |
Error
エラー モデル。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プログラムによってエラーを識別するための標準化された文字列。 |
details |
Details[] |
詳細またはエラー |
innererror |
string |
エラーのデバッグに関する詳細情報。 |
message |
string |
詳細なエラーの説明とデバッグ情報。 |
target |
string |
詳細なエラーの説明とデバッグ情報。 |
KedaConfiguration
構成プロパティ Keda コンポーネント
名前 | 型 | 説明 |
---|---|---|
version |
string |
Keda のバージョン |
LogAnalyticsConfiguration
Log Analytics の構成は、宛先が 'log-analytics' として構成されている場合にのみ指定する必要があります
名前 | 型 | 説明 |
---|---|---|
customerId |
string |
Log Analytics の顧客 ID |
sharedKey |
string |
Log Analytics カスタマー キー |
ManagedEnvironment
コンテナー アプリをホストするための環境
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
kind |
string |
環境の種類。 |
location |
string |
リソースが保存されている地理的な場所 |
name |
string |
リソースの名前 |
properties.appLogsConfiguration |
ログ デーモンがアプリ ログを宛先にエクスポートできるようにするクラスター構成。 現在、"log-analytics" のみがサポートされています |
|
properties.customDomainConfiguration |
環境のカスタム ドメイン構成 |
|
properties.daprAIConnectionString |
string |
Application Insights 接続文字列サービス間通信テレメトリをエクスポートするために Dapr によって使用されます |
properties.daprAIInstrumentationKey |
string |
サービスをサービス通信テレメトリにエクスポートするために Dapr によって使用される Azure Monitor インストルメンテーション キー |
properties.daprConfiguration |
Dapr コンポーネントの構成。 |
|
properties.defaultDomain |
string |
クラスターの既定のドメイン名 |
properties.deploymentErrors |
string |
デプロイまたはデプロイの検証中に発生したエラー |
properties.eventStreamEndpoint |
string |
環境のイベントストリームのエンドポイント。 |
properties.infrastructureResourceGroup |
string |
インフラストラクチャ リソースをホストするために Managed Environment 用に作成されたプラットフォームマネージド リソース グループの名前。 サブネット ID が指定されている場合、このリソース グループはサブネットと同じサブスクリプションに作成されます。 |
properties.kedaConfiguration |
Keda コンポーネントの構成。 |
|
properties.peerAuthentication |
マネージド環境のピア認証設定 |
|
properties.peerTrafficConfiguration |
マネージド環境のピア トラフィック設定 |
|
properties.provisioningState |
環境のプロビジョニング状態。 |
|
properties.staticIp |
string |
環境の静的 IP |
properties.vnetConfiguration |
環境の Vnet 構成 |
|
properties.workloadProfiles |
Managed Environment 用に構成されたワークロード プロファイル。 |
|
properties.zoneRedundant |
boolean |
このマネージド環境がゾーン冗長かどうか。 |
systemData |
createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
tags |
object |
リソース タグ。 |
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
Mtls
相互 TLS 認証の構成プロパティ
名前 | 型 | 説明 |
---|---|---|
enabled |
boolean |
相互 TLS 認証が有効になっているかどうかを示すブール値 |
PeerAuthentication
マネージド環境のピア認証設定
名前 | 型 | 説明 |
---|---|---|
mtls |
マネージド環境の相互 TLS 認証設定 |
PeerTrafficConfiguration
マネージド環境のピア トラフィック設定
名前 | 型 | 説明 |
---|---|---|
encryption |
マネージド環境のピア トラフィック暗号化設定 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
VnetConfiguration
Virtual Networkに参加するアプリ環境の構成プロパティ
名前 | 型 | 説明 |
---|---|---|
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
コンテナー アプリの実行をスコープにするワークロード プロファイル。
名前 | 型 | 説明 |
---|---|---|
maximumCount |
integer |
最大容量。 |
minimumCount |
integer |
最小容量。 |
name |
string |
実行するワークロードのワークロード プロファイルの種類。 |
workloadProfileType |
string |
実行するワークロードのワークロード プロファイルの種類。 |