Interface CdnProfile

All Superinterfaces:
com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<CdnManager, ProfileInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<ProfileInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<CdnManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<CdnProfile>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.model.Updatable<CdnProfile.Update>
public interface CdnProfile extends com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<CdnManager, ProfileInner>, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<CdnProfile>, com.azure.resourcemanager.resources.fluentcore.model.Updatable<CdnProfile.Update>
An immutable client-side representation of an Azure CDN profile.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    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.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

  • Field Summary

    Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

    DUMMY

  • Method Summary

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

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

    id

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

    innerModel

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

    manager

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

    name

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

    resourceGroupName

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

    key

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

    refresh, refreshAsync

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

    region, regionName, tags, type

    Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

    update

  • Method Details

    • sku

      Sku sku()
      Gets the SKU of the CDN profile.
      Returns:
      the SKU of the CDN profile

    • resourceState

      String resourceState()
      Gets CDN profile state.
      Returns:
      CDN profile state

    • endpoints

      Map<String, CdnEndpoint> endpoints()
      Gets latest endpoints by sending http request.
      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

      Mono<String> 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

    • startEndpoint

      void startEndpoint(String endpointName)
      Starts a stopped CDN endpoint.
      Parameters:
      endpointName - a name of an endpoint under the profile

    • startEndpointAsync

      Mono<Void> 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

      void stopEndpoint(String endpointName)
      Stops a running CDN endpoint.
      Parameters:
      endpointName - a name of an endpoint under the profile

    • stopEndpointAsync

      Mono<Void> 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

    • 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

      Mono<Void> 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

    • 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

      Mono<Void> 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

    • 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

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

    • 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

      Mono<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

    • isPremiumVerizon

      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

      com.azure.core.http.rest.PagedIterable<ResourceUsage> 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