App Service Environments - Create Or Update Worker Pool

Hizmet:

App Service

API Sürümü:

2024-11-01

Çalışan havuzu oluşturma veya güncelleştirme açıklaması.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
name	path	True	string	App Service Ortamının adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Kaynağın ait olduğu kaynak grubunun adı.
subscriptionId	path	True	string	Azure abonelik kimliğiniz. Bu, GUID biçimli bir dizedir (örneğin, 00000000-0000-0000-0000-000000000000000).
workerPoolName	path	True	string	Çalışan havuzunun adı.
api-version	query	True	string	API Sürümü

İstek Gövdesi

Name	Tür	Description
kind	string	Kaynak türü.
properties.computeMode	ComputeModeOptions	Paylaşılan veya ayrılmış uygulama barındırma.
properties.workerCount	integer (int32)	Çalışan havuzundaki örnek sayısı.
properties.workerSize	string	Çalışan havuzu örneklerinin VM boyutu.
properties.workerSizeId	integer (int32)	Bu çalışan havuzuna başvurmak için çalışan boyutu kimliği.
sku	SkuDescription	Ölçeklenebilir bir kaynağın SKU'su açıklaması.

Yanıtlar

Name	Tür	Description
200 OK	WorkerPoolResource	TAMAM.
202 Accepted	WorkerPoolResource	İşlem devam ediyor.
Other Status Codes	DefaultErrorResponse	App Service hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get properties of a worker pool.

Örnek isteği

HTTP

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

{
  "properties": {
    "workerSize": "Small",
    "workerCount": 3
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.WorkerPoolResourceInner;

/**
 * Samples for AppServiceEnvironments UpdateWorkerPool.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/
     * AppServiceEnvironments_CreateOrUpdateWorkerPool.json
     */
    /**
     * Sample code: Get properties of a worker pool.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getPropertiesOfAWorkerPool(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getAppServiceEnvironments().updateWorkerPoolWithResponse("test-rg",
            "test-ase", "0", new WorkerPoolResourceInner().withWorkerSize("Small").withWorkerCount(3),
            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.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python app_service_environments_create_or_update_worker_pool.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 = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.app_service_environments.begin_create_or_update_worker_pool(
        resource_group_name="test-rg",
        name="test-ase",
        worker_pool_name="0",
        worker_pool_envelope={"properties": {"workerCount": 3, "workerSize": "Small"}},
    ).result()
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json
if __name__ == "__main__":
    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 armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json
func ExampleEnvironmentsClient_UpdateWorkerPool() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewEnvironmentsClient().UpdateWorkerPool(ctx, "test-rg", "test-ase", "0", armappservice.WorkerPoolResource{
		Properties: &armappservice.WorkerPool{
			WorkerCount: to.Ptr[int32](3),
			WorkerSize:  to.Ptr("Small"),
		},
	}, 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.WorkerPoolResource = armappservice.WorkerPoolResource{
	// }
}

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 { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Create or update a worker pool.
 *
 * @summary Description for Create or update a worker pool.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json
 */
async function getPropertiesOfAWorkerPool() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "test-rg";
  const name = "test-ase";
  const workerPoolName = "0";
  const workerPoolEnvelope = {
    workerCount: 3,
    workerSize: "Small",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.appServiceEnvironments.updateWorkerPool(
    resourceGroupName,
    name,
    workerPoolName,
    workerPoolEnvelope,
  );
  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.AppService.Models;
using Azure.ResourceManager.AppService;

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

// invoke the operation
AppServiceWorkerPoolData data = new AppServiceWorkerPoolData
{
    WorkerSize = "Small",
    WorkerCount = 3,
};
HostingEnvironmentWorkerPoolResource result = await hostingEnvironmentWorkerPool.UpdateAsync(data);

// 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
AppServiceWorkerPoolData 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

Örnek yanıt

Durum kodu:

202

{}

Durum kodu:

200

{}

Tanımlar

Name	Description
Capability	Belirli bir SKU için izin verilen özellikleri/özellikleri açıklar.
ComputeModeOptions	Paylaşılan/ayrılmış çalışanlar.
DefaultErrorResponse	App Service hata yanıtı.
Details
Error	Hata modeli.
SkuCapacity	App Service planı ölçek seçeneklerinin açıklaması.
SkuDescription	Ölçeklenebilir bir kaynağın SKU'su açıklaması.
WorkerPoolResource	App Service Ortamı ARM kaynağının çalışan havuzu.

Capability

Object

Belirli bir SKU için izin verilen özellikleri/özellikleri açıklar.

Name	Tür	Description
name	string	SKU özelliğinin adı.
reason	string	SKU özelliğinin nedeni.
value	string	SKU özelliğinin değeri.

ComputeModeOptions

Listeleme

Paylaşılan/ayrılmış çalışanlar.

Değer	Description
Dedicated
Dynamic
Shared

DefaultErrorResponse

Object

App Service hata yanıtı.

Name	Tür	Description
error	Error	Hata modeli.

Details

Object

Name	Tür	Description
code	string	Hatayı program aracılığıyla tanımlamak için standartlaştırılmış dize.
message	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.
target	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.

Error

Object

Hata modeli.

Name	Tür	Description
code	string	Hatayı program aracılığıyla tanımlamak için standartlaştırılmış dize.
details	Details[]	Ayrıntılı hatalar.
innererror	string	Hata ayıklamak için daha fazla bilgi.
message	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.
target	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.

SkuCapacity

Object

App Service planı ölçek seçeneklerinin açıklaması.

Name	Tür	Description
default	integer (int32)	Bu App Service planı SKU'su için varsayılan çalışan sayısı.
elasticMaximum	integer (int32)	Bu App Service planı SKU'su için en fazla Elastik çalışan sayısı.
maximum	integer (int32)	Bu App Service planı SKU'su için en fazla çalışan sayısı.
minimum	integer (int32)	Bu App Service planı SKU'su için en az çalışan sayısı.
scaleType	string	App Service planı için kullanılabilir ölçek yapılandırmaları.

SkuDescription

Object

Ölçeklenebilir bir kaynağın SKU'su açıklaması.

Name	Tür	Description
capabilities	Capability[]	SKU'nun özellikleri( örneğin, traffic manager etkin mi?
capacity	integer (int32)	Kaynağa atanan geçerli örnek sayısı.
family	string	Kaynak SKU'sunun aile kodu.
locations	string[]	SKU'nun konumları.
name	string	Kaynak SKU'sunun adı.
size	string	Kaynak SKU'sunun boyut belirticisi.
skuCapacity	SkuCapacity	SKU'nun en küçük, en büyük ve varsayılan ölçek değerleri.
tier	string	Kaynak SKU'sunun hizmet katmanı.

WorkerPoolResource

Object

App Service Ortamı ARM kaynağının çalışan havuzu.

Name	Tür	Description
id	string	Kaynak Kimliği.
kind	string	Kaynak türü.
name	string	Kaynak Adı.
properties.computeMode	ComputeModeOptions	Paylaşılan veya ayrılmış uygulama barındırma.
properties.instanceNames	string[]	Çalışan havuzundaki tüm örneklerin adları (salt okunur).
properties.workerCount	integer (int32)	Çalışan havuzundaki örnek sayısı.
properties.workerSize	string	Çalışan havuzu örneklerinin VM boyutu.
properties.workerSizeId	integer (int32)	Bu çalışan havuzuna başvurmak için çalışan boyutu kimliği.
sku	SkuDescription	Ölçeklenebilir bir kaynağın SKU'su açıklaması.
type	string	Kaynak türü.