com.microsoft.azure.management.cdn

Interface CdnProfile

All Superinterfaces:

GroupableResource<com.microsoft.azure.management.cdn.implementation.CdnManager,com.microsoft.azure.management.cdn.implementation.ProfileInner>, HasId, HasInner<com.microsoft.azure.management.cdn.implementation.ProfileInner>, HasManager<com.microsoft.azure.management.cdn.implementation.CdnManager>, HasName, HasResourceGroup, Indexable, Refreshable<CdnProfile>, Resource, Updatable<CdnProfile.Update>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CdnProfile.Definition The entirety of a CDN profile definition.
static interface	CdnProfile.DefinitionStages Grouping of CDN profile definition stages.
static interface	CdnProfile.Update The template for an update operation, containing all the settings that can be modified.
static interface	CdnProfile.UpdateStages Grouping of CDN manager update stages.

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Method Summary

Modifier and Type	Method and Description
CheckNameAvailabilityResult	checkEndpointNameAvailability(String name) Checks the availability of an endpoint name without creating the CDN endpoint.
rx.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.
rx.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.
rx.Completable	loadEndpointContentAsync(String endpointName, Set<String> contentPaths) Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously.
ServiceFuture<Void>	loadEndpointContentAsync(String endpointName, Set<String> contentPaths, ServiceCallback<Void> callback) Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously.
void	purgeEndpointContent(String endpointName, Set<String> contentPaths) Forcibly purges CDN endpoint content in the CDN profile.
rx.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.
rx.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.
rx.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.
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.
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.

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

inner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

update

Method Detail

sku

Sku sku()

Returns:

the SKU of the CDN profile

resourceState

String resourceState()

Returns:

CDN profile state

endpoints

Map<String,CdnEndpoint> endpoints()

Returns:

endpoints in the CDN manager profile, indexed by name

generateSsoUri

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

rx.Observable<String> 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

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.

Parameters:

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

startEndpoint

void startEndpoint(String endpointName)

Starts a stopped CDN endpoint.

Parameters:

endpointName - a name of an endpoint under the profile

startEndpointAsync

rx.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

ServiceFuture<Void> startEndpointAsync(String endpointName,
                                       ServiceCallback<Void> 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

void stopEndpoint(String endpointName)

Stops a running CDN endpoint.

Parameters:

endpointName - a name of an endpoint under the profile

stopEndpointAsync

rx.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

ServiceFuture<Void> stopEndpointAsync(String endpointName,
                                      ServiceCallback<Void> 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

purgeEndpointContent

void purgeEndpointContent(String endpointName,
                          Set<String> 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

rx.Completable purgeEndpointContentAsync(String endpointName,
                                         Set<String> 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

ServiceFuture<Void> purgeEndpointContentAsync(String endpointName,
                                              Set<String> contentPaths,
                                              ServiceCallback<Void> 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

loadEndpointContent

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.

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

rx.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.

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

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.

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

validateEndpointCustomDomain

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

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.

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

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.

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

checkEndpointNameAvailability

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

rx.Observable<CheckNameAvailabilityResult> 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

ServiceFuture<CheckNameAvailabilityResult> checkEndpointNameAvailabilityAsync(String name,
                                                                              ServiceCallback<CheckNameAvailabilityResult> 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

isPremiumVerizon

boolean isPremiumVerizon()

Returns:

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

listResourceUsage

PagedList<ResourceUsage> listResourceUsage()

Returns:

quotas and actual usages of endpoints under the current CDN profile