ArmCdnModelFactory.CdnEndpointData Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public static Azure.ResourceManager.Cdn.CdnEndpointData CdnEndpointData(Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, string originPath = default, System.Collections.Generic.IEnumerable<string> contentTypesToCompress = default, string originHostHeader = default, bool? isCompressionEnabled = default, bool? isHttpAllowed = default, bool? isHttpsAllowed = default, Azure.ResourceManager.Cdn.Models.QueryStringCachingBehavior? queryStringCachingBehavior = default, Azure.ResourceManager.Cdn.Models.OptimizationType? optimizationType = default, string probePath = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Cdn.Models.GeoFilter> geoFilters = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Cdn.Models.UriSigningKey> uriSigningKeys = default, Azure.ResourceManager.Cdn.Models.EndpointDeliveryPolicy deliveryPolicy = default, Azure.Core.ResourceIdentifier defaultOriginGroupId = default, Azure.Core.ResourceIdentifier webApplicationFirewallPolicyLinkId = default, string hostName = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Cdn.Models.DeepCreatedOrigin> origins = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Cdn.Models.DeepCreatedOriginGroup> originGroups = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Cdn.Models.DeepCreatedCustomDomain> deepCreatedCustomDomains = default, Azure.ResourceManager.Cdn.Models.EndpointResourceState? resourceState = default, Azure.ResourceManager.Cdn.Models.CdnEndpointProvisioningState? provisioningState = default);
static member CdnEndpointData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * string * seq<string> * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.Cdn.Models.QueryStringCachingBehavior> * Nullable<Azure.ResourceManager.Cdn.Models.OptimizationType> * string * seq<Azure.ResourceManager.Cdn.Models.GeoFilter> * seq<Azure.ResourceManager.Cdn.Models.UriSigningKey> * Azure.ResourceManager.Cdn.Models.EndpointDeliveryPolicy * Azure.Core.ResourceIdentifier * Azure.Core.ResourceIdentifier * string * seq<Azure.ResourceManager.Cdn.Models.DeepCreatedOrigin> * seq<Azure.ResourceManager.Cdn.Models.DeepCreatedOriginGroup> * seq<Azure.ResourceManager.Cdn.Models.DeepCreatedCustomDomain> * Nullable<Azure.ResourceManager.Cdn.Models.EndpointResourceState> * Nullable<Azure.ResourceManager.Cdn.Models.CdnEndpointProvisioningState> -> Azure.ResourceManager.Cdn.CdnEndpointData
Public Shared Function CdnEndpointData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional originPath As String = Nothing, Optional contentTypesToCompress As IEnumerable(Of String) = Nothing, Optional originHostHeader As String = Nothing, Optional isCompressionEnabled As Nullable(Of Boolean) = Nothing, Optional isHttpAllowed As Nullable(Of Boolean) = Nothing, Optional isHttpsAllowed As Nullable(Of Boolean) = Nothing, Optional queryStringCachingBehavior As Nullable(Of QueryStringCachingBehavior) = Nothing, Optional optimizationType As Nullable(Of OptimizationType) = Nothing, Optional probePath As String = Nothing, Optional geoFilters As IEnumerable(Of GeoFilter) = Nothing, Optional uriSigningKeys As IEnumerable(Of UriSigningKey) = Nothing, Optional deliveryPolicy As EndpointDeliveryPolicy = Nothing, Optional defaultOriginGroupId As ResourceIdentifier = Nothing, Optional webApplicationFirewallPolicyLinkId As ResourceIdentifier = Nothing, Optional hostName As String = Nothing, Optional origins As IEnumerable(Of DeepCreatedOrigin) = Nothing, Optional originGroups As IEnumerable(Of DeepCreatedOriginGroup) = Nothing, Optional deepCreatedCustomDomains As IEnumerable(Of DeepCreatedCustomDomain) = Nothing, Optional resourceState As Nullable(Of EndpointResourceState) = Nothing, Optional provisioningState As Nullable(Of CdnEndpointProvisioningState) = Nothing) As CdnEndpointData
Parameters
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- name
- String
The name of the resource.
- resourceType
- ResourceType
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
- systemData
- SystemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
- tags
- IDictionary<String,String>
Resource tags.
- location
- AzureLocation
The geo-location where the resource lives.
- originPath
- String
A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
- contentTypesToCompress
- IEnumerable<String>
List of content types on which compression applies. The value should be a valid MIME type.
- originHostHeader
- String
The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.
Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
- queryStringCachingBehavior
- Nullable<QueryStringCachingBehavior>
Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.
- optimizationType
- Nullable<OptimizationType>
Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.
- probePath
- String
Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.
- geoFilters
- IEnumerable<GeoFilter>
List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/.
- uriSigningKeys
- IEnumerable<UriSigningKey>
List of keys used to validate the signed URL hashes.
- deliveryPolicy
- EndpointDeliveryPolicy
A policy that specifies the delivery rules to be used for an endpoint.
- defaultOriginGroupId
- ResourceIdentifier
Resource ID.
- webApplicationFirewallPolicyLinkId
- ResourceIdentifier
Resource ID.
- hostName
- String
The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net.
- origins
- IEnumerable<DeepCreatedOrigin>
The source of the content being delivered via CDN.
- originGroups
- IEnumerable<DeepCreatedOriginGroup>
The origin groups comprising of origins that are used for load balancing the traffic based on availability.
- deepCreatedCustomDomains
- IEnumerable<DeepCreatedCustomDomain>
The custom domains under the endpoint.
- resourceState
- Nullable<EndpointResourceState>
Resource status of the endpoint.
- provisioningState
- Nullable<CdnEndpointProvisioningState>
Provisioning status of the endpoint.
Returns
A new CdnEndpointData instance for mocking.