Validate Probe - Validate Probe

Referência

Service:: CDN

API Version:: 2023-05-01

Verifique se o caminho da investigação é um caminho válido e se o arquivo pode ser acessado. O caminho de investigação é o caminho para um arquivo hospedado no servidor de origem para ajudar a acelerar a entrega de conteúdo dinâmico por meio do ponto de extremidade da CDN. Esse caminho é relativo ao caminho de origem especificado na configuração do ponto de extremidade.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe?api-version=2023-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	ID de assinatura do Azure.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2023-05-01.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
probeURL	True	string	A URL de investigação a ser validada.

Respostas

Nome	Tipo	Description
200 OK	ValidateProbeOutput	OK. A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Resposta de erro da CDN que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ValidateProbe

Sample Request

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Cdn/validateProbe?api-version=2023-05-01

{
  "probeURL": "https://www.bing.com/image"
}

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python validate_probe.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.validate_probe(
        validate_probe_input={"probeURL": "https://www.bing.com/image"},
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/ValidateProbe.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/azcore/to"
	"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/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/ValidateProbe.json
func ExampleManagementClient_ValidateProbe() {
	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)
	}
	res, err := clientFactory.NewManagementClient().ValidateProbe(ctx, armcdn.ValidateProbeInput{
		ProbeURL: to.Ptr("https://www.bing.com/image"),
	}, 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.ValidateProbeOutput = armcdn.ValidateProbeOutput{
	// 	ErrorCode: to.Ptr("None"),
	// 	IsValid: to.Ptr(true),
	// }
}

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 Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.
 *
 * @summary Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/ValidateProbe.json
 */
async function validateProbe() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const validateProbeInput = {
    probeURL: "https://www.bing.com/image",
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.validateProbe(validateProbeInput);
  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

Sample Response

Status code:: 200

{
  "isValid": true,
  "errorCode": "None",
  "message": null
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ValidateProbeInput	Entrada da API de investigação de validação.
ValidateProbeOutput	Saída da API de investigação de validação.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	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 de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ValidateProbeInput

Entrada da API de investigação de validação.

Nome	Tipo	Description
probeURL	string	A URL de investigação a ser validada.

ValidateProbeOutput

Saída da API de investigação de validação.

Nome	Tipo	Description
errorCode	string	Especifica o código de erro quando a URL de investigação não é aceita.
isValid	boolean	Indica se a URL da investigação é aceita ou não.
message	string	A mensagem de erro detalhada que descreve por que a URL da investigação não é aceita.

Validate Probe - Validate Probe

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Scopes

Exemplos

ValidateProbe

Sample Request

Sample Response

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ValidateProbeInput

ValidateProbeOutput

Recursos adicionais