CdnProfile Interface

Package:

com.microsoft.azure.management.cdn

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

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

Method Summary

Modifier and Type	Method and Description
CheckNameAvailabilityResult	checkEndpointNameAvailability(String name) Checks the availability of an endpoint name without creating the CDN endpoint.
Observable<CheckNameAvailabilityResult>	checkEndpointNameAvailabilityAsync(String name) Checks the availability of an endpoint name without creating the CDN endpoint asynchronously.
ServiceFuture<CheckNameAvailabilityResult>	checkEndpointNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback) Checks the availability of an endpoint name without creating the CDN endpoint asynchronously.
Map<String, CdnEndpoint>	endpoints()
String	generateSsoUri() Generates a dynamic SSO URI used to sign in to the CDN supplemental portal used for advanced management tasks.
Observable<String>	generateSsoUriAsync() Asynchronously generates a dynamic SSO URI used to sign into the CDN supplemental portal used for advanced management tasks.
ServiceFuture<String>	generateSsoUriAsync(ServiceCallback<String> callback) Asynchronously generates a dynamic SSO URI used to sign in to the CDN supplemental portal used for advanced management tasks.
boolean	isPremiumVerizon()
PagedList<ResourceUsage>	listResourceUsage()
void	loadEndpointContent(String endpointName, Set<String> contentPaths) Forcibly pre-loads CDN endpoint content in the CDN profile. Note, this is Available for Verizon Profiles only.
Completable	loadEndpointContentAsync(String endpointName, Set<String> contentPaths) Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously. Note, this is Available for Verizon Profiles only.
ServiceFuture<Void>	loadEndpointContentAsync(String endpointName, Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously. Note, this is Available for Verizon Profiles only.
void	purgeEndpointContent(String endpointName, Set<String> contentPaths) Forcibly purges CDN endpoint content in the CDN profile.
Completable	purgeEndpointContentAsync(String endpointName, Set<String> contentPaths) Forcibly purges CDN endpoint content in the CDN profile asynchronously.
ServiceFuture<Void>	purgeEndpointContentAsync(String endpointName, Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly purges CDN endpoint content in the CDN profile asynchronously.
String	resourceState()
Sku	sku()
void	startEndpoint(String endpointName) Starts a stopped CDN endpoint.
Completable	startEndpointAsync(String endpointName) Starts a stopped CDN endpoint asynchronously.
ServiceFuture<Void>	startEndpointAsync(String endpointName, ServiceCallback<Void> callback) Starts a stopped CDN endpoint asynchronously.
void	stopEndpoint(String endpointName) Stops a running CDN endpoint.
Completable	stopEndpointAsync(String endpointName) Stops a running CDN endpoint asynchronously.
ServiceFuture<Void>	stopEndpointAsync(String endpointName, ServiceCallback<Void> callback) Stops a running CDN endpoint asynchronously.
CustomDomainValidationResult	validateEndpointCustomDomain(String endpointName, String hostName) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile.
Observable<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.
ServiceFuture<CustomDomainValidationResult>	validateEndpointCustomDomainAsync(String endpointName, String hostName, ServiceCallback<CustomDomainValidationResult> callback) Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile asynchronously.

Inherited Members

HasId.id() HasInner<T>.inner() Indexable.key() HasManager<ManagerT>.manager() HasName.name() Refreshable<T>.refresh() Refreshable<T>.refreshAsync() Resource.region() Resource.regionName() HasResourceGroup.resourceGroupName() Resource.tags() Resource.type() Updatable<T>.update()

Method Details

checkEndpointNameAvailability

public 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 Observable 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

checkEndpointNameAvailabilityAsync

public ServiceFuture checkEndpointNameAvailabilityAsync(String name, ServiceCallback callback)

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

Parameters:

name - the endpoint resource name to validate.

callback - the callback to call on success or failure

Returns:

a representation of the deferred computation of this call

endpoints

public Map endpoints()

Returns:

endpoints in the CDN manager profile, indexed by name

generateSsoUri

public 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 Observable generateSsoUriAsync()

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

Returns:

Observable to URI used to login to third party web portal

generateSsoUriAsync

public ServiceFuture generateSsoUriAsync(ServiceCallback callback)

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

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

isPremiumVerizon

public boolean isPremiumVerizon()

Returns:

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

listResourceUsage

public PagedList listResourceUsage()

Returns:

quotas and actual usages of endpoints under the current CDN profile

loadEndpointContent

public 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 Completable 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

loadEndpointContentAsync

public ServiceFuture loadEndpointContentAsync(String endpointName, Set contentPaths, ServiceCallback callback)

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

callback - the callback to call on success or failure

Returns:

a representation of the deferred computation of this call

purgeEndpointContent

public 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 Completable 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

purgeEndpointContentAsync

public ServiceFuture purgeEndpointContentAsync(String endpointName, Set contentPaths, ServiceCallback callback)

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

callback - the callback to call on success or failure

Returns:

a representation of the deferred computation of this call

resourceState

public String resourceState()

Returns:

CDN profile state

sku

public Sku sku()

Returns:

the SKU of the CDN profile

startEndpoint

public void startEndpoint(String endpointName)

Starts a stopped CDN endpoint.

Parameters:

endpointName - a name of an endpoint under the profile

startEndpointAsync

public Completable 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

startEndpointAsync

public ServiceFuture startEndpointAsync(String endpointName, ServiceCallback callback)

Starts a stopped CDN endpoint asynchronously.

Parameters:

endpointName - a name of an endpoint under the profile

callback - the callback to call on success or failure

Returns:

a representation of the deferred computation of this call

stopEndpoint

public void stopEndpoint(String endpointName)

Stops a running CDN endpoint.

Parameters:

endpointName - a name of an endpoint under the profile

stopEndpointAsync

public Completable 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

stopEndpointAsync

public ServiceFuture stopEndpointAsync(String endpointName, ServiceCallback callback)

Stops a running CDN endpoint asynchronously.

Parameters:

endpointName - a name of an endpoint under the profile

callback - the callback to call on success or failure

Returns:

a representation of the deferred computation of this call

validateEndpointCustomDomain

public 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 Observable 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

validateEndpointCustomDomainAsync

public ServiceFuture validateEndpointCustomDomainAsync(String endpointName, String hostName, ServiceCallback callback)

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

callback - the callback to call on success or failure

Returns:

a representation of the deferred computation of this call