Web Apps - Get Configuration

Serviço:

App Service

Versão da API:

2024-04-01

Descrição para Obter a configuração de um aplicativo, como versão e bitness da plataforma, documentos padrão, aplicativos virtuais, Always On etc.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web?api-version=2024-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do aplicativo.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Padrão Regex: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Sua ID de 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

Respostas

Nome	Tipo	Description
200 OK	SiteConfigResource	OKEY
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

Get Site Config

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web?api-version=2024-04-01

Java

/**
 * Samples for WebApps GetConfiguration.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteConfig.json
     */
    /**
     * Sample code: Get Site Config.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getSiteConfig(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getConfigurationWithResponse("testrg123", "sitef6141",
            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 get_site_config.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.web_apps.get_configuration(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteConfig.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteConfig.json
func ExampleWebAppsClient_GetConfiguration() {
	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.NewWebAppsClient().GetConfiguration(ctx, "testrg123", "sitef6141", 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.SiteConfigResource = armappservice.SiteConfigResource{
	// 	Name: to.Ptr("web"),
	// 	Type: to.Ptr("Microsoft.Web/sites/config"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteConfig{
	// 		AcrUseManagedIdentityCreds: to.Ptr(false),
	// 		AlwaysOn: to.Ptr(false),
	// 		AppCommandLine: to.Ptr(""),
	// 		AutoHealEnabled: to.Ptr(false),
	// 		AzureStorageAccounts: map[string]*armappservice.AzureStorageInfoValue{
	// 		},
	// 		DefaultDocuments: []*string{
	// 			to.Ptr("Default.htm"),
	// 			to.Ptr("Default.html"),
	// 			to.Ptr("Default.asp"),
	// 			to.Ptr("index.htm"),
	// 			to.Ptr("index.html"),
	// 			to.Ptr("iisstart.htm"),
	// 			to.Ptr("default.aspx"),
	// 			to.Ptr("index.php"),
	// 			to.Ptr("hostingstart.html")},
	// 			DetailedErrorLoggingEnabled: to.Ptr(false),
	// 			FtpsState: to.Ptr(armappservice.FtpsStateAllAllowed),
	// 			FunctionAppScaleLimit: to.Ptr[int32](0),
	// 			FunctionsRuntimeScaleMonitoringEnabled: to.Ptr(false),
	// 			Http20Enabled: to.Ptr(false),
	// 			HTTPLoggingEnabled: to.Ptr(false),
	// 			LinuxFxVersion: to.Ptr(""),
	// 			LoadBalancing: to.Ptr(armappservice.SiteLoadBalancingLeastRequests),
	// 			LogsDirectorySizeLimit: to.Ptr[int32](35),
	// 			ManagedPipelineMode: to.Ptr(armappservice.ManagedPipelineModeIntegrated),
	// 			MinTLSVersion: to.Ptr(armappservice.SupportedTLSVersionsOne2),
	// 			MinimumElasticInstanceCount: to.Ptr[int32](0),
	// 			NetFrameworkVersion: to.Ptr("v4.0"),
	// 			NodeVersion: to.Ptr(""),
	// 			NumberOfWorkers: to.Ptr[int32](1),
	// 			PhpVersion: to.Ptr("5.6"),
	// 			PowerShellVersion: to.Ptr(""),
	// 			PythonVersion: to.Ptr(""),
	// 			RemoteDebuggingEnabled: to.Ptr(false),
	// 			RequestTracingEnabled: to.Ptr(false),
	// 			ScmMinTLSVersion: to.Ptr(armappservice.SupportedTLSVersionsOne2),
	// 			Use32BitWorkerProcess: to.Ptr(true),
	// 			VirtualApplications: []*armappservice.VirtualApplication{
	// 				{
	// 					PhysicalPath: to.Ptr("site\\wwwroot"),
	// 					PreloadEnabled: to.Ptr(false),
	// 					VirtualPath: to.Ptr("/"),
	// 			}},
	// 			VnetName: to.Ptr(""),
	// 			VnetPrivatePortsCount: to.Ptr[int32](0),
	// 			VnetRouteAllEnabled: to.Ptr(false),
	// 			WebSocketsEnabled: to.Ptr(false),
	// 		},
	// 	}
}

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 Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
 *
 * @summary Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/GetSiteConfig.json
 */
async function getSiteConfig() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getConfiguration(resourceGroupName, name);
  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-04-01/examples/GetSiteConfig.json
// this example is just showing the usage of "WebApps_GetConfiguration" 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 WebSiteConfigResource created on azure
// for more information of creating WebSiteConfigResource, please refer to the document of WebSiteConfigResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteConfigResourceId = WebSiteConfigResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteConfigResource webSiteConfig = client.GetWebSiteConfigResource(webSiteConfigResourceId);

// invoke the operation
WebSiteConfigResource result = await webSiteConfig.GetAsync();

// 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
SiteConfigData 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/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web",
  "name": "web",
  "type": "Microsoft.Web/sites/config",
  "kind": "app",
  "properties": {
    "numberOfWorkers": 1,
    "defaultDocuments": [
      "Default.htm",
      "Default.html",
      "Default.asp",
      "index.htm",
      "index.html",
      "iisstart.htm",
      "default.aspx",
      "index.php",
      "hostingstart.html"
    ],
    "netFrameworkVersion": "v4.0",
    "phpVersion": "5.6",
    "pythonVersion": "",
    "nodeVersion": "",
    "powerShellVersion": "",
    "linuxFxVersion": "",
    "requestTracingEnabled": false,
    "remoteDebuggingEnabled": false,
    "httpLoggingEnabled": false,
    "acrUseManagedIdentityCreds": false,
    "logsDirectorySizeLimit": 35,
    "detailedErrorLoggingEnabled": false,
    "use32BitWorkerProcess": true,
    "webSocketsEnabled": false,
    "alwaysOn": false,
    "appCommandLine": "",
    "managedPipelineMode": "Integrated",
    "virtualApplications": [
      {
        "virtualPath": "/",
        "physicalPath": "site\\wwwroot",
        "preloadEnabled": false
      }
    ],
    "loadBalancing": "LeastRequests",
    "autoHealEnabled": false,
    "vnetName": "",
    "vnetRouteAllEnabled": false,
    "vnetPrivatePortsCount": 0,
    "http20Enabled": false,
    "minTlsVersion": "1.2",
    "scmMinTlsVersion": "1.2",
    "ftpsState": "AllAllowed",
    "functionAppScaleLimit": 0,
    "functionsRuntimeScaleMonitoringEnabled": false,
    "minimumElasticInstanceCount": 0,
    "azureStorageAccounts": {}
  }
}

Definições

Nome	Description
ApiDefinitionInfo	Informações sobre a definição formal da API para o aplicativo.
ApiManagementConfig	Configuração de APIM (gerenciamento de API do Azure) vinculada ao aplicativo.
AutoHealActions	Ações que serão executadas pelo módulo de recuperação automática quando uma regra é disparada.
AutoHealActionType	Ação predefinida a ser tomada.
AutoHealCustomAction	Ação personalizada a ser executada quando uma regra de recuperação automática é disparada.
AutoHealRules	Regras que podem ser definidas para cura automática.
AutoHealTriggers	Gatilhos para cura automática.
AzureStorageInfoValue	Os Arquivos do Azure ou o valor das informações de acesso ao Armazenamento de Blobs para armazenamento de dicionário.
AzureStorageProtocol	Protocolo de montagem a ser usado para a conta de armazenamento.
AzureStorageState	Estado da conta de armazenamento.
AzureStorageType	Tipo de armazenamento.
ConnectionStringType	Tipo de banco de dados.
ConnStringInfo	Informações da cadeia de conexão de banco de dados.
CorsSettings	Configurações de CORS (Compartilhamento de Recursos entre Origens) para o aplicativo.
DefaultAction	Ação padrão para restrição de acesso principal se nenhuma regra for correspondida.
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
Experiments	Regras de roteamento em experimentos de produção.
FtpsState	Estado do serviço FTP/FTPS
HandlerMapping	Os mapeamentos de manipulador do IIS usados para definir qual manipulador processa solicitações HTTP com determinada extensão. Por exemplo, ele é usado para configurar php-cgi.exe processo para lidar com todas as solicitações HTTP com *.php extensão.
IpFilterTag	Define para que esse filtro IP será usado. Isso é para dar suporte à filtragem de IP em proxies.
IpSecurityRestriction	Restrição de segurança de IP em um aplicativo.
ManagedPipelineMode	Modo de pipeline gerenciado.
NameValuePair	Par de valores de nome.
PushSettings	Configurações de push para o Aplicativo.
RampUpRule	Regras de roteamento para aumentar o teste. Essa regra permite redirecionar o tráfego estático % para um slot ou alterar gradualmente os % de roteamento com base no desempenho.
RequestsBasedTrigger	Gatilho com base no total de solicitações.
ScmType	Tipo de SCM.
SiteConfigResource	Recurso ARM de configuração de aplicativo Web.
SiteLimits	Limites de métrica definidos em um aplicativo.
SiteLoadBalancing	Balanceamento de carga do site.
SiteMachineKey	MachineKey de um aplicativo.
SlowRequestsBasedTrigger	Gatilho com base no tempo de execução da solicitação.
StatusCodesBasedTrigger	Gatilho com base no código de status.
StatusCodesRangeBasedTrigger	Gatilho com base no intervalo de códigos de status.
SupportedTlsVersions	MinTlsVersion: configura a versão mínima do TLS necessária para solicitações SSL
TlsCipherSuites	O pacote de criptografia TLS de força mínima permitido para um aplicativo
VirtualApplication	Aplicativo virtual em um aplicativo.
VirtualDirectory	Diretório para aplicativo virtual.

ApiDefinitionInfo

Object

Informações sobre a definição formal da API para o aplicativo.

Nome	Tipo	Description
url	string	A URL da definição da API.

ApiManagementConfig

Object

Configuração de APIM (gerenciamento de API do Azure) vinculada ao aplicativo.

Nome	Tipo	Description
id	string	identificador de APIM-Api.

AutoHealActions

Object

Ações que serão executadas pelo módulo de recuperação automática quando uma regra é disparada.

Nome	Tipo	Description
actionType	AutoHealActionType	Ação predefinida a ser tomada.
customAction	AutoHealCustomAction	Ação personalizada a ser tomada.
minProcessExecutionTime	string	Tempo mínimo que o processo deve executar antes de executar a ação

AutoHealActionType

Enumeration

Ação predefinida a ser tomada.

Valor	Description
CustomAction
LogEvent
Recycle

AutoHealCustomAction

Object

Ação personalizada a ser executada quando uma regra de recuperação automática é disparada.

Nome	Tipo	Description
exe	string	Executável a ser executado.
parameters	string	Parâmetros para o executável.

AutoHealRules

Object

Regras que podem ser definidas para cura automática.

Nome	Tipo	Description
actions	AutoHealActions	Ações a serem executadas quando uma regra é disparada.
triggers	AutoHealTriggers	Condições que descrevem quando executar as ações de recuperação automática.

AutoHealTriggers

Object

Gatilhos para cura automática.

Nome	Tipo	Description
privateBytesInKB	integer	Uma regra baseada em bytes privados.
requests	RequestsBasedTrigger	Uma regra baseada no total de solicitações.
slowRequests	SlowRequestsBasedTrigger	Uma regra baseada no tempo de execução da solicitação.
slowRequestsWithPath	SlowRequestsBasedTrigger[]	Uma regra baseada em várias regras de solicitações lentas com caminho
statusCodes	StatusCodesBasedTrigger[]	Uma regra baseada em códigos de status.
statusCodesRange	StatusCodesRangeBasedTrigger[]	Uma regra baseada em intervalos de códigos de status.

AzureStorageInfoValue

Object

Os Arquivos do Azure ou o valor das informações de acesso ao Armazenamento de Blobs para armazenamento de dicionário.

Nome	Tipo	Description
accessKey	string	Chave de acesso para a conta de armazenamento.
accountName	string	Nome da conta de armazenamento.
mountPath	string	Caminho para montar o armazenamento no ambiente de runtime do site.
protocol	AzureStorageProtocol	Protocolo de montagem a ser usado para a conta de armazenamento.
shareName	string	Nome do compartilhamento de arquivos (nome do contêiner, para armazenamento de Blobs).
state	AzureStorageState	Estado da conta de armazenamento.
type	AzureStorageType	Tipo de armazenamento.

AzureStorageProtocol

Enumeration

Protocolo de montagem a ser usado para a conta de armazenamento.

Valor	Description
Http
Nfs
Smb

AzureStorageState

Enumeration

Estado da conta de armazenamento.

Valor	Description
InvalidCredentials
InvalidShare
NotValidated
Ok

AzureStorageType

Enumeration

Tipo de armazenamento.

Valor	Description
AzureBlob
AzureFiles

ConnectionStringType

Enumeration

Tipo de banco de dados.

Valor	Description
ApiHub
Custom
DocDb
EventHub
MySql
NotificationHub
PostgreSQL
RedisCache
SQLAzure
SQLServer
ServiceBus

ConnStringInfo

Object

Informações da cadeia de conexão de banco de dados.

Nome	Tipo	Description
connectionString	string	Valor da cadeia de conexão.
name	string	Nome da cadeia de conexão.
type	ConnectionStringType	Tipo de banco de dados.

CorsSettings

Object

Configurações de CORS (Compartilhamento de Recursos entre Origens) para o aplicativo.

Nome	Tipo	Description
allowedOrigins	string[]	Obtém ou define a lista de origens que devem ter permissão para fazer chamadas entre origens (por exemplo: http://example.com:12345). Use "*" para permitir tudo.
supportCredentials	boolean	Obtém ou define se as solicitações CORS com credenciais são permitidas. Consulte https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials para obter mais detalhes.

DefaultAction

Enumeration

Ação padrão para restrição de acesso principal se nenhuma regra for correspondida.

Valor	Description
Allow
Deny

DefaultErrorResponse

Object

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Object

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

Object

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.

Experiments

Object

Regras de roteamento em experimentos de produção.

Nome	Tipo	Description
rampUpRules	RampUpRule[]	Lista de regras de ramp-up.

FtpsState

Enumeration

Estado do serviço FTP/FTPS

Valor	Description
AllAllowed
Disabled
FtpsOnly

HandlerMapping

Object

Os mapeamentos de manipulador do IIS usados para definir qual manipulador processa solicitações HTTP com determinada extensão. Por exemplo, ele é usado para configurar php-cgi.exe processo para lidar com todas as solicitações HTTP com *.php extensão.

Nome	Tipo	Description
arguments	string	Argumentos de linha de comando a serem passados para o processador de script.
extension	string	As solicitações com essa extensão serão tratadas usando o aplicativo FastCGI especificado.
scriptProcessor	string	O caminho absoluto para o aplicativo FastCGI.

IpFilterTag

Enumeration

Define para que esse filtro IP será usado. Isso é para dar suporte à filtragem de IP em proxies.

Valor	Description
Default
ServiceTag
XffProxy

IpSecurityRestriction

Object

Restrição de segurança de IP em um aplicativo.

Nome	Tipo	Description
action	string	Permitir ou negar acesso para esse intervalo de IP.
description	string	Descrição da regra de restrição de IP.
headers	object	Cabeçalhos de regra de restrição de IP. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). A lógica correspondente é .. Se a propriedade for nula ou vazia (padrão), todos os hosts (ou falta de) serão permitidos. Um valor é comparado usando ordinal-ignore-case (excluindo o número da porta). Caracteres curinga de subdomínio são permitidos, mas não correspondem ao domínio raiz. Por exemplo, *.contoso.com corresponde ao foo.contoso.com de subdomínio, mas não ao domínio raiz contoso.com ou foo.bar.contoso.com de vários níveis Os nomes de host Unicode são permitidos, mas são convertidos em Punycode para correspondência. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). A lógica correspondente é .. Se a propriedade for nula ou vazia (padrão), quaisquer cadeias encaminhadas (ou falta de) serão permitidas. Se qualquer endereço (excluindo o número da porta) na cadeia (vírgula separada) corresponder à CIDR definida pela propriedade. X-Azure-FDID e X-FD-HealthProbe. A lógica correspondente é a correspondência exata.
ipAddress	string	Endereço IP para o qual a restrição de segurança é válida. Ele pode estar na forma de endereço ipv4 puro (propriedade SubnetMask necessária) ou notação CIDR, como ipv4/mask (correspondência de bits à esquerda). Para CIDR, a propriedade SubnetMask não deve ser especificada.
name	string	Nome da regra de restrição de IP.
priority	integer	Prioridade da regra de restrição de IP.
subnetMask	string	Máscara de sub-rede para o intervalo de endereços IP para os quais a restrição é válida.
subnetTrafficTag	integer	(interno) Marca de tráfego de sub-rede
tag	IpFilterTag	Define para que esse filtro IP será usado. Isso é para dar suporte à filtragem de IP em proxies.
vnetSubnetResourceId	string	ID do recurso de rede virtual
vnetTrafficTag	integer	(interno) Marca de tráfego de rede virtual

ManagedPipelineMode

Enumeration

Modo de pipeline gerenciado.

Valor	Description
Classic
Integrated

NameValuePair

Object

Par de valores de nome.

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

PushSettings

Object

Configurações de push para o Aplicativo.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do recurso.
properties.dynamicTagsJson	string	Obtém ou define uma cadeia de caracteres JSON que contém uma lista de marcas dinâmicas que serão avaliadas de declarações de usuário no ponto de extremidade de registro por push.
properties.isPushEnabled	boolean	Obtém ou define um sinalizador que indica se o ponto de extremidade push está habilitado.
properties.tagWhitelistJson	string	Obtém ou define uma cadeia de caracteres JSON que contém uma lista de marcas que estão na lista de permissões para uso pelo ponto de extremidade de registro por push.
properties.tagsRequiringAuth	string	Obtém ou define uma cadeia de caracteres JSON que contém uma lista de marcas que exigem que a autenticação do usuário seja usada no ponto de extremidade de registro por push. As marcas podem consistir em caracteres alfanuméricos e o seguinte: '_', '@', '#', '.', ':', '-'. A validação deve ser executada no PushRequestHandler.
type	string	Tipo de recurso.

RampUpRule

Object

Regras de roteamento para aumentar o teste. Essa regra permite redirecionar o tráfego estático % para um slot ou alterar gradualmente os % de roteamento com base no desempenho.

Nome	Tipo	Description
actionHostName	string	Nome do host de um slot para o qual o tráfego será redirecionado se for decidido. Por exemplo, myapp-stage.azurewebsites.net.
changeDecisionCallbackUrl	string	O algoritmo de decisão personalizado pode ser fornecido na extensão do site TiPCallback, qual URL pode ser especificada.
changeIntervalInMinutes	integer	Especifica o intervalo em minutos para reavaliar ReroutePercentage.
changeStep	number	No cenário de aumento automático, esta é a etapa para adicionar/remover de ReroutePercentage até atingir \nMinReroutePercentage ou MaxReroutePercentage. As métricas do site são verificadas a cada N minutos especificados em ChangeIntervalInMinutes.\nalgoritmo de decisão personalizado pode ser fornecido na extensão do site TiPCallback, qual URL pode ser especificada em ChangeDecisionCallbackUrl.
maxReroutePercentage	number	Especifica o limite superior abaixo do qual ReroutePercentage permanecerá.
minReroutePercentage	number	Especifica o limite inferior acima do qual ReroutePercentage permanecerá.
name	string	Nome da regra de roteamento. O nome recomendado seria apontar para o slot que receberá o tráfego no experimento.
reroutePercentage	number	Porcentagem do tráfego que será redirecionado para ActionHostName.

RequestsBasedTrigger

Object

Gatilho com base no total de solicitações.

Nome	Tipo	Description
count	integer	Contagem de solicitações.
timeInterval	string	Intervalo de tempo.

ScmType

Enumeration

Tipo de SCM.

Valor	Description
BitbucketGit
BitbucketHg
CodePlexGit
CodePlexHg
Dropbox
ExternalGit
ExternalHg
GitHub
LocalGit
None
OneDrive
Tfs
VSO
VSTSRM

SiteConfigResource

Object

Recurso ARM de configuração de aplicativo Web.

Nome	Tipo	Valor padrão	Description
id	string		ID do recurso.
kind	string		Tipo de recurso.
name	string		Nome do recurso.
properties.acrUseManagedIdentityCreds	boolean		Sinalizador para usar creds de identidade gerenciada para pull do ACR
properties.acrUserManagedIdentityID	string		Se estiver usando a identidade gerenciada pelo usuário, a identidade gerenciada do usuário ClientId
properties.alwaysOn	boolean		true se Always On estiver habilitado; caso contrário, false.
properties.apiDefinition	ApiDefinitionInfo		Informações sobre a definição formal da API para o aplicativo.
properties.apiManagementConfig	ApiManagementConfig		Configurações de gerenciamento de API do Azure vinculadas ao aplicativo.
properties.appCommandLine	string		Linha de comando do aplicativo a ser iniciada.
properties.appSettings	NameValuePair[]		Configurações do aplicativo.
properties.autoHealEnabled	boolean		true se a Recuperação Automática estiver habilitada; caso contrário, false.
properties.autoHealRules	AutoHealRules		Regras de cura automática.
properties.autoSwapSlotName	string		Nome do slot de troca automática.
properties.azureStorageAccounts	<string,  AzureStorageInfoValue>		Lista de Contas de Armazenamento do Azure.
properties.connectionStrings	ConnStringInfo[]		Cadeias de conexão.
properties.cors	CorsSettings		Configurações de CORS (Compartilhamento de Recursos entre Origens).
properties.defaultDocuments	string[]		Documentos padrão.
properties.detailedErrorLoggingEnabled	boolean		true se o log de erros detalhado estiver habilitado; caso contrário, false.
properties.documentRoot	string		Raiz do documento.
properties.elasticWebAppScaleLimit	integer		Número máximo de trabalhos para os quais um site pode ser dimensionado. Essa configuração só se aplica a aplicativos em planos em que o ElasticScaleEnabled é true
properties.experiments	Experiments		Isso é uma solução alternativa para tipos polimórficos.
properties.ftpsState	FtpsState		Estado do serviço FTP/FTPS
properties.functionAppScaleLimit	integer		Número máximo de trabalhos para os quais um site pode ser dimensionado. Essa configuração só se aplica aos Planos De Consumo e Elástico Premium
properties.functionsRuntimeScaleMonitoringEnabled	boolean		Obtém ou define um valor que indica se o monitoramento de escala de runtime de funções está habilitado. Quando habilitado, o ScaleController não monitorará diretamente as fontes de eventos, mas chamará o runtime para obter o status de escala.
properties.handlerMappings	HandlerMapping[]		Mapeamentos de manipulador.
properties.healthCheckPath	string		Caminho de verificação de integridade
properties.http20Enabled	boolean	True	Http20Enabled: configura um site para permitir que os clientes se conectem via http2.0
properties.httpLoggingEnabled	boolean		true se o registro em log HTTP estiver habilitado; caso contrário, false.
properties.ipSecurityRestrictions	IpSecurityRestriction[]		Restrições de segurança de IP para principal.
properties.ipSecurityRestrictionsDefaultAction	DefaultAction		Ação padrão para restrição de acesso principal se nenhuma regra for correspondida.
properties.javaContainer	string		Contêiner Java.
properties.javaContainerVersion	string		Versão do contêiner java.
properties.javaVersion	string		Versão do Java.
properties.keyVaultReferenceIdentity	string		Identidade a ser usada para autenticação de referência do Key Vault.
properties.limits	SiteLimits		Limites de site.
properties.linuxFxVersion	string		Estrutura e versão do Aplicativo Linux
properties.loadBalancing	SiteLoadBalancing		Balanceamento de carga do site.
properties.localMySqlEnabled	boolean	False	true habilitar o MySQL local; caso contrário, false.
properties.logsDirectorySizeLimit	integer		Limite de tamanho do diretório de logs HTTP.
properties.machineKey	SiteMachineKey		Site MachineKey.
properties.managedPipelineMode	ManagedPipelineMode		Modo de pipeline gerenciado.
properties.managedServiceIdentityId	integer		ID da identidade do serviço gerenciado
properties.metadata	NameValuePair[]		Metadados do aplicativo. Essa propriedade não pode ser recuperada, pois pode conter segredos.
properties.minTlsCipherSuite	TlsCipherSuites		O pacote de criptografia TLS de força mínima permitido para um aplicativo
properties.minTlsVersion	SupportedTlsVersions		MinTlsVersion: configura a versão mínima do TLS necessária para solicitações SSL
properties.minimumElasticInstanceCount	integer		Número de contagem mínima de instâncias para um site Essa configuração só se aplica aos Planos Elásticos
properties.netFrameworkVersion	string	v4.6	Versão do .NET Framework.
properties.nodeVersion	string		Versão do Node.js.
properties.numberOfWorkers	integer		Número de trabalhadores.
properties.phpVersion	string		Versão do PHP.
properties.powerShellVersion	string		Versão do PowerShell.
properties.preWarmedInstanceCount	integer		Número de instâncias pré-armadas. Essa configuração só se aplica aos Planos elásticos e de consumo
properties.publicNetworkAccess	string		Propriedade para permitir ou bloquear todo o tráfego público.
properties.publishingUsername	string		Publicando o nome de usuário.
properties.push	PushSettings		Configurações de ponto de extremidade por push.
properties.pythonVersion	string		Versão do Python.
properties.remoteDebuggingEnabled	boolean		true se a depuração remota estiver habilitada; caso contrário, false.
properties.remoteDebuggingVersion	string		Versão de depuração remota.
properties.requestTracingEnabled	boolean		true se o rastreamento de solicitação estiver habilitado; caso contrário, false.
properties.requestTracingExpirationTime	string		Solicitar tempo de expiração de rastreamento.
properties.scmIpSecurityRestrictions	IpSecurityRestriction[]		Restrições de segurança de IP para scm.
properties.scmIpSecurityRestrictionsDefaultAction	DefaultAction		Ação padrão para restrição de acesso scm se nenhuma regra for correspondida.
properties.scmIpSecurityRestrictionsUseMain	boolean		Restrições de segurança de IP para scm usar principal.
properties.scmMinTlsVersion	SupportedTlsVersions		ScmMinTlsVersion: configura a versão mínima do TLS necessária para solicitações SSL para o site do SCM
properties.scmType	ScmType		Tipo de SCM.
properties.tracingOptions	string		Opções de rastreamento.
properties.use32BitWorkerProcess	boolean		true usar o processo de trabalho de 32 bits; caso contrário, false.
properties.virtualApplications	VirtualApplication[]		Aplicativos virtuais.
properties.vnetName	string		Nome da Rede Virtual.
properties.vnetPrivatePortsCount	integer		O número de portas privadas atribuídas a este aplicativo. Elas serão atribuídas dinamicamente em runtime.
properties.vnetRouteAllEnabled	boolean		Roteamento de Rede Virtual Habilitado. Isso faz com que todo o tráfego de saída tenha grupos de segurança de rede virtual e rotas definidas pelo usuário aplicadas.
properties.webSocketsEnabled	boolean		true se o WebSocket estiver habilitado; caso contrário, false.
properties.websiteTimeZone	string		Define o fuso horário que um site usa para gerar carimbos de data/hora. Compatível com o Linux e o Serviço de Aplicativo do Windows. Definir a configuração do aplicativo WEBSITE_TIME_ZONE tem precedência sobre essa configuração. Para Linux, espera valores de banco de dados tz https://www.iana.org/time-zones (para obter uma referência rápida, consulte https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Para o Windows, espera um dos fusos horários listados em HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones
properties.windowsFxVersion	string		Xenon App Framework e versão
properties.xManagedServiceIdentityId	integer		ID de identidade de serviço gerenciada explícita
type	string		Tipo de recurso.

SiteLimits

Object

Limites de métrica definidos em um aplicativo.

Nome	Tipo	Description
maxDiskSizeInMb	integer	Uso máximo de tamanho de disco permitido em MB.
maxMemoryInMb	integer	Uso máximo de memória permitido em MB.
maxPercentageCpu	number	Percentual máximo de uso de CPU permitido.

SiteLoadBalancing

Enumeration

Balanceamento de carga do site.

Valor	Description
LeastRequests
LeastRequestsWithTieBreaker
LeastResponseTime
PerSiteRoundRobin
RequestHash
WeightedRoundRobin
WeightedTotalTraffic

SiteMachineKey

Object

MachineKey de um aplicativo.

Nome	Tipo	Description
decryption	string	Algoritmo usado para descriptografia.
decryptionKey	string	Chave de descriptografia.
validation	string	Validação do MachineKey.
validationKey	string	Chave de validação.

SlowRequestsBasedTrigger

Object

Gatilho com base no tempo de execução da solicitação.

Nome	Tipo	Description
count	integer	Contagem de solicitações.
path	string	Caminho da solicitação.
timeInterval	string	Intervalo de tempo.
timeTaken	string	Tempo necessário.

StatusCodesBasedTrigger

Object

Gatilho com base no código de status.

Nome	Tipo	Description
count	integer	Contagem de solicitações.
path	string	Caminho da solicitação
status	integer	Código de status HTTP.
subStatus	integer	Solicitar sub status.
timeInterval	string	Intervalo de tempo.
win32Status	integer	Código de erro Win32.

StatusCodesRangeBasedTrigger

Object

Gatilho com base no intervalo de códigos de status.

Nome	Tipo	Description
count	integer	Contagem de solicitações.
path	string
statusCodes	string	Código de status HTTP.
timeInterval	string	Intervalo de tempo.

SupportedTlsVersions

Enumeration

MinTlsVersion: configura a versão mínima do TLS necessária para solicitações SSL

Valor	Description
1.0
1.1
1.2
1.3

TlsCipherSuites

Enumeration

O pacote de criptografia TLS de força mínima permitido para um aplicativo

Valor	Description
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384

VirtualApplication

Object

Aplicativo virtual em um aplicativo.

Nome	Tipo	Description
physicalPath	string	Caminho físico.
preloadEnabled	boolean	true se o pré-carregamento estiver habilitado; caso contrário, false.
virtualDirectories	VirtualDirectory[]	Diretórios virtuais para aplicativo virtual.
virtualPath	string	Caminho virtual.

VirtualDirectory

Object

Diretório para aplicativo virtual.

Nome	Tipo	Description
physicalPath	string	Caminho físico.
virtualPath	string	Caminho para o aplicativo virtual.