CdnProfile Interface

Package:

com.azure.resourcemanager.cdn.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cdn:2.46.0

Implements

GroupableResource<CdnManager,ProfileInner> Refreshable<CdnProfile> Updatable<Update>

public interface CdnProfile
extends GroupableResource<CdnManager,ProfileInner>, Refreshable<CdnProfile>, Updatable<Update>

An immutable client-side representation of an Azure CDN profile.

Method Summary

Modifier and Type	Method and Description
abstract CheckNameAvailabilityResult	checkEndpointNameAvailability(String name) Checks the availability of an endpoint name without creating the CDN endpoint.
abstract Mono<CheckNameAvailabilityResult>	checkEndpointNameAvailabilityAsync(String name) Checks the availability of an endpoint name without creating the CDN endpoint asynchronously.
abstract Map<String,CdnEndpoint>	endpoints() Gets latest endpoints by sending http request.
abstract String	generateSsoUri() Generates a dynamic SSO URI used to sign in to the CDN supplemental portal used for advanced management tasks.
abstract Mono<String>	generateSsoUriAsync() Asynchronously generates a dynamic SSO URI used to sign into the CDN supplemental portal used for advanced management tasks.
abstract boolean	isPremiumVerizon() Check whether this CDN profile's SKU is of Premium Verizon.
abstract PagedIterable<ResourceUsage>	listResourceUsage() Gets quotas and actual usages of endpoints under the current CDN profile.
abstract void	loadEndpointContent(String endpointName, Set<String> contentPaths) Forcibly pre-loads CDN endpoint content in the CDN profile.
abstract Mono<Void>	loadEndpointContentAsync(String endpointName, Set<String> contentPaths) Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously.
abstract void	purgeEndpointContent(String endpointName, Set<String> contentPaths) Forcibly purges CDN endpoint content in the CDN profile.
abstract Mono<Void>	purgeEndpointContentAsync(String endpointName, Set<String> contentPaths) Forcibly purges CDN endpoint content in the CDN profile asynchronously.
abstract String	resourceState() Gets CDN profile state.
abstract Sku	sku() Gets the SKU of the CDN profile.
abstract void	startEndpoint(String endpointName) Starts a stopped CDN endpoint.
abstract Mono<Void>	startEndpointAsync(String endpointName) Starts a stopped CDN endpoint asynchronously.
abstract void	stopEndpoint(String endpointName) Stops a running CDN endpoint.
abstract Mono<Void>	stopEndpointAsync(String endpointName) Stops a running CDN endpoint asynchronously.
abstract CustomDomainValidationResult	validateEndpointCustomDomain(String endpointName, String hostName) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile.
abstract Mono<CustomDomainValidationResult>	validateEndpointCustomDomainAsync(String endpointName, String hostName) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile asynchronously.

Method Details

checkEndpointNameAvailability

public abstract CheckNameAvailabilityResult checkEndpointNameAvailability(String name)

Checks the availability of an endpoint name without creating the CDN endpoint.

Parameters:

name - the endpoint resource name to validate

Returns:

the result if successful.

checkEndpointNameAvailabilityAsync

public abstract Mono checkEndpointNameAvailabilityAsync(String name)

Checks the availability of an endpoint name without creating the CDN endpoint asynchronously.

Parameters:

name - the endpoint resource name to validate.

Returns:

a representation of the deferred computation of this call

endpoints

public abstract Map endpoints()

Gets latest endpoints by sending http request.

Returns:

endpoints in the CDN manager profile, indexed by name

generateSsoUri

public abstract String generateSsoUri()

Generates a dynamic SSO URI used to sign in to the CDN supplemental portal used for advanced management tasks.

Returns:

URI used to login to the third party web portal

generateSsoUriAsync

public abstract Mono generateSsoUriAsync()

Asynchronously generates a dynamic SSO URI used to sign into the CDN supplemental portal used for advanced management tasks.

Returns:

a representation of the deferred computation of this call

isPremiumVerizon

public abstract boolean isPremiumVerizon()

Check whether this CDN profile's SKU is of Premium Verizon.

Returns:

true if this CDN profile's SKU is of Premium Verizon, else false.

listResourceUsage

public abstract PagedIterable listResourceUsage()

Gets quotas and actual usages of endpoints under the current CDN profile.

Returns:

quotas and actual usages of endpoints under the current CDN profile

loadEndpointContent

public abstract void loadEndpointContent(String endpointName, Set contentPaths)

Forcibly pre-loads CDN endpoint content in the CDN profile.

Note, this is Available for Verizon Profiles only.

Parameters:

endpointName - a name of the endpoint under the profile

contentPaths - the paths to the content to be purged, which can be file paths or directory wild cards

loadEndpointContentAsync

public abstract Mono loadEndpointContentAsync(String endpointName, Set contentPaths)

Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously.

Note, this is Available for Verizon Profiles only.

Parameters:

endpointName - a name of the endpoint under the profile

contentPaths - the paths to the content to be purged, which can be file paths or directory wild cards

Returns:

a representation of the deferred computation of this call

purgeEndpointContent

public abstract void purgeEndpointContent(String endpointName, Set contentPaths)

Forcibly purges CDN endpoint content in the CDN profile.

Parameters:

endpointName - a name of the endpoint under the profile

contentPaths - the paths to the content to be purged, which can be file paths or directory wild cards

purgeEndpointContentAsync

public abstract Mono purgeEndpointContentAsync(String endpointName, Set contentPaths)

Forcibly purges CDN endpoint content in the CDN profile asynchronously.

Parameters:

endpointName - a name of the endpoint under the profile

contentPaths - the paths to the content to be purged, which can be file paths or directory wild cards

Returns:

a representation of the deferred computation of this call

resourceState

public abstract String resourceState()

Gets CDN profile state.

Returns:

CDN profile state

sku

public abstract Sku sku()

Gets the SKU of the CDN profile.

Returns:

the SKU of the CDN profile

startEndpoint

public abstract void startEndpoint(String endpointName)

Starts a stopped CDN endpoint.

Parameters:

endpointName - a name of an endpoint under the profile

startEndpointAsync

public abstract Mono startEndpointAsync(String endpointName)

Starts a stopped CDN endpoint asynchronously.

Parameters:

endpointName - a name of an endpoint under the profile

Returns:

a representation of the deferred computation of this call

stopEndpoint

public abstract void stopEndpoint(String endpointName)

Stops a running CDN endpoint.

Parameters:

endpointName - a name of an endpoint under the profile

stopEndpointAsync

public abstract Mono stopEndpointAsync(String endpointName)

Stops a running CDN endpoint asynchronously.

Parameters:

endpointName - a name of an endpoint under the profile

Returns:

a representation of the deferred computation of this call

validateEndpointCustomDomain

public abstract CustomDomainValidationResult validateEndpointCustomDomain(String endpointName, String hostName)

Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile.

Parameters:

endpointName - a name of the endpoint under the profile

hostName - the host name of the custom domain, which must be a domain name

Returns:

CustomDomainValidationResult object if successful

validateEndpointCustomDomainAsync

public abstract Mono validateEndpointCustomDomainAsync(String endpointName, String hostName)

Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile asynchronously.

Parameters:

endpointName - a name of the endpoint under the profile

hostName - the host name of the custom domain, which must be a domain name

Returns:

the Observable to CustomDomainValidationResult object if successful