Validate Probe - Validate Probe

Service:

CDN

API Version:

2024-02-01

Compruebe si la ruta de acceso del sondeo es una ruta de acceso válida y se puede acceder al archivo. La ruta de acceso de sondeo es la ruta de acceso a un archivo hospedado en el servidor de origen para ayudar a acelerar la entrega de contenido dinámico a través del punto de conexión de CDN. Esta ruta de acceso es relativa a la ruta de acceso de origen especificada en la configuración del punto de conexión.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de suscripción de Azure
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente. La versión actual es 2024-02-01.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
probeURL	True	string	Dirección URL de sondeo que se va a validar.

Respuestas

Nombre	Tipo	Description
200 OK	ValidateProbeOutput	Aceptar. La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Respuesta de error de la red CDN que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ValidateProbe

Sample Request

HTTP

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

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

Go

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/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-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

JavaScript

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/2024-02-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
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ValidateProbeInput	Entrada de la API de sondeo de validación.
ValidateProbeOutput	Salida de la API de sondeo de validación.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ValidateProbeInput

Entrada de la API de sondeo de validación.

Nombre	Tipo	Description
probeURL	string	Dirección URL de sondeo que se va a validar.

ValidateProbeOutput

Salida de la API de sondeo de validación.

Nombre	Tipo	Description
errorCode	string	Especifica el código de error cuando no se acepta la dirección URL del sondeo.
isValid	boolean	Indica si se acepta o no la dirección URL del sondeo.
message	string	Mensaje de error detallado que describe por qué no se acepta la dirección URL del sondeo.