Validate Probe - Validate Probe

Service:

CDN

API Version:

2024-02-01

Kontrollera om sökvägen för avsökningen är en giltig sökväg och att filen kan nås. Avsökningssökvägen är sökvägen till en fil som finns på ursprungsservern för att påskynda leveransen av dynamiskt innehåll via CDN-slutpunkten. Den här sökvägen är relativ till den ursprungssökväg som anges i slutpunktskonfigurationen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Azure-prenumerations-ID.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2024-02-01.

Begärandetext

Name	Obligatorisk	Typ	Description
probeURL	True	string	Avsöknings-URL:en som ska verifieras.

Svar

Name	Typ	Description
200 OK	ValidateProbeOutput	OK. Begäran har slutförts.
Other Status Codes	ErrorResponse	CDN-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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
}

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ValidateProbeInput	Indata för api:et för verifieringsavsökning.
ValidateProbeOutput	Utdata från API:et för verifieringsavsökning.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ValidateProbeInput

Indata för api:et för verifieringsavsökning.

Name	Typ	Description
probeURL	string	Avsöknings-URL:en som ska verifieras.

ValidateProbeOutput

Utdata från API:et för verifieringsavsökning.

Name	Typ	Description
errorCode	string	Anger felkoden när avsöknings-URL:en inte godkänns.
isValid	boolean	Anger om avsöknings-URL:en accepteras eller inte.
message	string	Det detaljerade felmeddelandet som beskriver varför avsökningens URL inte accepteras.