azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.c...

292 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.cdn.models.CdnProfile"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile"
name: "CdnProfile"
nameWithType: "CdnProfile"
summary: "An immutable client-side representation of an Azure CDN profile."
syntax: "public interface **CdnProfile**</br> extends <xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.CdnManager?alt=com.azure.resourcemanager.cdn.CdnManager&text=CdnManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.resourcemanager.cdn.fluent.models.ProfileInner?alt=com.azure.resourcemanager.cdn.fluent.models.ProfileInner&text=ProfileInner\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Refreshable?alt=com.azure.resourcemanager.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CdnProfile?alt=com.azure.resourcemanager.cdn.models.CdnProfile&text=CdnProfile\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Updatable?alt=com.azure.resourcemanager.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CdnProfile.Update?alt=com.azure.resourcemanager.cdn.models.CdnProfile.Update&text=Update\" data-throw-if-not-resolved=\"False\" />&gt;"
methods:
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.checkEndpointNameAvailability(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.checkEndpointNameAvailability(String name)"
name: "checkEndpointNameAvailability(String name)"
nameWithType: "CdnProfile.checkEndpointNameAvailability(String name)"
summary: "Checks the availability of an endpoint name without creating the CDN endpoint."
modifiers:
- "abstract"
parameters:
- description: "the endpoint resource name to validate"
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract CheckNameAvailabilityResult checkEndpointNameAvailability(String name)"
desc: "Checks the availability of an endpoint name without creating the CDN endpoint."
returns:
description: "the result if successful."
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CheckNameAvailabilityResult?alt=com.azure.resourcemanager.cdn.models.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.checkEndpointNameAvailabilityAsync(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.checkEndpointNameAvailabilityAsync(String name)"
name: "checkEndpointNameAvailabilityAsync(String name)"
nameWithType: "CdnProfile.checkEndpointNameAvailabilityAsync(String name)"
summary: "Checks the availability of an endpoint name without creating the CDN endpoint asynchronously."
modifiers:
- "abstract"
parameters:
- description: "the endpoint resource name to validate."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<CheckNameAvailabilityResult> checkEndpointNameAvailabilityAsync(String name)"
desc: "Checks the availability of an endpoint name without creating the CDN endpoint asynchronously."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CheckNameAvailabilityResult?alt=com.azure.resourcemanager.cdn.models.CheckNameAvailabilityResult&text=CheckNameAvailabilityResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.endpoints()"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.endpoints()"
name: "endpoints()"
nameWithType: "CdnProfile.endpoints()"
summary: "Gets latest endpoints by sending http request."
modifiers:
- "abstract"
syntax: "public abstract Map<String,CdnEndpoint> endpoints()"
desc: "Gets latest endpoints by sending http request."
returns:
description: "endpoints in the CDN manager profile, indexed by name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.resourcemanager.cdn.models.CdnEndpoint?alt=com.azure.resourcemanager.cdn.models.CdnEndpoint&text=CdnEndpoint\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.generateSsoUri()"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.generateSsoUri()"
name: "generateSsoUri()"
nameWithType: "CdnProfile.generateSsoUri()"
summary: "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal used for advanced management tasks."
modifiers:
- "abstract"
syntax: "public abstract String generateSsoUri()"
desc: "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal used for advanced management tasks."
returns:
description: "URI used to login to the third party web portal"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.generateSsoUriAsync()"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.generateSsoUriAsync()"
name: "generateSsoUriAsync()"
nameWithType: "CdnProfile.generateSsoUriAsync()"
summary: "Asynchronously generates a dynamic SSO URI used to sign into the CDN supplemental portal used for advanced management tasks."
modifiers:
- "abstract"
syntax: "public abstract Mono<String> generateSsoUriAsync()"
desc: "Asynchronously generates a dynamic SSO URI used to sign into the CDN supplemental portal used for advanced management tasks."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.isPremiumVerizon()"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.isPremiumVerizon()"
name: "isPremiumVerizon()"
nameWithType: "CdnProfile.isPremiumVerizon()"
modifiers:
- "abstract"
syntax: "public abstract boolean isPremiumVerizon()"
returns:
description: "true if this CDN profile's SKU is of Premium Verizon, else false."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.listResourceUsage()"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.listResourceUsage()"
name: "listResourceUsage()"
nameWithType: "CdnProfile.listResourceUsage()"
modifiers:
- "abstract"
syntax: "public abstract PagedIterable<ResourceUsage> listResourceUsage()"
returns:
description: "quotas and actual usages of endpoints under the current CDN profile"
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.ResourceUsage?alt=com.azure.resourcemanager.cdn.models.ResourceUsage&text=ResourceUsage\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.loadEndpointContent(java.lang.String,java.util.Set<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.loadEndpointContent(String endpointName, Set<String> contentPaths)"
name: "loadEndpointContent(String endpointName, Set<String> contentPaths)"
nameWithType: "CdnProfile.loadEndpointContent(String endpointName, Set<String> contentPaths)"
summary: "Forcibly pre-loads CDN endpoint content in the CDN profile."
modifiers:
- "abstract"
parameters:
- description: "a name of the endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the paths to the content to be purged, which can be file paths or directory wild cards"
name: "contentPaths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public abstract void loadEndpointContent(String endpointName, Set<String> contentPaths)"
desc: "Forcibly pre-loads CDN endpoint content in the CDN profile.\n\nNote, this is Available for Verizon Profiles only."
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.loadEndpointContentAsync(java.lang.String,java.util.Set<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.loadEndpointContentAsync(String endpointName, Set<String> contentPaths)"
name: "loadEndpointContentAsync(String endpointName, Set<String> contentPaths)"
nameWithType: "CdnProfile.loadEndpointContentAsync(String endpointName, Set<String> contentPaths)"
summary: "Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously."
modifiers:
- "abstract"
parameters:
- description: "a name of the endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the paths to the content to be purged, which can be file paths or directory wild cards"
name: "contentPaths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public abstract Mono<Void> loadEndpointContentAsync(String endpointName, Set<String> contentPaths)"
desc: "Forcibly pre-loads CDN endpoint content in the CDN profile asynchronously.\n\nNote, this is Available for Verizon Profiles only."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.purgeEndpointContent(java.lang.String,java.util.Set<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.purgeEndpointContent(String endpointName, Set<String> contentPaths)"
name: "purgeEndpointContent(String endpointName, Set<String> contentPaths)"
nameWithType: "CdnProfile.purgeEndpointContent(String endpointName, Set<String> contentPaths)"
summary: "Forcibly purges CDN endpoint content in the CDN profile."
modifiers:
- "abstract"
parameters:
- description: "a name of the endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the paths to the content to be purged, which can be file paths or directory wild cards"
name: "contentPaths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public abstract void purgeEndpointContent(String endpointName, Set<String> contentPaths)"
desc: "Forcibly purges CDN endpoint content in the CDN profile."
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.purgeEndpointContentAsync(java.lang.String,java.util.Set<java.lang.String>)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.purgeEndpointContentAsync(String endpointName, Set<String> contentPaths)"
name: "purgeEndpointContentAsync(String endpointName, Set<String> contentPaths)"
nameWithType: "CdnProfile.purgeEndpointContentAsync(String endpointName, Set<String> contentPaths)"
summary: "Forcibly purges CDN endpoint content in the CDN profile asynchronously."
modifiers:
- "abstract"
parameters:
- description: "a name of the endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the paths to the content to be purged, which can be file paths or directory wild cards"
name: "contentPaths"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Set.html\">Set</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public abstract Mono<Void> purgeEndpointContentAsync(String endpointName, Set<String> contentPaths)"
desc: "Forcibly purges CDN endpoint content in the CDN profile asynchronously."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.resourceState()"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.resourceState()"
name: "resourceState()"
nameWithType: "CdnProfile.resourceState()"
modifiers:
- "abstract"
syntax: "public abstract String resourceState()"
returns:
description: "CDN profile state"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.sku()"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.sku()"
name: "sku()"
nameWithType: "CdnProfile.sku()"
modifiers:
- "abstract"
syntax: "public abstract Sku sku()"
returns:
description: "the SKU of the CDN profile"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.Sku?alt=com.azure.resourcemanager.cdn.models.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.startEndpoint(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.startEndpoint(String endpointName)"
name: "startEndpoint(String endpointName)"
nameWithType: "CdnProfile.startEndpoint(String endpointName)"
summary: "Starts a stopped CDN endpoint."
modifiers:
- "abstract"
parameters:
- description: "a name of an endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void startEndpoint(String endpointName)"
desc: "Starts a stopped CDN endpoint."
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.startEndpointAsync(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.startEndpointAsync(String endpointName)"
name: "startEndpointAsync(String endpointName)"
nameWithType: "CdnProfile.startEndpointAsync(String endpointName)"
summary: "Starts a stopped CDN endpoint asynchronously."
modifiers:
- "abstract"
parameters:
- description: "a name of an endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Void> startEndpointAsync(String endpointName)"
desc: "Starts a stopped CDN endpoint asynchronously."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.stopEndpoint(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.stopEndpoint(String endpointName)"
name: "stopEndpoint(String endpointName)"
nameWithType: "CdnProfile.stopEndpoint(String endpointName)"
summary: "Stops a running CDN endpoint."
modifiers:
- "abstract"
parameters:
- description: "a name of an endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void stopEndpoint(String endpointName)"
desc: "Stops a running CDN endpoint."
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.stopEndpointAsync(java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.stopEndpointAsync(String endpointName)"
name: "stopEndpointAsync(String endpointName)"
nameWithType: "CdnProfile.stopEndpointAsync(String endpointName)"
summary: "Stops a running CDN endpoint asynchronously."
modifiers:
- "abstract"
parameters:
- description: "a name of an endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Void> stopEndpointAsync(String endpointName)"
desc: "Stops a running CDN endpoint asynchronously."
returns:
description: "a representation of the deferred computation of this call"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.validateEndpointCustomDomain(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.validateEndpointCustomDomain(String endpointName, String hostName)"
name: "validateEndpointCustomDomain(String endpointName, String hostName)"
nameWithType: "CdnProfile.validateEndpointCustomDomain(String endpointName, String hostName)"
summary: "Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile."
modifiers:
- "abstract"
parameters:
- description: "a name of the endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the host name of the custom domain, which must be a domain name"
name: "hostName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract CustomDomainValidationResult validateEndpointCustomDomain(String endpointName, String hostName)"
desc: "Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile."
returns:
description: "CustomDomainValidationResult object if successful"
type: "<xref href=\"com.azure.resourcemanager.cdn.models.CustomDomainValidationResult?alt=com.azure.resourcemanager.cdn.models.CustomDomainValidationResult&text=CustomDomainValidationResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cdn.models.CdnProfile.validateEndpointCustomDomainAsync(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.cdn.models.CdnProfile.validateEndpointCustomDomainAsync(String endpointName, String hostName)"
name: "validateEndpointCustomDomainAsync(String endpointName, String hostName)"
nameWithType: "CdnProfile.validateEndpointCustomDomainAsync(String endpointName, String hostName)"
summary: "Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile asynchronously."
modifiers:
- "abstract"
parameters:
- description: "a name of the endpoint under the profile"
name: "endpointName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "the host name of the custom domain, which must be a domain name"
name: "hostName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<CustomDomainValidationResult> validateEndpointCustomDomainAsync(String endpointName, String hostName)"
desc: "Validates a custom domain mapping to ensure it maps to the correct CNAME in DNS in current profile asynchronously."
returns:
description: "the Observable to CustomDomainValidationResult object if successful"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CustomDomainValidationResult?alt=com.azure.resourcemanager.cdn.models.CustomDomainValidationResult&text=CustomDomainValidationResult\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "An immutable client-side representation of an Azure CDN profile."
implements:
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource?alt=com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.CdnManager?alt=com.azure.resourcemanager.cdn.CdnManager&text=CdnManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.resourcemanager.cdn.fluent.models.ProfileInner?alt=com.azure.resourcemanager.cdn.fluent.models.ProfileInner&text=ProfileInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Refreshable?alt=com.azure.resourcemanager.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CdnProfile?alt=com.azure.resourcemanager.cdn.models.CdnProfile&text=CdnProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.resourcemanager.resources.fluentcore.model.Updatable?alt=com.azure.resourcemanager.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cdn.models.CdnProfile.Update?alt=com.azure.resourcemanager.cdn.models.CdnProfile.Update&text=Update\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.cdn.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cdn:2.42.0