Validate Probe - Validate Probe

Service:

CDN

API Version:

2024-02-01

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.

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

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2024-02-01.

Request Body

Name	Required	Type	Description
probeURL	True	string	The probe URL to validate.

Responses

Name	Type	Description
200 OK	ValidateProbeOutput	OK. The request has succeeded.
Other Status Codes	ErrorResponse	CDN error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

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
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ValidateProbeInput	Input of the validate probe API.
ValidateProbeOutput	Output of the validate probe API.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ValidateProbeInput

Input of the validate probe API.

Name	Type	Description
probeURL	string	The probe URL to validate.

ValidateProbeOutput

Output of the validate probe API.

Name	Type	Description
errorCode	string	Specifies the error code when the probe url is not accepted.
isValid	boolean	Indicates whether the probe URL is accepted or not.
message	string	The detailed error message describing why the probe URL is not accepted.