CdnManagementClient class

Extends

Constructors

CdnManagementClient(TokenCredential, CdnManagementClientOptionalParams)
CdnManagementClient(TokenCredential, string, CdnManagementClientOptionalParams)

Initializes a new instance of the CdnManagementClient class.

Properties

$host
afdCustomDomains
afdEndpoints
afdOriginGroups
afdOrigins
afdProfiles
apiVersion
customDomains
edgeNodes
endpoints
logAnalytics
managedRuleSets
operations
originGroups
origins
policies
profiles
resourceUsageOperations
routes
rules
ruleSets
secrets
securityPolicies
subscriptionId

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

checkEndpointNameAvailability(string, CheckEndpointNameAvailabilityInput, CheckEndpointNameAvailabilityOptionalParams)

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.

checkNameAvailability(CheckNameAvailabilityInput, CheckNameAvailabilityOptionalParams)

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

checkNameAvailabilityWithSubscription(CheckNameAvailabilityInput, CheckNameAvailabilityWithSubscriptionOptionalParams)

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

validateProbe(ValidateProbeInput, ValidateProbeOptionalParams)

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.

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

CdnManagementClient(TokenCredential, CdnManagementClientOptionalParams)

new CdnManagementClient(credentials: TokenCredential, options?: CdnManagementClientOptionalParams)

Parameters

credentials
TokenCredential

CdnManagementClient(TokenCredential, string, CdnManagementClientOptionalParams)

Initializes a new instance of the CdnManagementClient class.

new CdnManagementClient(credentials: TokenCredential, subscriptionId: string, options?: CdnManagementClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

Azure Subscription ID.

options
CdnManagementClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

afdCustomDomains

afdCustomDomains: AfdCustomDomains

Property Value

afdEndpoints

afdEndpoints: AfdEndpoints

Property Value

afdOriginGroups

afdOriginGroups: AfdOriginGroups

Property Value

afdOrigins

afdOrigins: AfdOrigins

Property Value

afdProfiles

afdProfiles: AfdProfiles

Property Value

apiVersion

apiVersion: string

Property Value

string

customDomains

customDomains: CustomDomains

Property Value

edgeNodes

edgeNodes: EdgeNodes

Property Value

endpoints

endpoints: Endpoints

Property Value

logAnalytics

logAnalytics: LogAnalytics

Property Value

managedRuleSets

managedRuleSets: ManagedRuleSets

Property Value

operations

operations: Operations

Property Value

originGroups

originGroups: OriginGroups

Property Value

origins

origins: Origins

Property Value

policies

policies: Policies

Property Value

profiles

profiles: Profiles

Property Value

resourceUsageOperations

resourceUsageOperations: ResourceUsageOperations

Property Value

routes

routes: Routes

Property Value

rules

rules: Rules

Property Value

ruleSets

ruleSets: RuleSets

Property Value

secrets

secrets: Secrets

Property Value

securityPolicies

securityPolicies: SecurityPolicies

Property Value

subscriptionId

subscriptionId?: string

Property Value

string

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Inherited From coreClient.ServiceClient.pipeline

Method Details

checkEndpointNameAvailability(string, CheckEndpointNameAvailabilityInput, CheckEndpointNameAvailabilityOptionalParams)

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.

function checkEndpointNameAvailability(resourceGroupName: string, checkEndpointNameAvailabilityInput: CheckEndpointNameAvailabilityInput, options?: CheckEndpointNameAvailabilityOptionalParams): Promise<CheckEndpointNameAvailabilityOutput>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

checkEndpointNameAvailabilityInput
CheckEndpointNameAvailabilityInput

Input to check.

options
CheckEndpointNameAvailabilityOptionalParams

The options parameters.

Returns

checkNameAvailability(CheckNameAvailabilityInput, CheckNameAvailabilityOptionalParams)

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

function checkNameAvailability(checkNameAvailabilityInput: CheckNameAvailabilityInput, options?: CheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>

Parameters

checkNameAvailabilityInput
CheckNameAvailabilityInput

Input to check.

options
CheckNameAvailabilityOptionalParams

The options parameters.

Returns

checkNameAvailabilityWithSubscription(CheckNameAvailabilityInput, CheckNameAvailabilityWithSubscriptionOptionalParams)

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

function checkNameAvailabilityWithSubscription(checkNameAvailabilityInput: CheckNameAvailabilityInput, options?: CheckNameAvailabilityWithSubscriptionOptionalParams): Promise<CheckNameAvailabilityOutput>

Parameters

checkNameAvailabilityInput
CheckNameAvailabilityInput

Input to check.

options
CheckNameAvailabilityWithSubscriptionOptionalParams

The options parameters.

Returns

validateProbe(ValidateProbeInput, ValidateProbeOptionalParams)

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.

function validateProbe(validateProbeInput: ValidateProbeInput, options?: ValidateProbeOptionalParams): Promise<ValidateProbeOutput>

Parameters

validateProbeInput
ValidateProbeInput

Input to check.

options
ValidateProbeOptionalParams

The options parameters.

Returns

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest