Managed Environments - Get
Hämta egenskaperna för en hanterad miljö som används som värd för containerappar.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}?api-version=2024-03-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
environment
|
path | True |
string |
Namnet på miljön. |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Vanligt felsvar. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
Get environments by name
Sample Request
GET https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1?api-version=2024-03-01
Sample Response
{
"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
}
}
}
}
Definitioner
Name | Description |
---|---|
App |
Konfiguration av programloggar |
created |
Den typ av identitet som skapade resursen. |
Custom |
Konfigurationsegenskaper för appmiljöns anpassade domän |
Dapr |
Dapr-komponent för konfigurationsegenskaper |
Default |
App Service felsvar. |
Details |
Information eller felet |
Encryption |
Inställningar för peer-trafikkryptering för den hanterade miljön |
Environment |
Etableringstillstånd för miljön. |
Error |
Felmodell. |
Keda |
Keda-komponent för konfigurationsegenskaper |
Log |
Log Analytics-konfiguration får endast anges när målet har konfigurerats som "log-analytics" |
Managed |
En miljö för att vara värd för containerappar |
Mtls |
Konfigurationsegenskaper för ömsesidig TLS-autentisering |
Peer |
Peer-autentiseringsinställningar för den hanterade miljön |
Peer |
Peer-trafikinställningar för den hanterade miljön |
system |
Metadata som rör skapande och senaste ändring av resursen. |
Vnet |
Konfigurationsegenskaper för appmiljön för att ansluta till en Virtual Network |
Workload |
Arbetsbelastningsprofil för att begränsa körning av containerappar. |
AppLogsConfiguration
Konfiguration av programloggar
Name | Typ | Description |
---|---|---|
destination |
string |
Loggarnas mål, kan vara "log-analytics", "azure-monitor" eller "none" |
logAnalyticsConfiguration |
Log Analytics-konfiguration får endast anges när målet har konfigurerats som "log-analytics" |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
CustomDomainConfiguration
Konfigurationsegenskaper för appmiljöns anpassade domän
Name | Typ | Description |
---|---|---|
certificatePassword |
string |
Certifikatlösenord |
certificateValue |
string |
PFX- eller PEM-blob |
customDomainVerificationId |
string |
ID som används för att verifiera domännamnsägarskap |
dnsSuffix |
string |
Dns-suffix för miljödomänen |
expirationDate |
string |
Certifikatets förfallodatum. |
subjectName |
string |
Certifikatets ämnesnamn. |
thumbprint |
string |
Certifikatets tumavtryck. |
DaprConfiguration
Dapr-komponent för konfigurationsegenskaper
Name | Typ | Description |
---|---|---|
version |
string |
Dapr-versionen |
DefaultErrorResponse
App Service felsvar.
Name | Typ | Description |
---|---|---|
error |
Felmodell. |
Details
Information eller felet
Name | Typ | Description |
---|---|---|
code |
string |
Standardiserad sträng för att programmässigt identifiera felet. |
message |
string |
Detaljerad felbeskrivning och felsökningsinformation. |
target |
string |
Detaljerad felbeskrivning och felsökningsinformation. |
Encryption
Inställningar för peer-trafikkryptering för den hanterade miljön
Name | Typ | Description |
---|---|---|
enabled |
boolean |
Booleskt värde som anger om peer-trafikkryptering är aktiverat |
EnvironmentProvisioningState
Etableringstillstånd för miljön.
Name | Typ | Description |
---|---|---|
Canceled |
string |
|
Failed |
string |
|
InfrastructureSetupComplete |
string |
|
InfrastructureSetupInProgress |
string |
|
InitializationInProgress |
string |
|
ScheduledForDelete |
string |
|
Succeeded |
string |
|
UpgradeFailed |
string |
|
UpgradeRequested |
string |
|
Waiting |
string |
Error
Felmodell.
Name | Typ | Description |
---|---|---|
code |
string |
Standardiserad sträng för att programmässigt identifiera felet. |
details |
Details[] |
Information eller felet |
innererror |
string |
Mer information om felsökningsfel. |
message |
string |
Detaljerad felbeskrivning och felsökningsinformation. |
target |
string |
Detaljerad felbeskrivning och felsökningsinformation. |
KedaConfiguration
Keda-komponent för konfigurationsegenskaper
Name | Typ | Description |
---|---|---|
version |
string |
Versionen av Keda |
LogAnalyticsConfiguration
Log Analytics-konfiguration får endast anges när målet har konfigurerats som "log-analytics"
Name | Typ | Description |
---|---|---|
customerId |
string |
Kund-ID för Log Analytics |
sharedKey |
string |
Log Analytics-kundnyckel |
ManagedEnvironment
En miljö för att vara värd för containerappar
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
kind |
string |
Typ av miljö. |
location |
string |
Den geo-plats där resursen finns |
name |
string |
Namnet på resursen |
properties.appLogsConfiguration |
Klusterkonfiguration som gör att loggdaemonen kan exportera apploggar till ett mål. För närvarande stöds endast "log-analytics" |
|
properties.customDomainConfiguration |
Anpassad domänkonfiguration för miljön |
|
properties.daprAIConnectionString |
string |
Application Insights anslutningssträng som används av Dapr för att exportera telemetri för tjänst-till-tjänstkommunikation |
properties.daprAIInstrumentationKey |
string |
Azure Monitor-instrumenteringsnyckel som används av Dapr för att exportera telemetri för tjänst-till-tjänstkommunikation |
properties.daprConfiguration |
Konfigurationen av Dapr-komponenten. |
|
properties.defaultDomain |
string |
Standarddomännamn för klustret |
properties.deploymentErrors |
string |
Eventuella fel som inträffade under distributions- eller distributionsvalidering |
properties.eventStreamEndpoint |
string |
Slutpunkten för händelseströmmen för miljön. |
properties.infrastructureResourceGroup |
string |
Namnet på den plattformshanterade resursgruppen som skapats för den hanterade miljön som värd för infrastrukturresurser. Om ett undernäts-ID anges skapas den här resursgruppen i samma prenumeration som undernätet. |
properties.kedaConfiguration |
Konfigurationen av Keda-komponenten. |
|
properties.peerAuthentication |
Peer-autentiseringsinställningar för den hanterade miljön |
|
properties.peerTrafficConfiguration |
Peer-trafikinställningar för den hanterade miljön |
|
properties.provisioningState |
Etableringstillstånd för miljön. |
|
properties.staticIp |
string |
Statisk IP-adress för miljön |
properties.vnetConfiguration |
Vnet-konfiguration för miljön |
|
properties.workloadProfiles |
Arbetsbelastningsprofiler som konfigurerats för den hanterade miljön. |
|
properties.zoneRedundant |
boolean |
Om den hanterade miljön är zonredundant eller inte. |
systemData |
Azure Resource Manager metadata som innehåller createdBy och modifiedBy information. |
|
tags |
object |
Resurstaggar. |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
Mtls
Konfigurationsegenskaper för ömsesidig TLS-autentisering
Name | Typ | Description |
---|---|---|
enabled |
boolean |
Booleskt värde som anger om den ömsesidiga TLS-autentiseringen är aktiverad |
PeerAuthentication
Peer-autentiseringsinställningar för den hanterade miljön
Name | Typ | Description |
---|---|---|
mtls |
Inställningar för ömsesidig TLS-autentisering för den hanterade miljön |
PeerTrafficConfiguration
Peer-trafikinställningar för den hanterade miljön
Name | Typ | Description |
---|---|---|
encryption |
Inställningar för peer-trafikkryptering för den hanterade miljön |
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |
VnetConfiguration
Konfigurationsegenskaper för appmiljön för att ansluta till en Virtual Network
Name | Typ | Description |
---|---|---|
dockerBridgeCidr |
string |
IP-intervall för CIDR-notation som tilldelats Docker-bryggan, nätverket. Får inte överlappa med andra angivna IP-intervall. |
infrastructureSubnetId |
string |
Resurs-ID för ett undernät för infrastrukturkomponenter. Får inte överlappa med andra angivna IP-intervall. |
internal |
boolean |
Booleskt värde som anger att miljön bara har en intern lastbalanserare. Dessa miljöer har ingen offentlig statisk IP-resurs. De måste tillhandahålla infrastructureSubnetId om du aktiverar den här egenskapen |
platformReservedCidr |
string |
IP-intervall i CIDR-notation som kan reserveras för IP-adresser för miljöinfrastruktur. Får inte överlappa med andra angivna IP-intervall. |
platformReservedDnsIP |
string |
En IP-adress från IP-intervallet som definieras av platformReservedCidr som ska reserveras för den interna DNS-servern. |
WorkloadProfile
Arbetsbelastningsprofil för att begränsa körning av containerappar.
Name | Typ | Description |
---|---|---|
maximumCount |
integer |
Maximal kapacitet. |
minimumCount |
integer |
Minsta kapacitet. |
name |
string |
Arbetsbelastningsprofiltyp som arbetsbelastningarna ska köras på. |
workloadProfileType |
string |
Arbetsbelastningsprofiltyp som arbetsbelastningarna ska köras på. |