CdnProfile Interface

Package:

com.microsoft.azure.management.cdn

Maven Artifact:

com.microsoft.azure:azure-mgmt-cdn:1.41.4

Implements

GroupableResource<com.microsoft.azure.management.cdn.implementation.CdnManager,com.microsoft.azure.management.cdn.implementation.ProfileInner> Refreshable<CdnProfile> Updatable<Update>

public interface CdnProfile
extends GroupableResource<com.microsoft.azure.management.cdn.implementation.CdnManager,com.microsoft.azure.management.cdn.implementation.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 rx.Observable<CheckNameAvailabilityResult>	checkEndpointNameAvailabilityAsync(String name) Checks the availability of an endpoint name without creating the CDN endpoint asynchronously.
abstract com.microsoft.rest.ServiceFuture<CheckNameAvailabilityResult>	checkEndpointNameAvailabilityAsync(String name, ServiceCallback<CheckNameAvailabilityResult> callback) Checks the availability of an endpoint name without creating the CDN endpoint asynchronously.
abstract java.util.Map<java.lang.String,CdnEndpoint>	endpoints()
abstract java.lang.String	generateSsoUri() Generates a dynamic SSO URI used to sign in to the CDN supplemental portal used for advanced management tasks.
abstract rx.Observable<java.lang.String>	generateSsoUriAsync() Asynchronously generates a dynamic SSO URI used to sign into the CDN supplemental portal used for advanced management tasks.
abstract com.microsoft.rest.ServiceFuture<java.lang.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.
abstract boolean	isPremiumVerizon()
abstract com.microsoft.azure.PagedList<ResourceUsage>	listResourceUsage()
abstract void	loadEndpointContent(String endpointName, Set<String> contentPaths) Forcibly pre-loads CDN endpoint content in the CDN profile.
abstract rx.Completable	loadEndpointContentAsync(String endpointName, Set<String> contentPaths) Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	loadEndpointContentAsync(String endpointName, Set<String> contentPaths, ServiceCallback<Void> callback) 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 rx.Completable	purgeEndpointContentAsync(String endpointName, Set<String> contentPaths) Forcibly purges CDN endpoint content in the CDN profile asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	purgeEndpointContentAsync(String endpointName, Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly purges CDN endpoint content in the CDN profile asynchronously.
abstract java.lang.String	resourceState()
abstract Sku	sku()
abstract void	startEndpoint(String endpointName) Starts a stopped CDN endpoint.
abstract rx.Completable	startEndpointAsync(String endpointName) Starts a stopped CDN endpoint asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	startEndpointAsync(String endpointName, ServiceCallback<Void> callback) Starts a stopped CDN endpoint asynchronously.
abstract void	stopEndpoint(String endpointName) Stops a running CDN endpoint.
abstract rx.Completable	stopEndpointAsync(String endpointName) Stops a running CDN endpoint asynchronously.
abstract com.microsoft.rest.ServiceFuture<java.lang.Void>	stopEndpointAsync(String endpointName, ServiceCallback<Void> callback) 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 rx.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.
abstract com.microsoft.rest.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.

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 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 abstract 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 abstract Map endpoints()

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 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 abstract 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 abstract boolean isPremiumVerizon()

Returns:

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

listResourceUsage

public abstract PagedList listResourceUsage()

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 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 abstract 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 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 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 abstract 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 abstract String resourceState()

Returns:

CDN profile state

sku

public abstract Sku sku()

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 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 abstract 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 abstract void stopEndpoint(String endpointName)

Stops a running CDN endpoint.

Parameters:

endpointName - a name of an endpoint under the profile

stopEndpointAsync

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