App Service Environments - List By Resource Group

Referencia

Szolgáltatás:: App Service

API-verzió:: 2024-11-01

Leírás az összes App Service-környezet lekéréséhez egy erőforráscsoportban.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments?api-version=2024-11-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Ön Azure előfizetési azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Válaszok

Name	Típus	Description
200 OK	AppServiceEnvironmentCollection	OKÉ
Other Status Codes	DefaultErrorResponse	App Service-hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get all App Service Environments in a resource group.

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments?api-version=2024-11-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_ListByResourceGroup.json
// this example is just showing the usage of "AppServiceEnvironments_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-rg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AppServiceEnvironmentResource
AppServiceEnvironmentCollection collection = resourceGroupResource.GetAppServiceEnvironments();

// invoke the operation and iterate over the result
await foreach (AppServiceEnvironmentResource item in collection.GetAllAsync())
{
    // the variable item 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
    AppServiceEnvironmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
      "name": "test-ase",
      "type": "Microsoft.Web/hostingEnvironments",
      "kind": "ASEV3",
      "location": "South Central US",
      "tags": {},
      "properties": {
        "provisioningState": "Succeeded",
        "status": "Ready",
        "virtualNetwork": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
          "name": "delegated",
          "type": "Microsoft.Network/virtualNetworks/subnets",
          "subnet": ""
        },
        "internalLoadBalancingMode": "None",
        "multiSize": "Standard_D2d_v4",
        "multiRoleCount": null,
        "ipsslAddressCount": 0,
        "dnsSuffix": "test-ase.p.azurewebsites.net",
        "maximumNumberOfMachines": 250,
        "frontEndScaleFactor": 15,
        "suspended": false,
        "clusterSettings": null,
        "userWhitelistedIpRanges": null,
        "hasLinuxWorkers": true,
        "dedicatedHostCount": 0,
        "zoneRedundant": false,
        "networkingConfiguration": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
          "properties": {
            "windowsOutboundIpAddresses": [
              "20.88.241.56",
              "20.88.241.9"
            ],
            "linuxOutboundIpAddresses": [
              "20.88.241.56",
              "20.88.241.9"
            ],
            "externalInboundIpAddresses": [
              "52.153.248.36"
            ],
            "internalInboundIpAddresses": [],
            "allowNewPrivateEndpointConnections": false,
            "ftpEnabled": false,
            "remoteDebugEnabled": false,
            "inboundIpAddressOverride": null
          }
        }
      }
    }
  ]
}

Definíciók

Name	Description
AppServiceEnvironmentCollection	App Service-környezetek gyűjteménye.
AppServiceEnvironmentResource	App Service Environment ARM-erőforrás.
AseV3NetworkingConfiguration	Az ASE hálózati konfigurációjának teljes nézete.
CustomDnsSuffixConfiguration	Az ASEv3 egyéni tartomány utótagjának konfigurációjának teljes megtekintése.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	App Service-hibaválasz.
Details
Error	Hibamodell.
HostingEnvironmentStatus	Az App Service-környezet aktuális állapota.
LoadBalancingMode	Megadja, hogy mely végpontokat kell belsőleg kiszolgálni az App Service-környezet virtuális hálózatában.
NameValuePair	Névértékpár.
ProvisioningState	Az App Service-környezet kiépítési állapota.
UpgradeAvailability	Elérhető-e frissítés ehhez az App Service-környezethez.
UpgradePreference	Frissítési beállítás
VirtualNetworkProfile	A virtuális hálózat használatára vonatkozó specifikáció.

AppServiceEnvironmentCollection

Objektum

App Service-környezetek gyűjteménye.

Name	Típus	Description
nextLink	string	Hivatkozás az erőforrások következő oldalára.
value	AppServiceEnvironmentResource[]	Erőforrások gyűjteménye.

AppServiceEnvironmentResource

Objektum

App Service Environment ARM-erőforrás.

Name	Típus	Alapértelmezett érték	Description
id	string		Erőforrás-azonosító.
kind	string		Erőforrás típusa. Ha az erőforrás egy alkalmazás, a https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference a természetben támogatott értékek részleteiért tekintse meg.
location	string		Erőforrás helye.
name	string		Erőforrás neve.
properties.clusterSettings	NameValuePair[]		Egyéni beállítások az App Service-környezet viselkedésének módosításához.
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Az ASEv3 egyéni tartomány utótagjának konfigurációjának teljes megtekintése.
properties.dedicatedHostCount	integer (int32)		Dedikált gazdagépek száma
properties.dnsSuffix	string		Az App Service-környezet DNS-utótagja.
properties.frontEndScaleFactor	integer (int32)		Előtérméretezési tényező.
properties.hasLinuxWorkers	boolean		Annak megjelölése, hogy az ASE rendelkezik-e Linux-feldolgozóval vagy sem
properties.internalLoadBalancingMode	LoadBalancingMode		Megadja, hogy mely végpontokat kell belsőleg kiszolgálni az App Service-környezet virtuális hálózatában.
properties.ipsslAddressCount	integer (int32)		Az App Service-környezet számára fenntartott IP SSL-címek száma.
properties.maximumNumberOfMachines	integer (int32)		Virtuális gépek maximális száma az App Service-környezetben.
properties.multiRoleCount	integer (int32)		Előtérpéldányok száma.
properties.multiSize	string		Előtérbeli virtuális gép mérete, például "Közepes", "Nagy".
properties.networkingConfiguration	AseV3NetworkingConfiguration		Az ASE hálózati konfigurációjának teljes nézete.
properties.provisioningState	ProvisioningState		Az App Service-környezet kiépítési állapota.
properties.status	HostingEnvironmentStatus		Az App Service-környezet aktuális állapota.
properties.suspended	boolean		`true`, hogy az App Service-környezet fel van-e függesztve; ellenkező esetben `false`. A környezet felfüggeszthető, például ha a felügyeleti végpont már nem érhető el (valószínűleg azért, mert az NSG blokkolta a bejövő forgalmat).
properties.upgradeAvailability	UpgradeAvailability		Elérhető-e frissítés ehhez az App Service-környezethez.
properties.upgradePreference	UpgradePreference	None	Frissítési beállítás
properties.userWhitelistedIpRanges	string[]		A felhasználó ip-tartományokat adott hozzá az ASE-adatbázis engedélyezési listájához
properties.virtualNetwork	VirtualNetworkProfile		A virtuális hálózat leírása.
properties.zoneRedundant	boolean		Azt jelzi, hogy ez az App Service-környezet zónaredundáns-e.
tags	object		Erőforráscímkék.
type	string		Erőforrás típusa.

AseV3NetworkingConfiguration

Objektum

Az ASE hálózati konfigurációjának teljes nézete.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
name	string	Erőforrás neve.
properties.allowNewPrivateEndpointConnections	boolean	Tulajdonság az új privát végpontkapcsolatok ASE-n való létrehozásának engedélyezéséhez és letiltásához
properties.externalInboundIpAddresses	string[]
properties.ftpEnabled	boolean	Az FTP engedélyezésére és letiltására alkalmas tulajdonság az ASEV3-on
properties.inboundIpAddressOverride	string	Ügyfél által megadott bejövő IP-cím. Csak ase létrehozáskor állítható be.
properties.internalInboundIpAddresses	string[]
properties.linuxOutboundIpAddresses	string[]
properties.remoteDebugEnabled	boolean	Tulajdonság a távoli hibakeresés engedélyezéséhez és letiltásához az ASEV3-on
properties.windowsOutboundIpAddresses	string[]
type	string	Erőforrás típusa.

CustomDnsSuffixConfiguration

Objektum

Az ASEv3 egyéni tartomány utótagjának konfigurációjának teljes megtekintése.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
name	string	Erőforrás neve.
properties.certificateUrl	string	Az Egyéni tartomány utótaggal rendelkező webhelyek alapértelmezett SSL/TLS-tanúsítványaként használandó Azure Key Vault-tanúsítvány titkos kódjára hivatkozó URL-cím.
properties.dnsSuffix	string	Az ASE-n üzembe helyezett összes hely alapértelmezett egyéni tartomány-utótagja.
properties.keyVaultReferenceIdentity	string	A kulcstartó tanúsítványreferenciájának feloldásához használandó felhasználó által hozzárendelt identitás. Ha nincs megadva, a rendszer által hozzárendelt ASE-identitást fogja használni, ha elérhető.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	Erőforrás típusa.

CustomDnsSuffixProvisioningState

Enumerálás

Érték	Description
Degraded
Failed
InProgress
Succeeded

DefaultErrorResponse

Objektum

App Service-hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Objektum

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

Error

Objektum

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakereséshez.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

HostingEnvironmentStatus

Enumerálás

Az App Service-környezet aktuális állapota.

Érték	Description
Deleting
Preparing
Ready
Scaling

LoadBalancingMode

Enumerálás

Megadja, hogy mely végpontokat kell belsőleg kiszolgálni az App Service-környezet virtuális hálózatában.

Érték	Description
None
Publishing
Web
Web, Publishing

NameValuePair

Objektum

Névértékpár.

Name	Típus	Description
name	string	Párnév.
value	string	Párérték.

ProvisioningState

Enumerálás

Az App Service-környezet kiépítési állapota.

Érték	Description
Canceled
Deleting
Failed
InProgress
Succeeded

UpgradeAvailability

Enumerálás

Elérhető-e frissítés ehhez az App Service-környezethez.

Érték	Description
None	Jelenleg nem érhető el frissítés ehhez az App Service-környezethez
Ready	A frissítés készen áll arra, hogy manuálisan kezdeményeződjön ezen az App Service-környezetben

UpgradePreference

Enumerálás

Frissítési beállítás

Érték	Description
Early	Ez az App Service-környezet a "Késés" frissítési beállítással rendelkező, ugyanabban a régióban lévő többi felhasználó előtt frissül.
Late	Ez az App Service-környezet a "Korai" frissítési beállítással rendelkező régióban lévő többi felhasználó után frissül.
Manual	Csak ASEv3. Amint elérhető a frissítés, ez az App Service-környezet 10 napot fog várni a frissítés manuális indítására. 10 nap elteltével a frissítés automatikusan elindul
None	Nincs beállítás az App Service-környezet frissítésének időpontjára vonatkozóan

VirtualNetworkProfile

Objektum

A virtuális hálózat használatára vonatkozó specifikáció.

Name	Típus	Description
id	string	A virtuális hálózat erőforrás-azonosítója.
name	string	A virtuális hálózat neve (írásvédett).
subnet	string	Alhálózat a virtuális hálózaton belül.
type	string	A virtuális hálózat erőforrástípusa (írásvédett).

Megosztás a következőn keresztül:

App Service Environments - List By Resource Group

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Get all App Service Environments in a resource group.

Mintakérelem

Mintaválasz

Definíciók

AppServiceEnvironmentCollection

AppServiceEnvironmentResource

AseV3NetworkingConfiguration

CustomDnsSuffixConfiguration

CustomDnsSuffixProvisioningState

DefaultErrorResponse

Details

Error

HostingEnvironmentStatus

LoadBalancingMode

NameValuePair

ProvisioningState

UpgradeAvailability

UpgradePreference

VirtualNetworkProfile