Endpoints - Stop

Referência

Serviço:: CDN

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

Para um ponto final da CDN em execução existente.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop?api-version=2024-02-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpointName	path	True	string	Nome do ponto final no perfil que é exclusivo globalmente.
profileName	path	True	string	Nome do perfil da CDN que é exclusivo no grupo de recursos.
resourceGroupName	path	True	string	Nome do Grupo de recursos na subscrição do Azure. Padrão Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	ID da Subscrição do Azure.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente. A versão atual é 2024-02-01.

Respostas

Name	Tipo	Description
200 OK	Endpoint	OK. O pedido foi efetuada com êxito.
202 Accepted	Endpoint	Aceite e a operação será concluída de forma assíncrona. Cabeçalhos location: string
Other Status Codes	ErrorResponse	Resposta de erro da CDN que descreve o motivo pela qual a operação falhou.

Name

Tipo

Description

200 OK

Endpoint

OK. O pedido foi efetuada com êxito.

202 Accepted

Endpoint

Aceite e a operação será concluída de forma assíncrona.

Cabeçalhos

location: string

Other Status Codes

ErrorResponse

Resposta de erro da CDN que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Endpoints_Stop

Pedido de amostra

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/stop?api-version=2024-02-01


/**
 * Samples for Endpoints Stop.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Stop.json
     */
    /**
     * Sample code: Endpoints_Stop.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void endpointsStop(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getEndpoints().stop("RG", "profile1", "endpoint1",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python endpoints_stop.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 = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.endpoints.begin_stop(
        resource_group_name="RG",
        profile_name="profile1",
        endpoint_name="endpoint1",
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Stop.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

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Stop.json
func ExampleEndpointsClient_BeginStop() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewEndpointsClient().BeginStop(ctx, "RG", "profile1", "endpoint1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.Endpoint = armcdn.Endpoint{
	// 	Name: to.Ptr("endpoint4899"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/endpoints"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1"),
	// 	Location: to.Ptr("WestUs"),
	// 	Tags: map[string]*string{
	// 		"kay1": to.Ptr("value1"),
	// 	},
	// 	Properties: &armcdn.EndpointProperties{
	// 		ContentTypesToCompress: []*string{
	// 		},
	// 		GeoFilters: []*armcdn.GeoFilter{
	// 		},
	// 		IsCompressionEnabled: to.Ptr(false),
	// 		IsHTTPAllowed: to.Ptr(true),
	// 		IsHTTPSAllowed: to.Ptr(true),
	// 		OptimizationType: to.Ptr(armcdn.OptimizationTypeDynamicSiteAcceleration),
	// 		OriginHostHeader: to.Ptr("www.bing.com"),
	// 		ProbePath: to.Ptr("/image"),
	// 		QueryStringCachingBehavior: to.Ptr(armcdn.QueryStringCachingBehaviorNotSet),
	// 		HostName: to.Ptr("endpoint1.azureedge.net"),
	// 		Origins: []*armcdn.DeepCreatedOrigin{
	// 			{
	// 				Name: to.Ptr("www-bing-com"),
	// 				Properties: &armcdn.DeepCreatedOriginProperties{
	// 					HostName: to.Ptr("www.bing.com"),
	// 					HTTPPort: to.Ptr[int32](80),
	// 					HTTPSPort: to.Ptr[int32](443),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr(armcdn.EndpointProvisioningStateSucceeded),
	// 		ResourceState: to.Ptr(armcdn.EndpointResourceStateStopping),
	// 	},
	// }
}

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

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Stops an existing running CDN endpoint.
 *
 * @summary Stops an existing running CDN endpoint.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Stop.json
 */
async function endpointsStop() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const endpointName = "endpoint1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.endpoints.beginStopAndWait(
    resourceGroupName,
    profileName,
    endpointName,
  );
  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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-01/examples/Endpoints_Stop.json
// this example is just showing the usage of "CdnEndpoints_Stop" 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 CdnEndpointResource created on azure
// for more information of creating CdnEndpointResource, please refer to the document of CdnEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
ResourceIdentifier cdnEndpointResourceId = CdnEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName);
CdnEndpointResource cdnEndpoint = client.GetCdnEndpointResource(cdnEndpointResourceId);

// invoke the operation
ArmOperation<CdnEndpointResource> lro = await cdnEndpoint.StopAsync(WaitUntil.Completed);
CdnEndpointResource result = lro.Value;

// 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
CdnEndpointData 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 da amostra

Código de estado:: 200

{
  "name": "endpoint4899",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "kay1": "value1"
  },
  "location": "WestUs",
  "properties": {
    "hostName": "endpoint1.azureedge.net",
    "originHostHeader": "www.bing.com",
    "provisioningState": "Succeeded",
    "resourceState": "Stopping",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "NotSet",
    "originPath": null,
    "origins": [
      {
        "name": "www-bing-com",
        "properties": {
          "hostName": "www.bing.com",
          "httpPort": 80,
          "httpsPort": 443
        }
      }
    ],
    "contentTypesToCompress": [],
    "isCompressionEnabled": false,
    "optimizationType": "DynamicSiteAcceleration",
    "probePath": "/image",
    "geoFilters": []
  }
}

Código de estado:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-02-01

{
  "name": "endpoint4899",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1",
  "type": "Microsoft.Cdn/profiles/endpoints",
  "tags": {
    "kay1": "value1"
  },
  "location": "WestUs",
  "properties": {
    "hostName": "endpoint1.azureedge.net",
    "originHostHeader": "www.bing.com",
    "provisioningState": "Succeeded",
    "resourceState": "Stopping",
    "isHttpAllowed": true,
    "isHttpsAllowed": true,
    "queryStringCachingBehavior": "NotSet",
    "originPath": null,
    "origins": [
      {
        "name": "www-bing-com",
        "properties": {
          "hostName": "www.bing.com",
          "httpPort": 80,
          "httpsPort": 443
        }
      }
    ],
    "contentTypesToCompress": [],
    "isCompressionEnabled": false,
    "optimizationType": "DynamicSiteAcceleration",
    "probePath": "/image",
    "geoFilters": []
  }
}

Definições

Name	Description
algorithm	Algoritmo a utilizar para assinatura de URL
cacheBehavior	Comportamento de colocação em cache dos pedidos
CacheConfiguration	Definições de colocação em cache de uma rota do tipo colocação em cache. Para desativar a colocação em cache, não forneça um objeto cacheConfiguration.
CacheExpirationActionParameters	Define os parâmetros para a ação de expiração da cache.
CacheKeyQueryStringActionParameters	Define os parâmetros para a ação da cadeia de consulta da chave de cache.
CacheType	O nível no qual o conteúdo tem de ser colocado em cache.
ClientPortMatchConditionParameters	Define os parâmetros para condições de correspondência clientPort
ClientPortOperator	Descreve o operador a ser correspondido
CookiesMatchConditionParameters	Define os parâmetros para as condições de correspondência de Cookies
CookiesOperator	Descreve o operador a ser correspondido
DeepCreatedCustomDomain	Domínios personalizados criados no ponto final da CDN.
DeepCreatedOrigin	A origem principal do conteúdo da CDN que é adicionado ao criar um ponto final da CDN.
DeepCreatedOriginGroup	O grupo de origem do conteúdo da CDN que é adicionado ao criar um ponto final da CDN. O tráfego é enviado para as origens no grupo de origem com base no estado de funcionamento da origem.
DeliveryPolicy	Uma política que especifica as regras de entrega a utilizar para um ponto final.
DeliveryRule	Uma regra que especifica um conjunto de ações e condições
DeliveryRuleCacheExpirationAction	Define a ação de expiração da cache para a regra de entrega.
DeliveryRuleCacheKeyQueryStringAction	Define a ação de cadeia de consulta de chave de cache para a regra de entrega.
DeliveryRuleClientPortCondition	Define a condição ClientPort para a regra de entrega.
DeliveryRuleCookiesCondition	Define a condição Cookies para a regra de entrega.
DeliveryRuleHostNameCondition	Define a condição HostName para a regra de entrega.
DeliveryRuleHttpVersionCondition	Define a condição HttpVersion para a regra de entrega.
DeliveryRuleIsDeviceCondition	Define a condição IsDevice para a regra de entrega.
DeliveryRulePostArgsCondition	Define a condição PostArgs para a regra de entrega.
DeliveryRuleQueryStringCondition	Define a condição QueryString para a regra de entrega.
DeliveryRuleRemoteAddressCondition	Define a condição RemoteAddress para a regra de entrega.
DeliveryRuleRequestBodyCondition	Define a condição RequestBody para a regra de entrega.
DeliveryRuleRequestHeaderAction	Define a ação de cabeçalho do pedido para a regra de entrega.
DeliveryRuleRequestHeaderCondition	Define a condição RequestHeader para a regra de entrega.
DeliveryRuleRequestMethodCondition	Define a condição RequestMethod para a regra de entrega.
DeliveryRuleRequestSchemeCondition	Define a condição RequestScheme para a regra de entrega.
DeliveryRuleRequestUriCondition	Define a condição RequestUri para a regra de entrega.
DeliveryRuleResponseHeaderAction	Define a ação de cabeçalho de resposta para a regra de entrega.
DeliveryRuleRouteConfigurationOverrideAction	Define a ação de substituição da configuração da rota para a regra de entrega. Apenas aplicável aos Perfis Standard/Premium do Frontdoor.
DeliveryRuleServerPortCondition	Define a condição ServerPort para a regra de entrega.
DeliveryRuleSocketAddrCondition	Define a condição SocketAddress para a regra de entrega.
DeliveryRuleSslProtocolCondition	Define a condição SslProtocol para a regra de entrega.
DeliveryRuleUrlFileExtensionCondition	Define a condição UrlFileExtension para a regra de entrega.
DeliveryRuleUrlFileNameCondition	Define a condição UrlFileName para a regra de entrega.
DeliveryRuleUrlPathCondition	Define a condição urlPath para a regra de entrega.
DestinationProtocol	Protocolo a utilizar para o redirecionamento. O valor predefinido é MatchRequest
Endpoint	O ponto final da CDN é a entidade dentro de um perfil da CDN que contém informações de configuração como origem, protocolo, colocação em cache de conteúdos e comportamento de entrega. O ponto final da CDN utiliza o formato de URL .azureedge.net.
EndpointProvisioningState	Estado de aprovisionamento do ponto final.
EndpointResourceState	Estado do recurso do ponto final.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ForwardingProtocol	Protocolo que esta regra utilizará ao reencaminhar tráfego para back-ends.
GeoFilter	Regras que definem o acesso geográfico do utilizador num ponto final da CDN.
GeoFilterActions	Ação do filtro geográfico, ou seja, permitir ou bloquear o acesso.
HeaderAction	Ação a executar
HeaderActionParameters	Define os parâmetros da ação de cabeçalho do pedido.
HealthProbeParameters	O objeto JSON que contém as propriedades para enviar sondas de estado de funcionamento para a origem.
HealthProbeRequestType	O tipo de pedido de sonda de estado de funcionamento que é efetuado.
HostNameMatchConditionParameters	Define os parâmetros para condições de correspondência hostName
HostNameOperator	Descreve o operador a ser correspondido
HttpErrorRangeParameters	O objeto JSON que representa o intervalo de códigos de estado http
HttpVersionMatchConditionParameters	Define os parâmetros para condições de correspondência httpVersion
HttpVersionOperator	Descreve o operador a ser correspondido
IdentityType	O tipo de identidade que cria/modifica recursos
IsDeviceMatchConditionParameters	Define os parâmetros para as condições de correspondência de IsDevice
IsDeviceOperator	Descreve o operador a ser correspondido
KeyVaultSigningKeyParameters	Descreve os parâmetros para utilizar o KeyVault de um utilizador para a Chave de Assinatura de URL.
MatchValues	O valor de correspondência para a condição da regra de entrega
OptimizationType	Especifica o cenário em que o cliente pretende que este ponto final da CDN otimize, por exemplo, Transferir serviços de Multimédia. Com estas informações, podemos aplicar a otimização orientada por cenários.
OriginGroupOverride	Define os parâmetros para a configuração de substituição do grupo de origem.
OriginGroupOverrideAction	Define a ação de substituição do grupo de origem para a regra de entrega.
OriginGroupOverrideActionParameters	Define os parâmetros para a ação de substituição do grupo de origem.
paramIndicator	Indica o objetivo do parâmetro
PostArgsMatchConditionParameters	Define os parâmetros para condições de correspondência postArgs
PostArgsOperator	Descreve o operador a ser correspondido
PrivateEndpointStatus	O estado de aprovação da ligação à Private Link
ProbeProtocol	Protocolo a utilizar para a sonda de estado de funcionamento.
queryStringBehavior	Comportamento de colocação em cache dos pedidos
QueryStringCachingBehavior	Define como a CDN coloca em cache pedidos que incluem cadeias de consulta. Pode ignorar quaisquer cadeias de consulta ao colocar em cache, ignorar a colocação em cache para impedir que os pedidos que contêm cadeias de consulta sejam colocados em cache ou colocar em cache todos os pedidos com um URL exclusivo.
QueryStringMatchConditionParameters	Define os parâmetros para as condições de correspondência do QueryString
QueryStringOperator	Descreve o operador a ser correspondido
RedirectType	O tipo de redirecionamento que a regra utilizará ao redirecionar o tráfego.
RemoteAddressMatchConditionParameters	Define os parâmetros para as condições de correspondência remoteAddress
RemoteAddressOperator	Descreve o operador a ser correspondido
RequestBodyMatchConditionParameters	Define os parâmetros das condições de correspondência requestBody
RequestBodyOperator	Descreve o operador a ser correspondido
RequestHeaderMatchConditionParameters	Define os parâmetros das condições de correspondência do RequestHeader
RequestHeaderOperator	Descreve o operador a ser correspondido
RequestMethodMatchConditionParameters	Define os parâmetros das condições de correspondência RequestMethod
RequestMethodOperator	Descreve o operador a ser correspondido
RequestSchemeMatchConditionParameters	Define os parâmetros das condições de correspondência RequestScheme
RequestUriMatchConditionParameters	Define os parâmetros das condições de correspondência requestUri
RequestUriOperator	Descreve o operador a ser correspondido
ResourceReference	Referência a outro recurso.
ResponseBasedDetectedErrorTypes	Tipo de erros de resposta para pedidos de utilizador reais para os quais a origem será considerada em mau estado de funcionamento
ResponseBasedOriginErrorDetectionParameters	O objeto JSON que contém as propriedades para determinar o estado de funcionamento da origem com pedidos/respostas reais.
RouteConfigurationOverrideActionParameters	Define os parâmetros para a ação de substituição da configuração da rota.
ruleCacheBehavior	Comportamento de colocação em cache dos pedidos
ruleIsCompressionEnabled	Indica se a compressão de conteúdo está ativada. Se a compressão estiver ativada, o conteúdo será servido como comprimido se o utilizador pedir uma versão comprimida. O conteúdo não será comprimido no AzureFrontDoor quando o conteúdo pedido for inferior a 1 byte ou superior a 1 MB.
ruleQueryStringCachingBehavior	Define como o Frontdoor coloca em cache pedidos que incluem cadeias de consulta. Pode ignorar quaisquer cadeias de consulta ao colocar em cache, ignorar cadeias de consulta específicas, colocar em cache todos os pedidos com um URL exclusivo ou colocar cadeias de consulta específicas em cache.
ServerPortMatchConditionParameters	Define os parâmetros para condições de correspondência serverPort
ServerPortOperator	Descreve o operador a ser correspondido
SocketAddrMatchConditionParameters	Define os parâmetros para as condições de correspondência de SocketAddress
SocketAddrOperator	Descreve o operador a ser correspondido
SslProtocol	O protocolo de uma ligação TLS estabelecida.
SslProtocolMatchConditionParameters	Define os parâmetros para condições de correspondência SslProtocol
SslProtocolOperator	Descreve o operador a ser correspondido
SystemData	Dados do sistema só de leitura
transform	Descreve que transformações são aplicadas antes da correspondência
UrlFileExtensionMatchConditionParameters	Define os parâmetros para as condições de correspondência UrlFileExtension
UrlFileExtensionOperator	Descreve o operador a ser correspondido
UrlFileNameMatchConditionParameters	Define os parâmetros para as condições de correspondência urlFilename
UrlFileNameOperator	Descreve o operador a ser correspondido
UrlPathMatchConditionParameters	Define os parâmetros para as condições de correspondência do UrlPath
UrlPathOperator	Descreve o operador a ser correspondido
UrlRedirectAction	Define a ação de redirecionamento de URL para a regra de entrega.
UrlRedirectActionParameters	Define os parâmetros para a ação de redirecionamento do URL.
UrlRewriteAction	Define a ação de reescrita de URL para a regra de entrega.
UrlRewriteActionParameters	Define os parâmetros para a ação de reescrita de URL.
UrlSigningAction	Define a ação de assinatura de URL para a regra de entrega.
UrlSigningActionParameters	Define os parâmetros para a ação Assinatura de URL.
UrlSigningKey	Chave de assinatura de URL
UrlSigningParamIdentifier	Define como identificar um parâmetro para uma finalidade específica, por exemplo, expira
WebApplicationFirewallPolicyLink	Define a política de Firewall de Aplicações Web para o ponto final (se aplicável)

algorithm

Algoritmo a utilizar para assinatura de URL

Name	Tipo	Description
SHA256	string

cacheBehavior

Comportamento de colocação em cache dos pedidos

Name	Tipo	Description
BypassCache	string
Override	string
SetIfMissing	string

CacheConfiguration

Definições de colocação em cache de uma rota do tipo colocação em cache. Para desativar a colocação em cache, não forneça um objeto cacheConfiguration.

Name	Tipo	Description
cacheBehavior	ruleCacheBehavior	Comportamento de colocação em cache dos pedidos
cacheDuration	string	A duração para a qual o conteúdo tem de ser colocado em cache. O formato permitido é [d.]hh:mm:ss
isCompressionEnabled	ruleIsCompressionEnabled	Indica se a compressão de conteúdo está ativada. Se a compressão estiver ativada, o conteúdo será servido como comprimido se o utilizador pedir uma versão comprimida. O conteúdo não será comprimido no AzureFrontDoor quando o conteúdo pedido for inferior a 1 byte ou superior a 1 MB.
queryParameters	string	parâmetros de consulta a incluir ou excluir (separados por vírgulas).
queryStringCachingBehavior	ruleQueryStringCachingBehavior	Define como o Frontdoor coloca em cache pedidos que incluem cadeias de consulta. Pode ignorar quaisquer cadeias de consulta ao colocar em cache, ignorar cadeias de consulta específicas, colocar em cache todos os pedidos com um URL exclusivo ou colocar cadeias de consulta específicas em cache.

CacheExpirationActionParameters

Define os parâmetros para a ação de expiração da cache.

Name	Tipo	Description
cacheBehavior	cacheBehavior	Comportamento de colocação em cache dos pedidos
cacheDuration	string	A duração para a qual o conteúdo tem de ser colocado em cache. O formato permitido é [d.]hh:mm:ss
cacheType	CacheType	O nível no qual o conteúdo tem de ser colocado em cache.
typeName	enum: DeliveryRuleCacheExpirationActionParameters

CacheKeyQueryStringActionParameters

Define os parâmetros para a ação da cadeia de consulta da chave de cache.

Name	Tipo	Description
queryParameters	string	parâmetros de consulta a incluir ou excluir (separados por vírgulas).
queryStringBehavior	queryStringBehavior	Comportamento de colocação em cache dos pedidos
typeName	enum: DeliveryRuleCacheKeyQueryStringBehaviorActionParameters

CacheType

O nível no qual o conteúdo tem de ser colocado em cache.

Name	Tipo	Description
All	string

ClientPortMatchConditionParameters

Define os parâmetros para condições de correspondência clientPort

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta é ou não uma condição negada
operator	ClientPortOperator		Descreve o operador a ser correspondido
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleClientPortConditionParameters

ClientPortOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

CookiesMatchConditionParameters

Define os parâmetros para as condições de correspondência de Cookies

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta é ou não uma condição negada
operator	CookiesOperator		Descreve o operador a ser correspondido
selector	string		Nome dos Cookies a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleCookiesConditionParameters

CookiesOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

DeepCreatedCustomDomain

Domínios personalizados criados no ponto final da CDN.

Name	Tipo	Description
name	string	Nome de domínio personalizado.
properties.hostName	string	O nome do anfitrião do domínio personalizado. Tem de ser um nome de domínio.
properties.validationData	string	Pode ser necessária uma validação ou dados especiais ao entregar a CDN a algumas regiões devido a motivos de conformidade local. Por exemplo, é necessário o número de licença ICP de um domínio personalizado para fornecer conteúdo na China.

DeepCreatedOrigin

A origem principal do conteúdo da CDN que é adicionado ao criar um ponto final da CDN.

Name	Tipo	Description
name	string	Nome de origem que tem de ser exclusivo no ponto final.
properties.enabled	boolean	A origem está ativada para balanceamento de carga ou não. Por predefinição, a origem está sempre ativada.
properties.hostName	string	O endereço da origem. Pode ser um nome de domínio, endereço IPv4 ou endereço IPv6. Isto deve ser exclusivo em todas as origens num ponto final.
properties.httpPort	integer	O valor da porta HTTP. Tem de estar entre 1 e 65535.
properties.httpsPort	integer	O valor da porta HTTPS. Tem de estar entre 1 e 65535.
properties.originHostHeader	string	O valor do cabeçalho do anfitrião enviado para a origem com cada pedido. Se deixar este valor em branco, o nome do anfitrião do pedido determina este valor. As origens da CDN do Azure, como Aplicações Web, Armazenamento de Blobs e Serviços Cloud exigem que este valor de cabeçalho do anfitrião corresponda ao nome do anfitrião de origem por predefinição.
properties.priority	integer	Prioridade da origem num determinado grupo de origem para balanceamento de carga. As prioridades mais elevadas não serão utilizadas para balanceamento de carga se qualquer origem de prioridade inferior estiver em bom estado de funcionamento. Tem de estar entre 1 e 5.
properties.privateEndpointStatus	PrivateEndpointStatus	O estado de aprovação da ligação à Private Link
properties.privateLinkAlias	string	O Alias do recurso Private Link. Preencher este campo opcional indica que esta origem é "Privada"
properties.privateLinkApprovalMessage	string	Uma mensagem personalizada a ser incluída no pedido de aprovação para ligar ao Private Link.
properties.privateLinkLocation	string	A localização do recurso Private Link. Necessário apenas se "privateLinkResourceId" for preenchido
properties.privateLinkResourceId	string	O ID do Recurso do recurso Private Link. Preencher este campo opcional indica que este back-end é "Privado"
properties.weight	integer	Peso da origem num determinado grupo de origem para balanceamento de carga. Tem de estar entre 1 e 1000

DeepCreatedOriginGroup

O grupo de origem do conteúdo da CDN que é adicionado ao criar um ponto final da CDN. O tráfego é enviado para as origens no grupo de origem com base no estado de funcionamento da origem.

Name	Tipo	Description
name	string	Nome do grupo de origem que tem de ser exclusivo no ponto final.
properties.healthProbeSettings	HealthProbeParameters	Definições da pesquisa de estado de funcionamento para a origem utilizada para determinar o estado de funcionamento da origem.
properties.origins	ResourceReference[]	A origem do conteúdo que está a ser entregue através da CDN dentro de um determinado grupo de origem.
properties.responseBasedOriginErrorDetectionSettings	ResponseBasedOriginErrorDetectionParameters	O objeto JSON que contém as propriedades para determinar o estado de funcionamento da origem com pedidos/respostas reais. Esta propriedade não é atualmente suportada.
properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes	integer	Tempo em minutos para mudar o tráfego para o ponto final gradualmente quando um ponto final em mau estado de funcionamento está em bom estado de funcionamento ou é adicionado um novo ponto final. A predefinição é de 10 minutos. Esta propriedade não é atualmente suportada.

DeliveryPolicy

Uma política que especifica as regras de entrega a utilizar para um ponto final.

Name	Tipo	Description
description	string	Descrição amigável do utilizador da política.
rules	DeliveryRule[]	Uma lista das regras de entrega.

DeliveryRule

Uma regra que especifica um conjunto de ações e condições

Name	Tipo	Description
actions	DeliveryRuleAction[]: DeliveryRuleCacheExpirationAction[] DeliveryRuleCacheKeyQueryStringAction[] DeliveryRuleRequestHeaderAction[] DeliveryRuleResponseHeaderAction[] DeliveryRuleRouteConfigurationOverrideAction[] OriginGroupOverrideAction[] UrlRedirectAction[] UrlRewriteAction[] UrlSigningAction[]	Uma lista de ações que são executadas quando todas as condições de uma regra são satisfeitas.
conditions	DeliveryRuleCondition[]: DeliveryRuleClientPortCondition[] DeliveryRuleCookiesCondition[] DeliveryRuleHostNameCondition[] DeliveryRuleHttpVersionCondition[] DeliveryRuleIsDeviceCondition[] DeliveryRulePostArgsCondition[] DeliveryRuleQueryStringCondition[] DeliveryRuleRemoteAddressCondition[] DeliveryRuleRequestBodyCondition[] DeliveryRuleRequestHeaderCondition[] DeliveryRuleRequestMethodCondition[] DeliveryRuleRequestSchemeCondition[] DeliveryRuleRequestUriCondition[] DeliveryRuleServerPortCondition[] DeliveryRuleSocketAddrCondition[] DeliveryRuleSslProtocolCondition[] DeliveryRuleUrlFileExtensionCondition[] DeliveryRuleUrlFileNameCondition[] DeliveryRuleUrlPathCondition[]	Uma lista de condições que têm de ser correspondidas para que as ações sejam executadas
name	string	Nome da regra
order	integer	A ordem pela qual as regras são aplicadas para o ponto final. Valores possíveis {0,1,2,3,.........}. Será aplicada uma regra com uma ordem menor antes de uma regra com uma ordem maior. A regra com a ordem 0 é uma regra especial. Não requer nenhuma condição e as ações listadas na mesma serão sempre aplicadas.

DeliveryRuleCacheExpirationAction

Define a ação de expiração da cache para a regra de entrega.

Name	Tipo	Description
name	string: CacheExpiration	O nome da ação para a regra de entrega.
parameters	CacheExpirationActionParameters	Define os parâmetros da ação.

DeliveryRuleCacheKeyQueryStringAction

Define a ação de cadeia de consulta de chave de cache para a regra de entrega.

Name	Tipo	Description
name	string: CacheKeyQueryString	O nome da ação para a regra de entrega.
parameters	CacheKeyQueryStringActionParameters	Define os parâmetros da ação.

DeliveryRuleClientPortCondition

Define a condição ClientPort para a regra de entrega.

Name	Tipo	Description
name	string: ClientPort	O nome da condição para a regra de entrega.
parameters	ClientPortMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleCookiesCondition

Define a condição Cookies para a regra de entrega.

Name	Tipo	Description
name	string: Cookies	O nome da condição para a regra de entrega.
parameters	CookiesMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleHostNameCondition

Define a condição HostName para a regra de entrega.

Name	Tipo	Description
name	string: HostName	O nome da condição para a regra de entrega.
parameters	HostNameMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleHttpVersionCondition

Define a condição HttpVersion para a regra de entrega.

Name	Tipo	Description
name	string: HttpVersion	O nome da condição para a regra de entrega.
parameters	HttpVersionMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleIsDeviceCondition

Define a condição IsDevice para a regra de entrega.

Name	Tipo	Description
name	string: IsDevice	O nome da condição para a regra de entrega.
parameters	IsDeviceMatchConditionParameters	Define os parâmetros da condição.

DeliveryRulePostArgsCondition

Define a condição PostArgs para a regra de entrega.

Name	Tipo	Description
name	string: PostArgs	O nome da condição para a regra de entrega.
parameters	PostArgsMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleQueryStringCondition

Define a condição QueryString para a regra de entrega.

Name	Tipo	Description
name	string: QueryString	O nome da condição para a regra de entrega.
parameters	QueryStringMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleRemoteAddressCondition

Define a condição RemoteAddress para a regra de entrega.

Name	Tipo	Description
name	string: RemoteAddress	O nome da condição para a regra de entrega.
parameters	RemoteAddressMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleRequestBodyCondition

Define a condição RequestBody para a regra de entrega.

Name	Tipo	Description
name	string: RequestBody	O nome da condição para a regra de entrega.
parameters	RequestBodyMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleRequestHeaderAction

Define a ação de cabeçalho do pedido para a regra de entrega.

Name	Tipo	Description
name	string: ModifyRequestHeader	O nome da ação para a regra de entrega.
parameters	HeaderActionParameters	Define os parâmetros da ação.

DeliveryRuleRequestHeaderCondition

Define a condição RequestHeader para a regra de entrega.

Name	Tipo	Description
name	string: RequestHeader	O nome da condição para a regra de entrega.
parameters	RequestHeaderMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleRequestMethodCondition

Define a condição RequestMethod para a regra de entrega.

Name	Tipo	Description
name	string: RequestMethod	O nome da condição para a regra de entrega.
parameters	RequestMethodMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleRequestSchemeCondition

Define a condição RequestScheme para a regra de entrega.

Name	Tipo	Description
name	string: RequestScheme	O nome da condição para a regra de entrega.
parameters	RequestSchemeMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleRequestUriCondition

Define a condição RequestUri para a regra de entrega.

Name	Tipo	Description
name	string: RequestUri	O nome da condição para a regra de entrega.
parameters	RequestUriMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleResponseHeaderAction

Define a ação de cabeçalho de resposta para a regra de entrega.

Name	Tipo	Description
name	string: ModifyResponseHeader	O nome da ação para a regra de entrega.
parameters	HeaderActionParameters	Define os parâmetros da ação.

DeliveryRuleRouteConfigurationOverrideAction

Define a ação de substituição da configuração da rota para a regra de entrega. Apenas aplicável aos Perfis Standard/Premium do Frontdoor.

Name	Tipo	Description
name	string: RouteConfigurationOverride	O nome da ação para a regra de entrega.
parameters	RouteConfigurationOverrideActionParameters	Define os parâmetros da ação.

DeliveryRuleServerPortCondition

Define a condição ServerPort para a regra de entrega.

Name	Tipo	Description
name	string: ServerPort	O nome da condição para a regra de entrega.
parameters	ServerPortMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleSocketAddrCondition

Define a condição SocketAddress para a regra de entrega.

Name	Tipo	Description
name	string: SocketAddr	O nome da condição para a regra de entrega.
parameters	SocketAddrMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleSslProtocolCondition

Define a condição SslProtocol para a regra de entrega.

Name	Tipo	Description
name	string: SslProtocol	O nome da condição para a regra de entrega.
parameters	SslProtocolMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleUrlFileExtensionCondition

Define a condição UrlFileExtension para a regra de entrega.

Name	Tipo	Description
name	string: UrlFileExtension	O nome da condição para a regra de entrega.
parameters	UrlFileExtensionMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleUrlFileNameCondition

Define a condição UrlFileName para a regra de entrega.

Name	Tipo	Description
name	string: UrlFileName	O nome da condição para a regra de entrega.
parameters	UrlFileNameMatchConditionParameters	Define os parâmetros da condição.

DeliveryRuleUrlPathCondition

Define a condição urlPath para a regra de entrega.

Name	Tipo	Description
name	string: UrlPath	O nome da condição para a regra de entrega.
parameters	UrlPathMatchConditionParameters	Define os parâmetros da condição.

DestinationProtocol

Protocolo a utilizar para o redirecionamento. O valor predefinido é MatchRequest

Name	Tipo	Description
Http	string
Https	string
MatchRequest	string

Endpoint

O ponto final da CDN é a entidade dentro de um perfil da CDN que contém informações de configuração como origem, protocolo, colocação em cache de conteúdos e comportamento de entrega. O ponto final da CDN utiliza o formato de URL .azureedge.net.

Name	Tipo	Default value	Description
id	string		ID do Recurso.
location	string		Localização do recurso.
name	string		Nome do recurso.
properties.contentTypesToCompress	string[]		Lista de tipos de conteúdo nos quais a compressão se aplica. O valor deve ser um tipo de MIME válido.
properties.customDomains	DeepCreatedCustomDomain[]		Os domínios personalizados no ponto final.
properties.defaultOriginGroup	ResourceReference		Uma referência ao grupo de origem.
properties.deliveryPolicy	DeliveryPolicy		Uma política que especifica as regras de entrega a utilizar para um ponto final.
properties.geoFilters	GeoFilter[]		Lista de regras que definem o acesso geográfico do utilizador num ponto final da CDN. Cada filtro geográfico define uma regra de acesso para um caminho ou conteúdo especificado, por exemplo, bloquear o APAC para o caminho /imagens/
properties.hostName	string		O nome do anfitrião do ponto final estruturado como {endpointName}. {DNSZone}, por exemplo, contoso.azureedge.net
properties.isCompressionEnabled	boolean		Indica se a compressão de conteúdo está ativada na CDN. O valor predefinido é falso. Se a compressão estiver ativada, o conteúdo será servido como comprimido se o utilizador pedir uma versão comprimida. O conteúdo não será comprimido na CDN quando o conteúdo pedido for inferior a 1 byte ou superior a 1 MB.
properties.isHttpAllowed	boolean	True	Indica se o tráfego HTTP é permitido no ponto final. O valor predefinido é verdadeiro. Tem de ser permitido pelo menos um protocolo (HTTP ou HTTPS).
properties.isHttpsAllowed	boolean	True	Indica se o tráfego HTTPS é permitido no ponto final. O valor predefinido é verdadeiro. Tem de ser permitido pelo menos um protocolo (HTTP ou HTTPS).
properties.optimizationType	OptimizationType		Especifica o cenário para o qual o cliente quer otimizar este ponto final da CDN, por exemplo, Transferir serviços de Multimédia. Com estas informações, a CDN pode aplicar a otimização orientada por cenários.
properties.originGroups	DeepCreatedOriginGroup[]		Os grupos de origem que incluem origens que são utilizadas para balancear a carga do tráfego com base na disponibilidade.
properties.originHostHeader	string		O valor do cabeçalho do anfitrião enviado para a origem com cada pedido. Esta propriedade no Ponto Final só é permitida quando o ponto final utiliza uma origem única e pode ser substituída pela mesma propriedade especificada na origem. Se deixar este valor em branco, o nome do anfitrião do pedido determina este valor. As origens da CDN do Azure, como Aplicações Web, Armazenamento de Blobs e Serviços Cloud exigem que este valor de cabeçalho do anfitrião corresponda ao nome do anfitrião de origem por predefinição.
properties.originPath	string		Um caminho de diretório na origem que a CDN pode utilizar para obter conteúdo de, por exemplo, contoso.cloudapp.net/originpath.
properties.origins	DeepCreatedOrigin[]		A origem do conteúdo que está a ser entregue através da CDN.
properties.probePath	string		Caminho para um ficheiro alojado na origem que ajuda a acelerar a entrega do conteúdo dinâmico e a calcular as rotas mais ideais para a CDN. Isto é relativo ao caminho de origem. Esta propriedade só é relevante ao utilizar uma única origem.
properties.provisioningState	EndpointProvisioningState		Estado de aprovisionamento do ponto final.
properties.queryStringCachingBehavior	QueryStringCachingBehavior	NotSet	Define como a CDN coloca em cache pedidos que incluem cadeias de consulta. Pode ignorar quaisquer cadeias de consulta ao colocar em cache, ignorar a colocação em cache para impedir que os pedidos que contêm cadeias de consulta sejam colocados em cache ou colocar em cache todos os pedidos com um URL exclusivo.
properties.resourceState	EndpointResourceState		Estado do recurso do ponto final.
properties.urlSigningKeys	UrlSigningKey[]		Lista de chaves utilizadas para validar os hashes de URL assinados.
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink		Define a política de Firewall de Aplicações Web para o ponto final (se aplicável)
systemData	SystemData		Dados do sistema só de leitura
tags	object		Etiquetas de recursos.
type	string		Tipo de recurso.

EndpointProvisioningState

Estado de aprovisionamento do ponto final.

Name	Tipo	Description
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

EndpointResourceState

Estado do recurso do ponto final.

Name	Tipo	Description
Creating	string
Deleting	string
Running	string
Starting	string
Stopped	string
Stopping	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ForwardingProtocol

Protocolo que esta regra utilizará ao reencaminhar tráfego para back-ends.

Name	Tipo	Description
HttpOnly	string
HttpsOnly	string
MatchRequest	string

GeoFilter

Regras que definem o acesso geográfico do utilizador num ponto final da CDN.

Name	Tipo	Description
action	GeoFilterActions	Ação do filtro geográfico, ou seja, permitir ou bloquear o acesso.
countryCodes	string[]	Códigos de país ou região de duas letras que definem o acesso de país ou região do utilizador num filtro geográfico, por exemplo, AU, MX, E.U.A.
relativePath	string	Caminho relativo aplicável ao filtro geográfico. (por exemplo, "/mypictures", "/mypicture/kitty.jpg" e etc.)

GeoFilterActions

Ação do filtro geográfico, ou seja, permitir ou bloquear o acesso.

Name	Tipo	Description
Allow	string
Block	string

HeaderAction

Ação a executar

Name	Tipo	Description
Append	string
Delete	string
Overwrite	string

HeaderActionParameters

Define os parâmetros da ação de cabeçalho do pedido.

Name	Tipo	Description
headerAction	HeaderAction	Ação a executar
headerName	string	Nome do cabeçalho a modificar
typeName	enum: DeliveryRuleHeaderActionParameters
value	string	Valor da ação especificada

HealthProbeParameters

O objeto JSON que contém as propriedades para enviar sondas de estado de funcionamento para a origem.

Name	Tipo	Description
probeIntervalInSeconds	integer	O número de segundos entre as sondas de estado de funcionamento. A predefinição é 240sec.
probePath	string	O caminho relativo à origem utilizada para determinar o estado de funcionamento da origem.
probeProtocol	ProbeProtocol	Protocolo a utilizar para a sonda de estado de funcionamento.
probeRequestType	HealthProbeRequestType	O tipo de pedido de sonda de estado de funcionamento que é efetuado.

HealthProbeRequestType

O tipo de pedido de sonda de estado de funcionamento que é efetuado.

Name	Tipo	Description
GET	string
HEAD	string
NotSet	string

HostNameMatchConditionParameters

Define os parâmetros para condições de correspondência hostName

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta é ou não uma condição negada
operator	HostNameOperator		Descreve o operador a ser correspondido
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleHostNameConditionParameters

HostNameOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

HttpErrorRangeParameters

O objeto JSON que representa o intervalo de códigos de estado http

Name	Tipo	Description
begin	integer	O início inclusivo do intervalo de código de estado http.
end	integer	O fim inclusivo do intervalo de código de estado http.

HttpVersionMatchConditionParameters

Define os parâmetros para condições de correspondência httpVersion

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta é ou não uma condição negada
operator	HttpVersionOperator		Descreve o operador a ser correspondido
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleHttpVersionConditionParameters

HttpVersionOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Equal	string

IdentityType

O tipo de identidade que cria/modifica recursos

Name	Tipo	Description
application	string
key	string
managedIdentity	string
user	string

IsDeviceMatchConditionParameters

Define os parâmetros para as condições de correspondência de IsDevice

Name	Tipo	Default value	Description
matchValues	MatchValues[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta é ou não uma condição negada
operator	IsDeviceOperator		Descreve o operador a ser correspondido
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleIsDeviceConditionParameters

IsDeviceOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Equal	string

KeyVaultSigningKeyParameters

Descreve os parâmetros para utilizar o KeyVault de um utilizador para a Chave de Assinatura de URL.

Name	Tipo	Description
resourceGroupName	string	Grupo de recursos da Key Vault do utilizador que contém o segredo
secretName	string	O nome do segredo em Key Vault.
secretVersion	string	A versão (GUID) do segredo no Key Vault.
subscriptionId	string	ID da subscrição do Key Vault do utilizador que contém o segredo
typeName	enum: KeyVaultSigningKeyParameters
vaultName	string	O nome da Key Vault do utilizador que contém o segredo

MatchValues

O valor de correspondência para a condição da regra de entrega

Name	Tipo	Description
DELETE	string
GET	string
HEAD	string
OPTIONS	string
POST	string
PUT	string
TRACE	string

OptimizationType

Especifica o cenário em que o cliente pretende que este ponto final da CDN otimize, por exemplo, Transferir serviços de Multimédia. Com estas informações, podemos aplicar a otimização orientada por cenários.

Name	Tipo	Description
DynamicSiteAcceleration	string
GeneralMediaStreaming	string
GeneralWebDelivery	string
LargeFileDownload	string
VideoOnDemandMediaStreaming	string

OriginGroupOverride

Define os parâmetros para a configuração de substituição do grupo de origem.

Name	Tipo	Description
forwardingProtocol	ForwardingProtocol	Protocolo que esta regra utilizará ao reencaminhar tráfego para back-ends.
originGroup	ResourceReference	define o OriginGroup que substituiria DefaultOriginGroup na rota.

OriginGroupOverrideAction

Define a ação de substituição do grupo de origem para a regra de entrega.

Name	Tipo	Description
name	string: OriginGroupOverride	O nome da ação para a regra de entrega.
parameters	OriginGroupOverrideActionParameters	Define os parâmetros da ação.

OriginGroupOverrideActionParameters

Define os parâmetros para a ação de substituição do grupo de origem.

Name	Tipo	Description
originGroup	ResourceReference	define o OriginGroup que substituiria DefaultOriginGroup.
typeName	enum: DeliveryRuleOriginGroupOverrideActionParameters

paramIndicator

Indica o objetivo do parâmetro

Name	Tipo	Description
Expires	string
KeyId	string
Signature	string

PostArgsMatchConditionParameters

Define os parâmetros para condições de correspondência postArgs

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	PostArgsOperator		Descreve o operador a corresponder
selector	string		Nome do PostArg a ser correspondido
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRulePostArgsConditionParameters

PostArgsOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

PrivateEndpointStatus

O estado de aprovação da ligação à Private Link

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Timeout	string

ProbeProtocol

Protocolo a utilizar para a sonda de estado de funcionamento.

Name	Tipo	Description
Http	string
Https	string
NotSet	string

queryStringBehavior

Comportamento de colocação em cache dos pedidos

Name	Tipo	Description
Exclude	string
ExcludeAll	string
Include	string
IncludeAll	string

QueryStringCachingBehavior

Define como a CDN coloca em cache pedidos que incluem cadeias de consulta. Pode ignorar quaisquer cadeias de consulta ao colocar em cache, ignorar a colocação em cache para impedir que os pedidos que contêm cadeias de consulta sejam colocados em cache ou colocar em cache todos os pedidos com um URL exclusivo.

Name	Tipo	Description
BypassCaching	string
IgnoreQueryString	string
NotSet	string
UseQueryString	string

QueryStringMatchConditionParameters

Define os parâmetros para as condições de correspondência do QueryString

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	QueryStringOperator		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleQueryStringConditionParameters

QueryStringOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RedirectType

O tipo de redirecionamento que a regra utilizará ao redirecionar o tráfego.

Name	Tipo	Description
Found	string
Moved	string
PermanentRedirect	string
TemporaryRedirect	string

RemoteAddressMatchConditionParameters

Define os parâmetros para as condições de correspondência remoteAddress

Name	Tipo	Default value	Description
matchValues	string[]		Corresponda aos valores correspondentes. O operador aplicar-se-á a cada valor aqui com semântica OR. Se algum deles corresponder à variável com o operador especificado, esta condição de correspondência é considerada uma correspondência.
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	RemoteAddressOperator		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleRemoteAddressConditionParameters

RemoteAddressOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
GeoMatch	string
IPMatch	string

RequestBodyMatchConditionParameters

Define os parâmetros das condições de correspondência requestBody

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	RequestBodyOperator		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleRequestBodyConditionParameters

RequestBodyOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestHeaderMatchConditionParameters

Define os parâmetros das condições de correspondência do RequestHeader

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	RequestHeaderOperator		Descreve o operador a corresponder
selector	string		Nome do Cabeçalho a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleRequestHeaderConditionParameters

RequestHeaderOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

RequestMethodMatchConditionParameters

Define os parâmetros das condições de correspondência RequestMethod

Name	Tipo	Default value	Description
matchValues	MatchValues[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	RequestMethodOperator		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleRequestMethodConditionParameters

RequestMethodOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Equal	string

RequestSchemeMatchConditionParameters

Define os parâmetros das condições de correspondência RequestScheme

Name	Tipo	Default value	Description
matchValues	MatchValues[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	enum: Equal		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleRequestSchemeConditionParameters

RequestUriMatchConditionParameters

Define os parâmetros das condições de correspondência requestUri

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	RequestUriOperator		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleRequestUriConditionParameters

RequestUriOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

ResourceReference

Referência a outro recurso.

Name	Tipo	Description
id	string	ID do Recurso.

ResponseBasedDetectedErrorTypes

Tipo de erros de resposta para pedidos de utilizador reais para os quais a origem será considerada em mau estado de funcionamento

Name	Tipo	Description
None	string
TcpAndHttpErrors	string
TcpErrorsOnly	string

ResponseBasedOriginErrorDetectionParameters

O objeto JSON que contém as propriedades para determinar o estado de funcionamento da origem com pedidos/respostas reais.

Name	Tipo	Description
httpErrorRanges	HttpErrorRangeParameters[]	A lista de intervalos de código de estado http que são considerados erros do servidor para a origem e que estão marcados como em mau estado de funcionamento.
responseBasedDetectedErrorTypes	ResponseBasedDetectedErrorTypes	Tipo de erros de resposta para pedidos de utilizador reais para os quais a origem será considerada em mau estado de funcionamento
responseBasedFailoverThresholdPercentage	integer	A percentagem de pedidos falhados no exemplo em que a ativação pós-falha deve ser acionada.

RouteConfigurationOverrideActionParameters

Define os parâmetros para a ação de substituição da configuração da rota.

Name	Tipo	Description
cacheConfiguration	CacheConfiguration	A configuração de colocação em cache associada a esta regra. Para desativar a colocação em cache, não forneça um objeto cacheConfiguration.
originGroupOverride	OriginGroupOverride	Uma referência à configuração de substituição do grupo de origem. Deixe vazio para utilizar o grupo de origem predefinido na rota.
typeName	enum: DeliveryRuleRouteConfigurationOverrideActionParameters

ruleCacheBehavior

Comportamento de colocação em cache dos pedidos

Name	Tipo	Description
HonorOrigin	string
OverrideAlways	string
OverrideIfOriginMissing	string

ruleIsCompressionEnabled

Indica se a compressão de conteúdo está ativada. Se a compressão estiver ativada, o conteúdo será servido como comprimido se o utilizador pedir uma versão comprimida. O conteúdo não será comprimido no AzureFrontDoor quando o conteúdo pedido for inferior a 1 byte ou superior a 1 MB.

Name	Tipo	Description
Disabled	string
Enabled	string

ruleQueryStringCachingBehavior

Define como o Frontdoor coloca em cache pedidos que incluem cadeias de consulta. Pode ignorar quaisquer cadeias de consulta ao colocar em cache, ignorar cadeias de consulta específicas, colocar em cache todos os pedidos com um URL exclusivo ou colocar cadeias de consulta específicas em cache.

Name	Tipo	Description
IgnoreQueryString	string
IgnoreSpecifiedQueryStrings	string
IncludeSpecifiedQueryStrings	string
UseQueryString	string

ServerPortMatchConditionParameters

Define os parâmetros para condições de correspondência serverPort

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta é ou não uma condição negada
operator	ServerPortOperator		Descreve o operador a ser correspondido
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleServerPortConditionParameters

ServerPortOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

SocketAddrMatchConditionParameters

Define os parâmetros para as condições de correspondência de SocketAddress

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta é ou não uma condição negada
operator	SocketAddrOperator		Descreve o operador a ser correspondido
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleSocketAddrConditionParameters

SocketAddrOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
IPMatch	string

SslProtocol

O protocolo de uma ligação TLS estabelecida.

Name	Tipo	Description
TLSv1	string
TLSv1.1	string
TLSv1.2	string

SslProtocolMatchConditionParameters

Define os parâmetros para condições de correspondência SslProtocol

Name	Tipo	Default value	Description
matchValues	SslProtocol[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta é ou não uma condição negada
operator	SslProtocolOperator		Descreve o operador a ser correspondido
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleSslProtocolConditionParameters

SslProtocolOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Equal	string

SystemData

Dados do sistema só de leitura

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC)
createdBy	string	Um identificador para a identidade que criou o recurso
createdByType	IdentityType	O tipo de identidade que criou o recurso
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	Um identificador para a identidade que modificou o recurso pela última vez
lastModifiedByType	IdentityType	O tipo de identidade que modificou o recurso pela última vez

transform

Descreve que transformações são aplicadas antes da correspondência

Name	Tipo	Description
Lowercase	string
RemoveNulls	string
Trim	string
Uppercase	string
UrlDecode	string
UrlEncode	string

UrlFileExtensionMatchConditionParameters

Define os parâmetros para as condições de correspondência UrlFileExtension

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	UrlFileExtensionOperator		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleUrlFileExtensionMatchConditionParameters

UrlFileExtensionOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

UrlFileNameMatchConditionParameters

Define os parâmetros para as condições de correspondência urlFilename

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	UrlFileNameOperator		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleUrlFilenameConditionParameters

UrlFileNameOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string

UrlPathMatchConditionParameters

Define os parâmetros para as condições de correspondência do UrlPath

Name	Tipo	Default value	Description
matchValues	string[]		O valor de correspondência para a condição da regra de entrega
negateCondition	boolean	False	Descreve se esta condição é ou não negada
operator	UrlPathOperator		Descreve o operador a corresponder
transforms	transform[]		Lista de transformações
typeName	enum: DeliveryRuleUrlPathMatchConditionParameters

UrlPathOperator

Descreve o operador a ser correspondido

Name	Tipo	Description
Any	string
BeginsWith	string
Contains	string
EndsWith	string
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string
RegEx	string
Wildcard	string

UrlRedirectAction

Define a ação de redirecionamento de URL para a regra de entrega.

Name	Tipo	Description
name	string: UrlRedirect	O nome da ação para a regra de entrega.
parameters	UrlRedirectActionParameters	Define os parâmetros da ação.

UrlRedirectActionParameters

Define os parâmetros para a ação de redirecionamento do URL.

Name	Tipo	Description
customFragment	string	Fragmento para adicionar ao URL de redirecionamento. Fragmento é a parte do URL que vem depois de #. Não inclua o #.
customHostname	string	Anfitrião a redirecionar. Deixe vazio para utilizar o anfitrião de entrada como anfitrião de destino.
customPath	string	O caminho completo para redirecionar. O caminho não pode estar vazio e tem de começar por /. Deixe vazio para utilizar o caminho de entrada como caminho de destino.
customQueryString	string	O conjunto de cadeias de consulta a colocar no URL de redirecionamento. Definir este valor substituiria qualquer cadeia de consulta existente; deixe em branco para preservar a cadeia de consulta de entrada. A cadeia de consulta tem de estar no formato = . ? e & serão adicionadas automaticamente, pelo que não as inclua.
destinationProtocol	DestinationProtocol	Protocolo a utilizar para o redirecionamento. O valor predefinido é MatchRequest
redirectType	RedirectType	O tipo de redirecionamento que a regra utilizará ao redirecionar o tráfego.
typeName	enum: DeliveryRuleUrlRedirectActionParameters

UrlRewriteAction

Define a ação de reescrita de URL para a regra de entrega.

Name	Tipo	Description
name	string: UrlRewrite	O nome da ação para a regra de entrega.
parameters	UrlRewriteActionParameters	Define os parâmetros da ação.

UrlRewriteActionParameters

Define os parâmetros para a ação de reescrita de URL.

Name	Tipo	Description
destination	string	Defina o URL relativo pelo qual os pedidos acima serão reescritos.
preserveUnmatchedPath	boolean	Se pretende preservar um caminho sem correspondência. O valor predefinido é verdadeiro.
sourcePattern	string	definir um padrão de URI de pedido que identifique o tipo de pedidos que podem ser reescritos. Se o valor estiver em branco, todas as cadeias são correspondidas.
typeName	enum: DeliveryRuleUrlRewriteActionParameters

UrlSigningAction

Define a ação de assinatura de URL para a regra de entrega.

Name	Tipo	Description
name	string: UrlSigning	O nome da ação para a regra de entrega.
parameters	UrlSigningActionParameters	Define os parâmetros da ação.

UrlSigningActionParameters

Define os parâmetros para a ação Assinatura de URL.

Name	Tipo	Description
algorithm	algorithm	Algoritmo a utilizar para assinatura de URL
parameterNameOverride	UrlSigningParamIdentifier[]	Define os parâmetros da cadeia de consulta no URL a considerar para expirações, id de chave, etc.
typeName	enum: DeliveryRuleUrlSigningActionParameters

UrlSigningKey

Chave de assinatura de URL

Name	Tipo	Description
keyId	string	Define o ID da chave definida pelo cliente. Esta identificação existirá no pedido de entrada para indicar a chave utilizada para formar o hash.
keySourceParameters	KeyVaultSigningKeyParameters	Define os parâmetros para utilizar o cofre de chaves do cliente para a Chave de Assinatura de URL.

UrlSigningParamIdentifier

Define como identificar um parâmetro para uma finalidade específica, por exemplo, expira

Name	Tipo	Description
paramIndicator	paramIndicator	Indica o objetivo do parâmetro
paramName	string	Nome do parâmetro

WebApplicationFirewallPolicyLink

Define a política de Firewall de Aplicações Web para o ponto final (se aplicável)

Name	Tipo	Description
id	string	ID do Recurso.

Partilhar via

Endpoints - Stop

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Endpoints_Stop

Pedido de amostra

Resposta da amostra

Definições

algorithm

cacheBehavior

CacheConfiguration

CacheExpirationActionParameters

CacheKeyQueryStringActionParameters

CacheType

ClientPortMatchConditionParameters

ClientPortOperator

CookiesMatchConditionParameters

CookiesOperator

DeepCreatedCustomDomain

DeepCreatedOrigin

DeepCreatedOriginGroup

DeliveryPolicy

DeliveryRule

DeliveryRuleCacheExpirationAction

DeliveryRuleCacheKeyQueryStringAction

DeliveryRuleClientPortCondition

DeliveryRuleCookiesCondition

DeliveryRuleHostNameCondition

DeliveryRuleHttpVersionCondition

DeliveryRuleIsDeviceCondition

DeliveryRulePostArgsCondition

DeliveryRuleQueryStringCondition

DeliveryRuleRemoteAddressCondition

DeliveryRuleRequestBodyCondition

DeliveryRuleRequestHeaderAction

DeliveryRuleRequestHeaderCondition

DeliveryRuleRequestMethodCondition

DeliveryRuleRequestSchemeCondition

DeliveryRuleRequestUriCondition

DeliveryRuleResponseHeaderAction

DeliveryRuleRouteConfigurationOverrideAction

DeliveryRuleServerPortCondition

DeliveryRuleSocketAddrCondition

DeliveryRuleSslProtocolCondition

DeliveryRuleUrlFileExtensionCondition

DeliveryRuleUrlFileNameCondition

DeliveryRuleUrlPathCondition

DestinationProtocol

Endpoint

EndpointProvisioningState

EndpointResourceState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

GeoFilter

GeoFilterActions

HeaderAction

HeaderActionParameters

HealthProbeParameters

HealthProbeRequestType

HostNameMatchConditionParameters

HostNameOperator

HttpErrorRangeParameters

HttpVersionMatchConditionParameters

HttpVersionOperator

IdentityType

IsDeviceMatchConditionParameters

IsDeviceOperator

KeyVaultSigningKeyParameters

MatchValues

OptimizationType

OriginGroupOverride

OriginGroupOverrideAction

OriginGroupOverrideActionParameters

paramIndicator