App Service Environments - Update

Referência

Serviço:: App Service

Versão da API:: 2024-11-01

Descrição para criar ou atualizar um Ambiente do Serviço de Aplicativo.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do Ambiente do Serviço de Aplicativo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versão da API

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.virtualNetwork	True	VirtualNetworkProfile	Descrição da Rede Virtual.
kind		string	Tipo de recurso.
properties.clusterSettings		NameValuePair[]	Configurações personalizadas para alterar o comportamento do Ambiente do Serviço de Aplicativo.
properties.customDnsSuffixConfiguration		CustomDnsSuffixConfiguration	Exibição completa da configuração de sufixo de domínio personalizado para ASEv3.
properties.dedicatedHostCount		integer (int32)	Contagem de host dedicada
properties.dnsSuffix		string	Sufixo DNS do Ambiente do Serviço de Aplicativo.
properties.frontEndScaleFactor		integer (int32)	Fator de escala para front-ends.
properties.internalLoadBalancingMode		LoadBalancingMode	Especifica quais pontos de extremidade servir internamente na Rede Virtual para o Ambiente do Serviço de Aplicativo.
properties.ipsslAddressCount		integer (int32)	Número de endereços SSL de IP reservados para o Ambiente do Serviço de Aplicativo.
properties.multiSize		string	Tamanho da VM de front-end, por exemplo, "Médio", "Grande".
properties.networkingConfiguration		AseV3NetworkingConfiguration	Exibição completa da configuração de rede para um ASE.
properties.upgradePreference		UpgradePreference	Preferência de Atualização
properties.userWhitelistedIpRanges		string[]	O usuário adicionou intervalos de ip à lista de permissões no banco de dados ASE
properties.zoneRedundant		boolean	Se esse Ambiente do Serviço de Aplicativo tem ou não redundância de zona.

Respostas

Nome	Tipo	Description
200 OK	AppServiceEnvironmentResource	OKEY
201 Created	AppServiceEnvironmentResource	Criado
202 Accepted	AppServiceEnvironmentResource	A operação está em andamento.
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Create or update an App Service Environment.

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

{
  "properties": {
    "frontEndScaleFactor": 20,
    "virtualNetwork": {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"
    }
  }
}

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_Update.json
// this example is just showing the usage of "AppServiceEnvironments_Update" 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 AppServiceEnvironmentResource created on azure
// for more information of creating AppServiceEnvironmentResource, please refer to the document of AppServiceEnvironmentResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-rg";
string name = "test-ase";
ResourceIdentifier appServiceEnvironmentResourceId = AppServiceEnvironmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
AppServiceEnvironmentResource appServiceEnvironment = client.GetAppServiceEnvironmentResource(appServiceEnvironmentResourceId);

// invoke the operation
AppServiceEnvironmentPatch patch = new AppServiceEnvironmentPatch
{
    VirtualNetwork = new AppServiceVirtualNetworkProfile(new ResourceIdentifier("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated")),
    FrontEndScaleFactor = 20,
};
AppServiceEnvironmentResource result = await appServiceEnvironment.UpdateAsync(patch);

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

Resposta de exemplo

Código de status:: 200

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

Código de status:: 201

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

Código de status:: 202

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

Definições

Nome	Description
AppServiceEnvironmentPatchResource	Recurso arm para um ambiente de serviço de aplicativo.
AppServiceEnvironmentResource	Recurso ARM do Ambiente do Serviço de Aplicativo.
AseV3NetworkingConfiguration	Exibição completa da configuração de rede para um ASE.
CustomDnsSuffixConfiguration	Exibição completa da configuração de sufixo de domínio personalizado para ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
HostingEnvironmentStatus	Status atual do Ambiente do Serviço de Aplicativo.
LoadBalancingMode	Especifica quais pontos de extremidade servir internamente na Rede Virtual para o Ambiente do Serviço de Aplicativo.
NameValuePair	Par de valores de nome.
ProvisioningState	Estado de provisionamento do Ambiente do Serviço de Aplicativo.
UpgradeAvailability	Se uma atualização está disponível para este Ambiente do Serviço de Aplicativo.
UpgradePreference	Preferência de Atualização
VirtualNetworkProfile	Especificação para usar uma Rede Virtual.

AppServiceEnvironmentPatchResource

Objeto

Recurso arm para um ambiente de serviço de aplicativo.

Nome	Tipo	Valor padrão	Description
id	string		ID do recurso.
kind	string		Tipo de recurso.
name	string		Nome do Recurso.
properties.clusterSettings	NameValuePair[]		Configurações personalizadas para alterar o comportamento do Ambiente do Serviço de Aplicativo.
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Exibição completa da configuração de sufixo de domínio personalizado para ASEv3.
properties.dedicatedHostCount	integer (int32)		Contagem de host dedicada
properties.dnsSuffix	string		Sufixo DNS do Ambiente do Serviço de Aplicativo.
properties.frontEndScaleFactor	integer (int32)		Fator de escala para front-ends.
properties.hasLinuxWorkers	boolean		Sinalizador que exibe se um ASE tem trabalhos linux ou não
properties.internalLoadBalancingMode	LoadBalancingMode		Especifica quais pontos de extremidade servir internamente na Rede Virtual para o Ambiente do Serviço de Aplicativo.
properties.ipsslAddressCount	integer (int32)		Número de endereços SSL de IP reservados para o Ambiente do Serviço de Aplicativo.
properties.maximumNumberOfMachines	integer (int32)		Número máximo de VMs no Ambiente do Serviço de Aplicativo.
properties.multiRoleCount	integer (int32)		Número de instâncias front-end.
properties.multiSize	string		Tamanho da VM de front-end, por exemplo, "Médio", "Grande".
properties.networkingConfiguration	AseV3NetworkingConfiguration		Exibição completa da configuração de rede para um ASE.
properties.provisioningState	ProvisioningState		Estado de provisionamento do Ambiente do Serviço de Aplicativo.
properties.status	HostingEnvironmentStatus		Status atual do Ambiente do Serviço de Aplicativo.
properties.suspended	boolean		`true` se o Ambiente do Serviço de Aplicativo estiver suspenso; caso contrário, `false`. O ambiente pode ser suspenso, por exemplo, quando o ponto de extremidade de gerenciamento não está mais disponível (provavelmente porque o NSG bloqueou o tráfego de entrada).
properties.upgradeAvailability	UpgradeAvailability		Se uma atualização está disponível para este Ambiente do Serviço de Aplicativo.
properties.upgradePreference	UpgradePreference	None	Preferência de Atualização
properties.userWhitelistedIpRanges	string[]		O usuário adicionou intervalos de ip à lista de permissões no banco de dados ASE
properties.virtualNetwork	VirtualNetworkProfile		Descrição da Rede Virtual.
properties.zoneRedundant	boolean		Se esse Ambiente do Serviço de Aplicativo tem ou não redundância de zona.
type	string		Tipo de recurso.

AppServiceEnvironmentResource

Objeto

Recurso ARM do Ambiente do Serviço de Aplicativo.

Nome	Tipo	Valor padrão	Description
id	string		ID do recurso.
kind	string		Tipo de recurso. Se o recurso for um aplicativo, você poderá consultar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference para obter detalhes de valores com suporte para tipo.
location	string		Local do recurso.
name	string		Nome do Recurso.
properties.clusterSettings	NameValuePair[]		Configurações personalizadas para alterar o comportamento do Ambiente do Serviço de Aplicativo.
properties.customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Exibição completa da configuração de sufixo de domínio personalizado para ASEv3.
properties.dedicatedHostCount	integer (int32)		Contagem de host dedicada
properties.dnsSuffix	string		Sufixo DNS do Ambiente do Serviço de Aplicativo.
properties.frontEndScaleFactor	integer (int32)		Fator de escala para front-ends.
properties.hasLinuxWorkers	boolean		Sinalizador que exibe se um ASE tem trabalhos linux ou não
properties.internalLoadBalancingMode	LoadBalancingMode		Especifica quais pontos de extremidade servir internamente na Rede Virtual para o Ambiente do Serviço de Aplicativo.
properties.ipsslAddressCount	integer (int32)		Número de endereços SSL de IP reservados para o Ambiente do Serviço de Aplicativo.
properties.maximumNumberOfMachines	integer (int32)		Número máximo de VMs no Ambiente do Serviço de Aplicativo.
properties.multiRoleCount	integer (int32)		Número de instâncias front-end.
properties.multiSize	string		Tamanho da VM de front-end, por exemplo, "Médio", "Grande".
properties.networkingConfiguration	AseV3NetworkingConfiguration		Exibição completa da configuração de rede para um ASE.
properties.provisioningState	ProvisioningState		Estado de provisionamento do Ambiente do Serviço de Aplicativo.
properties.status	HostingEnvironmentStatus		Status atual do Ambiente do Serviço de Aplicativo.
properties.suspended	boolean		`true` se o Ambiente do Serviço de Aplicativo estiver suspenso; caso contrário, `false`. O ambiente pode ser suspenso, por exemplo, quando o ponto de extremidade de gerenciamento não está mais disponível (provavelmente porque o NSG bloqueou o tráfego de entrada).
properties.upgradeAvailability	UpgradeAvailability		Se uma atualização está disponível para este Ambiente do Serviço de Aplicativo.
properties.upgradePreference	UpgradePreference	None	Preferência de Atualização
properties.userWhitelistedIpRanges	string[]		O usuário adicionou intervalos de ip à lista de permissões no banco de dados ASE
properties.virtualNetwork	VirtualNetworkProfile		Descrição da Rede Virtual.
properties.zoneRedundant	boolean		Se esse Ambiente do Serviço de Aplicativo tem ou não redundância de zona.
tags	object		Tags de recursos.
type	string		Tipo de recurso.

AseV3NetworkingConfiguration

Objeto

Exibição completa da configuração de rede para um ASE.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.allowNewPrivateEndpointConnections	boolean	Propriedade para habilitar e desabilitar a criação de nova conexão de ponto de extremidade privado no ASE
properties.externalInboundIpAddresses	string[]
properties.ftpEnabled	boolean	Propriedade para habilitar e desabilitar o FTP no ASEV3
properties.inboundIpAddressOverride	string	Endereço IP de entrada fornecido pelo cliente. Só é possível definir na criação do Ase.
properties.internalInboundIpAddresses	string[]
properties.linuxOutboundIpAddresses	string[]
properties.remoteDebugEnabled	boolean	Propriedade para habilitar e desabilitar a Depuração Remota no ASEV3
properties.windowsOutboundIpAddresses	string[]
type	string	Tipo de recurso.

CustomDnsSuffixConfiguration

Objeto

Exibição completa da configuração de sufixo de domínio personalizado para ASEv3.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.certificateUrl	string	A URL que faz referência ao segredo do certificado do Azure Key Vault que deve ser usado como o certificado SSL/TLS padrão para sites com o sufixo de domínio personalizado.
properties.dnsSuffix	string	O sufixo de domínio personalizado padrão a ser usado para todos os sites implantados no ASE.
properties.keyVaultReferenceIdentity	string	A identidade atribuída pelo usuário a ser usada para resolver a referência de certificado do cofre de chaves. Se não for especificado, a identidade ASE atribuída pelo sistema será usada se disponível.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	Tipo de recurso.

CustomDnsSuffixProvisioningState

Enumeração

Valor	Description
Degraded
Failed
InProgress
Succeeded

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

HostingEnvironmentStatus

Enumeração

Status atual do Ambiente do Serviço de Aplicativo.

Valor	Description
Deleting
Preparing
Ready
Scaling

LoadBalancingMode

Enumeração

Especifica quais pontos de extremidade servir internamente na Rede Virtual para o Ambiente do Serviço de Aplicativo.

Valor	Description
None
Publishing
Web
Web, Publishing

NameValuePair

Objeto

Par de valores de nome.

Nome	Tipo	Description
name	string	Nome do par.
value	string	Valor do par.

ProvisioningState

Enumeração

Estado de provisionamento do Ambiente do Serviço de Aplicativo.

Valor	Description
Canceled
Deleting
Failed
InProgress
Succeeded

UpgradeAvailability

Enumeração

Se uma atualização está disponível para este Ambiente do Serviço de Aplicativo.

Valor	Description
None	Nenhuma atualização está disponível no momento para este Ambiente do Serviço de Aplicativo
Ready	Uma atualização está pronta para ser iniciada manualmente neste Ambiente do Serviço de Aplicativo

UpgradePreference

Enumeração

Preferência de Atualização

Valor	Description
Early	Esse Ambiente do Serviço de Aplicativo será atualizado antes de outros na mesma região que têm a Preferência de Atualização 'Atrasada'
Late	Esse Ambiente do Serviço de Aplicativo será atualizado após outros na mesma região que têm a Preferência de Atualização 'Antecipada'
Manual	Somente ASEv3. Depois que uma atualização estiver disponível, esse Ambiente do Serviço de Aplicativo aguardará 10 dias para que a atualização seja iniciada manualmente. Após 10 dias, a atualização será iniciada automaticamente
None	Nenhuma preferência sobre quando esse Ambiente do Serviço de Aplicativo será atualizado

VirtualNetworkProfile

Objeto

Especificação para usar uma Rede Virtual.

Nome	Tipo	Description
id	string	ID do recurso da Rede Virtual.
name	string	Nome da Rede Virtual (somente leitura).
subnet	string	Sub-rede dentro da Rede Virtual.
type	string	Tipo de recurso da Rede Virtual (somente leitura).

Compartilhar via

App Service Environments - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

Create or update an App Service Environment.

Solicitação de exemplo

Resposta de exemplo

Definições

AppServiceEnvironmentPatchResource

AppServiceEnvironmentResource

AseV3NetworkingConfiguration

CustomDnsSuffixConfiguration

CustomDnsSuffixProvisioningState

DefaultErrorResponse

Details

Error

HostingEnvironmentStatus

LoadBalancingMode

NameValuePair

ProvisioningState

UpgradeAvailability

UpgradePreference

VirtualNetworkProfile