cdn.azure.com/v1api20230501
cdn.azure.com/v1api20230501
Package v1api20230501 contains API Schema definitions for the cdn v1api20230501 API group
AFDDomainHttpsParameters
(Appears on:AfdCustomDomain_Spec)
The JSON object that contains the properties to secure a domain.
Field | Description |
---|---|
certificateType AFDDomainHttpsParameters_CertificateType |
CertificateType: Defines the source of the SSL certificate. |
minimumTlsVersion AFDDomainHttpsParameters_MinimumTlsVersion |
MinimumTlsVersion: TLS protocol version that will be used for Https |
secret ResourceReference |
Secret: Resource reference to the secret. ie. subs/rg/profile/secret |
AFDDomainHttpsParameters_CertificateType
(string
alias)
(Appears on:AFDDomainHttpsParameters)
Value | Description |
---|---|
"AzureFirstPartyManagedCertificate" |
|
"CustomerCertificate" |
|
"ManagedCertificate" |
AFDDomainHttpsParameters_CertificateType_STATUS
(string
alias)
(Appears on:AFDDomainHttpsParameters_STATUS)
Value | Description |
---|---|
"AzureFirstPartyManagedCertificate" |
|
"CustomerCertificate" |
|
"ManagedCertificate" |
AFDDomainHttpsParameters_MinimumTlsVersion
(string
alias)
(Appears on:AFDDomainHttpsParameters)
Value | Description |
---|---|
"TLS10" |
|
"TLS12" |
AFDDomainHttpsParameters_MinimumTlsVersion_STATUS
(string
alias)
(Appears on:AFDDomainHttpsParameters_STATUS)
Value | Description |
---|---|
"TLS10" |
|
"TLS12" |
AFDDomainHttpsParameters_STATUS
(Appears on:AfdCustomDomain_STATUS)
The JSON object that contains the properties to secure a domain.
Field | Description |
---|---|
certificateType AFDDomainHttpsParameters_CertificateType_STATUS |
CertificateType: Defines the source of the SSL certificate. |
minimumTlsVersion AFDDomainHttpsParameters_MinimumTlsVersion_STATUS |
MinimumTlsVersion: TLS protocol version that will be used for Https |
secret ResourceReference_STATUS |
Secret: Resource reference to the secret. ie. subs/rg/profile/secret |
AFDDomainProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:AfdCustomDomain_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
AFDDomainProperties_DomainValidationState_STATUS
(string
alias)
(Appears on:AfdCustomDomain_STATUS)
Value | Description |
---|---|
"Approved" |
|
"InternalError" |
|
"Pending" |
|
"PendingRevalidation" |
|
"RefreshingValidationToken" |
|
"Rejected" |
|
"Submitting" |
|
"TimedOut" |
|
"Unknown" |
AFDDomainProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:AfdCustomDomain_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
AFDEndpointProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:AfdEndpoint_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
AFDEndpointProperties_EnabledState
(string
alias)
(Appears on:AfdEndpoint_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AFDEndpointProperties_EnabledState_STATUS
(string
alias)
(Appears on:AfdEndpoint_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AFDEndpointProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:AfdEndpoint_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
AFDEndpointProtocols
(string
alias)
(Appears on:Route_Spec)
Supported protocols for the customer’s endpoint.
Value | Description |
---|---|
"Http" |
|
"Https" |
AFDEndpointProtocols_STATUS
(string
alias)
(Appears on:Route_STATUS)
Supported protocols for the customer’s endpoint.
Value | Description |
---|---|
"Http" |
|
"Https" |
AFDOriginGroupProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:AfdOriginGroup_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
AFDOriginGroupProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:AfdOriginGroup_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
AFDOriginGroupProperties_SessionAffinityState
(string
alias)
(Appears on:AfdOriginGroup_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AFDOriginGroupProperties_SessionAffinityState_STATUS
(string
alias)
(Appears on:AfdOriginGroup_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AFDOriginProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:AfdOrigin_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
AFDOriginProperties_EnabledState
(string
alias)
(Appears on:AfdOrigin_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AFDOriginProperties_EnabledState_STATUS
(string
alias)
(Appears on:AfdOrigin_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
AFDOriginProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:AfdOrigin_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
APIVersion
(string
alias)
Value | Description |
---|---|
"2023-05-01" |
ActivatedResourceReference
(Appears on:Route_Spec, SecurityPolicyWebApplicationFirewallAssociation)
Reference to another resource along with its state.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
ActivatedResourceReference_STATUS_Profiles_AfdEndpoints_Route_SubResourceEmbedded
(Appears on:Route_STATUS)
Reference to another resource along with its state.
Field | Description |
---|---|
id string |
Id: Resource ID. |
ActivatedResourceReference_STATUS_Profiles_SecurityPolicy_SubResourceEmbedded
(Appears on:SecurityPolicyWebApplicationFirewallAssociation_STATUS)
Reference to another resource along with its state.
Field | Description |
---|---|
id string |
Id: Resource ID. |
AfdCustomDomain
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}p>
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec AfdCustomDomain_Spec |
|
||||||||||||||||
status AfdCustomDomain_STATUS |
AfdCustomDomainOperatorSpec
(Appears on:AfdCustomDomain_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
AfdCustomDomain_STATUS
(Appears on:AfdCustomDomain)
Field | Description |
---|---|
azureDnsZone ResourceReference_STATUS |
AzureDnsZone: Resource reference to the Azure DNS zone |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deploymentStatus AFDDomainProperties_DeploymentStatus_STATUS |
|
domainValidationState AFDDomainProperties_DomainValidationState_STATUS |
DomainValidationState: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. |
extendedProperties map[string]string |
ExtendedProperties: Key-Value pair representing migration properties for domains. |
hostName string |
HostName: The host name of the domain. Must be a domain name. |
id string |
Id: Resource ID. |
name string |
Name: Resource name. |
preValidatedCustomDomainResourceId ResourceReference_STATUS |
PreValidatedCustomDomainResourceId: Resource reference to the Azure resource where custom domain ownership was prevalidated |
profileName string |
ProfileName: The name of the profile which holds the domain. |
provisioningState AFDDomainProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
systemData SystemData_STATUS |
SystemData: Read only system data |
tlsSettings AFDDomainHttpsParameters_STATUS |
TlsSettings: The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. |
type string |
Type: Resource type. |
validationProperties DomainValidationProperties_STATUS |
ValidationProperties: Values the customer needs to validate domain ownership |
AfdCustomDomain_Spec
(Appears on:AfdCustomDomain)
Field | Description |
---|---|
azureDnsZone ResourceReference |
AzureDnsZone: Resource reference to the Azure DNS zone |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
extendedProperties map[string]string |
ExtendedProperties: Key-Value pair representing migration properties for domains. |
hostName string |
HostName: The host name of the domain. Must be a domain name. |
operatorSpec AfdCustomDomainOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/Profile resource |
preValidatedCustomDomainResourceId ResourceReference |
PreValidatedCustomDomainResourceId: Resource reference to the Azure resource where custom domain ownership was prevalidated |
tlsSettings AFDDomainHttpsParameters |
TlsSettings: The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user’s own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default. |
AfdEndpoint
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}p>
Field | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
spec AfdEndpoint_Spec |
|
||||||||||||||
status AfdEndpoint_STATUS |
AfdEndpointOperatorSpec
(Appears on:AfdEndpoint_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
AfdEndpoint_STATUS
(Appears on:AfdEndpoint)
Field | Description |
---|---|
autoGeneratedDomainNameLabelScope AutoGeneratedDomainNameLabelScope_STATUS |
AutoGeneratedDomainNameLabelScope: Indicates the endpoint name reuse scope. The default value is TenantReuse. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deploymentStatus AFDEndpointProperties_DeploymentStatus_STATUS |
|
enabledState AFDEndpointProperties_EnabledState_STATUS |
EnabledState: Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’ |
hostName string |
HostName: The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net |
id string |
Id: Resource ID. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
profileName string |
ProfileName: The name of the profile which holds the endpoint. |
provisioningState AFDEndpointProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
systemData SystemData_STATUS |
SystemData: Read only system data |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
AfdEndpoint_Spec
(Appears on:AfdEndpoint)
Field | Description |
---|---|
autoGeneratedDomainNameLabelScope AutoGeneratedDomainNameLabelScope |
AutoGeneratedDomainNameLabelScope: Indicates the endpoint name reuse scope. The default value is TenantReuse. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
enabledState AFDEndpointProperties_EnabledState |
EnabledState: Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’ |
location string |
Location: Resource location. |
operatorSpec AfdEndpointOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/Profile resource |
tags map[string]string |
Tags: Resource tags. |
AfdOrigin
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}p>
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec AfdOrigin_Spec |
|
||||||||||||||||||||||||||
status AfdOrigin_STATUS |
AfdOriginGroup
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}p>
Field | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
spec AfdOriginGroup_Spec |
|
||||||||||||||
status AfdOriginGroup_STATUS |
AfdOriginGroupOperatorSpec
(Appears on:AfdOriginGroup_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
AfdOriginGroup_STATUS
(Appears on:AfdOriginGroup)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deploymentStatus AFDOriginGroupProperties_DeploymentStatus_STATUS |
|
healthProbeSettings HealthProbeParameters_STATUS |
HealthProbeSettings: Health probe settings to the origin that is used to determine the health of the origin. |
id string |
Id: Resource ID. |
loadBalancingSettings LoadBalancingSettingsParameters_STATUS |
LoadBalancingSettings: Load balancing settings for a backend pool |
name string |
Name: Resource name. |
profileName string |
ProfileName: The name of the profile which holds the origin group. |
provisioningState AFDOriginGroupProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
sessionAffinityState AFDOriginGroupProperties_SessionAffinityState_STATUS |
SessionAffinityState: Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’ |
systemData SystemData_STATUS |
SystemData: Read only system data |
trafficRestorationTimeToHealedOrNewEndpointsInMinutes int |
TrafficRestorationTimeToHealedOrNewEndpointsInMinutes: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. |
type string |
Type: Resource type. |
AfdOriginGroup_Spec
(Appears on:AfdOriginGroup)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
healthProbeSettings HealthProbeParameters |
HealthProbeSettings: Health probe settings to the origin that is used to determine the health of the origin. |
loadBalancingSettings LoadBalancingSettingsParameters |
LoadBalancingSettings: Load balancing settings for a backend pool |
operatorSpec AfdOriginGroupOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/Profile resource |
sessionAffinityState AFDOriginGroupProperties_SessionAffinityState |
SessionAffinityState: Whether to allow session affinity on this host. Valid options are ‘Enabled’ or ‘Disabled’ |
trafficRestorationTimeToHealedOrNewEndpointsInMinutes int |
TrafficRestorationTimeToHealedOrNewEndpointsInMinutes: Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. |
AfdOriginOperatorSpec
(Appears on:AfdOrigin_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
AfdOrigin_STATUS
(Appears on:AfdOrigin)
Field | Description |
---|---|
azureOrigin ResourceReference_STATUS |
AzureOrigin: Resource reference to the Azure origin resource. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deploymentStatus AFDOriginProperties_DeploymentStatus_STATUS |
|
enabledState AFDOriginProperties_EnabledState_STATUS |
EnabledState: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. |
enforceCertificateNameCheck bool |
EnforceCertificateNameCheck: Whether to enable certificate name check at origin level |
hostName string |
HostName: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. |
httpPort int |
HttpPort: The value of the HTTP port. Must be between 1 and 65535. |
httpsPort int |
HttpsPort: The value of the HTTPS port. Must be between 1 and 65535. |
id string |
Id: Resource ID. |
name string |
Name: Resource name. |
originGroupName string |
OriginGroupName: The name of the origin group which contains this origin. |
originHostHeader string |
OriginHostHeader: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint |
priority int |
Priority: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 |
provisioningState AFDOriginProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
sharedPrivateLinkResource SharedPrivateLinkResourceProperties_STATUS |
SharedPrivateLinkResource: The properties of the private link resource for private origin. |
systemData SystemData_STATUS |
SystemData: Read only system data |
type string |
Type: Resource type. |
weight int |
Weight: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 |
AfdOrigin_Spec
(Appears on:AfdOrigin)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
azureOrigin ResourceReference |
AzureOrigin: Resource reference to the Azure origin resource. |
enabledState AFDOriginProperties_EnabledState |
EnabledState: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. |
enforceCertificateNameCheck bool |
EnforceCertificateNameCheck: Whether to enable certificate name check at origin level |
hostName string |
HostName: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint. |
httpPort int |
HttpPort: The value of the HTTP port. Must be between 1 and 65535. |
httpsPort int |
HttpsPort: The value of the HTTPS port. Must be between 1 and 65535. |
operatorSpec AfdOriginOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
originHostHeader string |
OriginHostHeader: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/AfdOriginGroup resource |
priority int |
Priority: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5 |
sharedPrivateLinkResource SharedPrivateLinkResourceProperties |
SharedPrivateLinkResource: The properties of the private link resource for private origin. |
weight int |
Weight: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 |
AfdRouteCacheConfiguration
(Appears on:Route_Spec)
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
Field | Description |
---|---|
compressionSettings CompressionSettings |
CompressionSettings: compression settings. |
queryParameters string |
QueryParameters: query parameters to include or exclude (comma separated). |
queryStringCachingBehavior AfdRouteCacheConfiguration_QueryStringCachingBehavior |
QueryStringCachingBehavior: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. |
AfdRouteCacheConfiguration_QueryStringCachingBehavior
(string
alias)
(Appears on:AfdRouteCacheConfiguration)
Value | Description |
---|---|
"IgnoreQueryString" |
|
"IgnoreSpecifiedQueryStrings" |
|
"IncludeSpecifiedQueryStrings" |
|
"UseQueryString" |
AfdRouteCacheConfiguration_QueryStringCachingBehavior_STATUS
(string
alias)
(Appears on:AfdRouteCacheConfiguration_STATUS)
Value | Description |
---|---|
"IgnoreQueryString" |
|
"IgnoreSpecifiedQueryStrings" |
|
"IncludeSpecifiedQueryStrings" |
|
"UseQueryString" |
AfdRouteCacheConfiguration_STATUS
(Appears on:Route_STATUS)
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
Field | Description |
---|---|
compressionSettings CompressionSettings_STATUS |
CompressionSettings: compression settings. |
queryParameters string |
QueryParameters: query parameters to include or exclude (comma separated). |
queryStringCachingBehavior AfdRouteCacheConfiguration_QueryStringCachingBehavior_STATUS |
QueryStringCachingBehavior: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. |
AutoGeneratedDomainNameLabelScope
(string
alias)
(Appears on:AfdEndpoint_Spec)
Indicates the endpoint name reuse scope. The default value is TenantReuse.
Value | Description |
---|---|
"NoReuse" |
|
"ResourceGroupReuse" |
|
"SubscriptionReuse" |
|
"TenantReuse" |
AutoGeneratedDomainNameLabelScope_STATUS
(string
alias)
(Appears on:AfdEndpoint_STATUS)
Indicates the endpoint name reuse scope. The default value is TenantReuse.
Value | Description |
---|---|
"NoReuse" |
|
"ResourceGroupReuse" |
|
"SubscriptionReuse" |
|
"TenantReuse" |
AzureFirstPartyManagedCertificateParameters
(Appears on:SecretParameters)
Field | Description |
---|---|
subjectAlternativeNames []string |
SubjectAlternativeNames: The list of SANs. |
type AzureFirstPartyManagedCertificateParameters_Type |
AzureFirstPartyManagedCertificateParameters_STATUS
(Appears on:SecretParameters_STATUS)
Field | Description |
---|---|
certificateAuthority string |
CertificateAuthority: Certificate issuing authority. |
expirationDate string |
ExpirationDate: Certificate expiration date. |
secretSource ResourceReference_STATUS |
SecretSource: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}p> |
subject string |
Subject: Subject name in the certificate. |
subjectAlternativeNames []string |
SubjectAlternativeNames: The list of SANs. |
thumbprint string |
Thumbprint: Certificate thumbprint. |
type AzureFirstPartyManagedCertificateParameters_Type_STATUS |
AzureFirstPartyManagedCertificateParameters_Type
(string
alias)
(Appears on:AzureFirstPartyManagedCertificateParameters)
Value | Description |
---|---|
"AzureFirstPartyManagedCertificate" |
AzureFirstPartyManagedCertificateParameters_Type_STATUS
(string
alias)
(Appears on:AzureFirstPartyManagedCertificateParameters_STATUS)
Value | Description |
---|---|
"AzureFirstPartyManagedCertificate" |
CacheConfiguration
(Appears on:RouteConfigurationOverrideActionParameters)
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
Field | Description |
---|---|
cacheBehavior CacheConfiguration_CacheBehavior |
CacheBehavior: Caching behavior for the requests |
cacheDuration string |
CacheDuration: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss |
isCompressionEnabled CacheConfiguration_IsCompressionEnabled |
IsCompressionEnabled: Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. |
queryParameters string |
QueryParameters: query parameters to include or exclude (comma separated). |
queryStringCachingBehavior CacheConfiguration_QueryStringCachingBehavior |
QueryStringCachingBehavior: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. |
CacheConfiguration_CacheBehavior
(string
alias)
(Appears on:CacheConfiguration)
Value | Description |
---|---|
"HonorOrigin" |
|
"OverrideAlways" |
|
"OverrideIfOriginMissing" |
CacheConfiguration_CacheBehavior_STATUS
(string
alias)
(Appears on:CacheConfiguration_STATUS)
Value | Description |
---|---|
"HonorOrigin" |
|
"OverrideAlways" |
|
"OverrideIfOriginMissing" |
CacheConfiguration_IsCompressionEnabled
(string
alias)
(Appears on:CacheConfiguration)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
CacheConfiguration_IsCompressionEnabled_STATUS
(string
alias)
(Appears on:CacheConfiguration_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
CacheConfiguration_QueryStringCachingBehavior
(string
alias)
(Appears on:CacheConfiguration)
Value | Description |
---|---|
"IgnoreQueryString" |
|
"IgnoreSpecifiedQueryStrings" |
|
"IncludeSpecifiedQueryStrings" |
|
"UseQueryString" |
CacheConfiguration_QueryStringCachingBehavior_STATUS
(string
alias)
(Appears on:CacheConfiguration_STATUS)
Value | Description |
---|---|
"IgnoreQueryString" |
|
"IgnoreSpecifiedQueryStrings" |
|
"IncludeSpecifiedQueryStrings" |
|
"UseQueryString" |
CacheConfiguration_STATUS
(Appears on:RouteConfigurationOverrideActionParameters_STATUS)
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
Field | Description |
---|---|
cacheBehavior CacheConfiguration_CacheBehavior_STATUS |
CacheBehavior: Caching behavior for the requests |
cacheDuration string |
CacheDuration: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss |
isCompressionEnabled CacheConfiguration_IsCompressionEnabled_STATUS |
IsCompressionEnabled: Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won’t be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. |
queryParameters string |
QueryParameters: query parameters to include or exclude (comma separated). |
queryStringCachingBehavior CacheConfiguration_QueryStringCachingBehavior_STATUS |
QueryStringCachingBehavior: Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. |
CacheExpirationActionParameters
(Appears on:DeliveryRuleCacheExpirationAction)
Defines the parameters for the cache expiration action.
Field | Description |
---|---|
cacheBehavior CacheExpirationActionParameters_CacheBehavior |
CacheBehavior: Caching behavior for the requests |
cacheDuration string |
CacheDuration: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss |
cacheType CacheExpirationActionParameters_CacheType |
CacheType: The level at which the content needs to be cached. |
typeName CacheExpirationActionParameters_TypeName |
CacheExpirationActionParameters_CacheBehavior
(string
alias)
(Appears on:CacheExpirationActionParameters)
Value | Description |
---|---|
"BypassCache" |
|
"Override" |
|
"SetIfMissing" |
CacheExpirationActionParameters_CacheBehavior_STATUS
(string
alias)
(Appears on:CacheExpirationActionParameters_STATUS)
Value | Description |
---|---|
"BypassCache" |
|
"Override" |
|
"SetIfMissing" |
CacheExpirationActionParameters_CacheType
(string
alias)
(Appears on:CacheExpirationActionParameters)
Value | Description |
---|---|
"All" |
CacheExpirationActionParameters_CacheType_STATUS
(string
alias)
(Appears on:CacheExpirationActionParameters_STATUS)
Value | Description |
---|---|
"All" |
CacheExpirationActionParameters_STATUS
(Appears on:DeliveryRuleCacheExpirationAction_STATUS)
Defines the parameters for the cache expiration action.
Field | Description |
---|---|
cacheBehavior CacheExpirationActionParameters_CacheBehavior_STATUS |
CacheBehavior: Caching behavior for the requests |
cacheDuration string |
CacheDuration: The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss |
cacheType CacheExpirationActionParameters_CacheType_STATUS |
CacheType: The level at which the content needs to be cached. |
typeName CacheExpirationActionParameters_TypeName_STATUS |
CacheExpirationActionParameters_TypeName
(string
alias)
(Appears on:CacheExpirationActionParameters)
Value | Description |
---|---|
"DeliveryRuleCacheExpirationActionParameters" |
CacheExpirationActionParameters_TypeName_STATUS
(string
alias)
(Appears on:CacheExpirationActionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleCacheExpirationActionParameters" |
CacheKeyQueryStringActionParameters
(Appears on:DeliveryRuleCacheKeyQueryStringAction)
Defines the parameters for the cache-key query string action.
Field | Description |
---|---|
queryParameters string |
QueryParameters: query parameters to include or exclude (comma separated). |
queryStringBehavior CacheKeyQueryStringActionParameters_QueryStringBehavior |
QueryStringBehavior: Caching behavior for the requests |
typeName CacheKeyQueryStringActionParameters_TypeName |
CacheKeyQueryStringActionParameters_QueryStringBehavior
(string
alias)
(Appears on:CacheKeyQueryStringActionParameters)
Value | Description |
---|---|
"Exclude" |
|
"ExcludeAll" |
|
"Include" |
|
"IncludeAll" |
CacheKeyQueryStringActionParameters_QueryStringBehavior_STATUS
(string
alias)
(Appears on:CacheKeyQueryStringActionParameters_STATUS)
Value | Description |
---|---|
"Exclude" |
|
"ExcludeAll" |
|
"Include" |
|
"IncludeAll" |
CacheKeyQueryStringActionParameters_STATUS
(Appears on:DeliveryRuleCacheKeyQueryStringAction_STATUS)
Defines the parameters for the cache-key query string action.
Field | Description |
---|---|
queryParameters string |
QueryParameters: query parameters to include or exclude (comma separated). |
queryStringBehavior CacheKeyQueryStringActionParameters_QueryStringBehavior_STATUS |
QueryStringBehavior: Caching behavior for the requests |
typeName CacheKeyQueryStringActionParameters_TypeName_STATUS |
CacheKeyQueryStringActionParameters_TypeName
(string
alias)
(Appears on:CacheKeyQueryStringActionParameters)
Value | Description |
---|---|
"DeliveryRuleCacheKeyQueryStringBehaviorActionParameters" |
CacheKeyQueryStringActionParameters_TypeName_STATUS
(string
alias)
(Appears on:CacheKeyQueryStringActionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleCacheKeyQueryStringBehaviorActionParameters" |
ClientPortMatchConditionParameters
(Appears on:DeliveryRuleClientPortCondition)
Defines the parameters for ClientPort match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator ClientPortMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName ClientPortMatchConditionParameters_TypeName |
ClientPortMatchConditionParameters_Operator
(string
alias)
(Appears on:ClientPortMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
ClientPortMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:ClientPortMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
ClientPortMatchConditionParameters_STATUS
(Appears on:DeliveryRuleClientPortCondition_STATUS)
Defines the parameters for ClientPort match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator ClientPortMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName ClientPortMatchConditionParameters_TypeName_STATUS |
ClientPortMatchConditionParameters_TypeName
(string
alias)
(Appears on:ClientPortMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleClientPortConditionParameters" |
ClientPortMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:ClientPortMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleClientPortConditionParameters" |
CompressionSettings
(Appears on:AfdRouteCacheConfiguration)
settings for compression.
Field | Description |
---|---|
contentTypesToCompress []string |
ContentTypesToCompress: List of content types on which compression applies. The value should be a valid MIME type. |
isCompressionEnabled bool |
IsCompressionEnabled: Indicates whether content compression is enabled on AzureFrontDoor. 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 AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. |
CompressionSettings_STATUS
(Appears on:AfdRouteCacheConfiguration_STATUS)
settings for compression.
Field | Description |
---|---|
contentTypesToCompress []string |
ContentTypesToCompress: List of content types on which compression applies. The value should be a valid MIME type. |
isCompressionEnabled bool |
IsCompressionEnabled: Indicates whether content compression is enabled on AzureFrontDoor. 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 AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. |
CookiesMatchConditionParameters
(Appears on:DeliveryRuleCookiesCondition)
Defines the parameters for Cookies match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator CookiesMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
selector string |
Selector: Name of Cookies to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName CookiesMatchConditionParameters_TypeName |
CookiesMatchConditionParameters_Operator
(string
alias)
(Appears on:CookiesMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
CookiesMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:CookiesMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
CookiesMatchConditionParameters_STATUS
(Appears on:DeliveryRuleCookiesCondition_STATUS)
Defines the parameters for Cookies match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator CookiesMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
selector string |
Selector: Name of Cookies to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName CookiesMatchConditionParameters_TypeName_STATUS |
CookiesMatchConditionParameters_TypeName
(string
alias)
(Appears on:CookiesMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleCookiesConditionParameters" |
CookiesMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:CookiesMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleCookiesConditionParameters" |
CustomerCertificateParameters
(Appears on:SecretParameters)
Field | Description |
---|---|
secretSource ResourceReference |
SecretSource: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}p> |
secretVersion string |
SecretVersion: Version of the secret to be used |
subjectAlternativeNames []string |
SubjectAlternativeNames: The list of SANs. |
type CustomerCertificateParameters_Type |
|
useLatestVersion bool |
UseLatestVersion: Whether to use the latest version for the certificate |
CustomerCertificateParameters_STATUS
(Appears on:SecretParameters_STATUS)
Field | Description |
---|---|
certificateAuthority string |
CertificateAuthority: Certificate issuing authority. |
expirationDate string |
ExpirationDate: Certificate expiration date. |
secretSource ResourceReference_STATUS |
SecretSource: Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}p> |
secretVersion string |
SecretVersion: Version of the secret to be used |
subject string |
Subject: Subject name in the certificate. |
subjectAlternativeNames []string |
SubjectAlternativeNames: The list of SANs. |
thumbprint string |
Thumbprint: Certificate thumbprint. |
type CustomerCertificateParameters_Type_STATUS |
|
useLatestVersion bool |
UseLatestVersion: Whether to use the latest version for the certificate |
CustomerCertificateParameters_Type
(string
alias)
(Appears on:CustomerCertificateParameters)
Value | Description |
---|---|
"CustomerCertificate" |
CustomerCertificateParameters_Type_STATUS
(string
alias)
(Appears on:CustomerCertificateParameters_STATUS)
Value | Description |
---|---|
"CustomerCertificate" |
DeliveryRuleAction
(Appears on:Rule_Spec)
An action for the delivery rule.
Field | Description |
---|---|
cacheExpiration DeliveryRuleCacheExpirationAction |
CacheExpiration: Mutually exclusive with all other properties |
cacheKeyQueryString DeliveryRuleCacheKeyQueryStringAction |
CacheKeyQueryString: Mutually exclusive with all other properties |
modifyRequestHeader DeliveryRuleRequestHeaderAction |
ModifyRequestHeader: Mutually exclusive with all other properties |
modifyResponseHeader DeliveryRuleResponseHeaderAction |
ModifyResponseHeader: Mutually exclusive with all other properties |
originGroupOverride OriginGroupOverrideAction |
OriginGroupOverride: Mutually exclusive with all other properties |
routeConfigurationOverride DeliveryRuleRouteConfigurationOverrideAction |
RouteConfigurationOverride: Mutually exclusive with all other properties |
urlRedirect UrlRedirectAction |
UrlRedirect: Mutually exclusive with all other properties |
urlRewrite UrlRewriteAction |
UrlRewrite: Mutually exclusive with all other properties |
urlSigning UrlSigningAction |
UrlSigning: Mutually exclusive with all other properties |
DeliveryRuleAction_STATUS
(Appears on:Rule_STATUS)
An action for the delivery rule.
Field | Description |
---|---|
cacheExpiration DeliveryRuleCacheExpirationAction_STATUS |
CacheExpiration: Mutually exclusive with all other properties |
cacheKeyQueryString DeliveryRuleCacheKeyQueryStringAction_STATUS |
CacheKeyQueryString: Mutually exclusive with all other properties |
modifyRequestHeader DeliveryRuleRequestHeaderAction_STATUS |
ModifyRequestHeader: Mutually exclusive with all other properties |
modifyResponseHeader DeliveryRuleResponseHeaderAction_STATUS |
ModifyResponseHeader: Mutually exclusive with all other properties |
originGroupOverride OriginGroupOverrideAction_STATUS |
OriginGroupOverride: Mutually exclusive with all other properties |
routeConfigurationOverride DeliveryRuleRouteConfigurationOverrideAction_STATUS |
RouteConfigurationOverride: Mutually exclusive with all other properties |
urlRedirect UrlRedirectAction_STATUS |
UrlRedirect: Mutually exclusive with all other properties |
urlRewrite UrlRewriteAction_STATUS |
UrlRewrite: Mutually exclusive with all other properties |
urlSigning UrlSigningAction_STATUS |
UrlSigning: Mutually exclusive with all other properties |
DeliveryRuleCacheExpirationAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name DeliveryRuleCacheExpirationAction_Name |
Name: The name of the action for the delivery rule. |
parameters CacheExpirationActionParameters |
Parameters: Defines the parameters for the action. |
DeliveryRuleCacheExpirationAction_Name
(string
alias)
(Appears on:DeliveryRuleCacheExpirationAction)
Value | Description |
---|---|
"CacheExpiration" |
DeliveryRuleCacheExpirationAction_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleCacheExpirationAction_STATUS)
Value | Description |
---|---|
"CacheExpiration" |
DeliveryRuleCacheExpirationAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name DeliveryRuleCacheExpirationAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters CacheExpirationActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
DeliveryRuleCacheKeyQueryStringAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name DeliveryRuleCacheKeyQueryStringAction_Name |
Name: The name of the action for the delivery rule. |
parameters CacheKeyQueryStringActionParameters |
Parameters: Defines the parameters for the action. |
DeliveryRuleCacheKeyQueryStringAction_Name
(string
alias)
(Appears on:DeliveryRuleCacheKeyQueryStringAction)
Value | Description |
---|---|
"CacheKeyQueryString" |
DeliveryRuleCacheKeyQueryStringAction_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleCacheKeyQueryStringAction_STATUS)
Value | Description |
---|---|
"CacheKeyQueryString" |
DeliveryRuleCacheKeyQueryStringAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name DeliveryRuleCacheKeyQueryStringAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters CacheKeyQueryStringActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
DeliveryRuleClientPortCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleClientPortCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters ClientPortMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleClientPortCondition_Name
(string
alias)
(Appears on:DeliveryRuleClientPortCondition)
Value | Description |
---|---|
"ClientPort" |
DeliveryRuleClientPortCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleClientPortCondition_STATUS)
Value | Description |
---|---|
"ClientPort" |
DeliveryRuleClientPortCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleClientPortCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters ClientPortMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleCondition
(Appears on:Rule_Spec)
A condition for the delivery rule.
Field | Description |
---|---|
clientPort DeliveryRuleClientPortCondition |
ClientPort: Mutually exclusive with all other properties |
cookies DeliveryRuleCookiesCondition |
Cookies: Mutually exclusive with all other properties |
hostName DeliveryRuleHostNameCondition |
HostName: Mutually exclusive with all other properties |
httpVersion DeliveryRuleHttpVersionCondition |
HttpVersion: Mutually exclusive with all other properties |
isDevice DeliveryRuleIsDeviceCondition |
IsDevice: Mutually exclusive with all other properties |
postArgs DeliveryRulePostArgsCondition |
PostArgs: Mutually exclusive with all other properties |
queryString DeliveryRuleQueryStringCondition |
QueryString: Mutually exclusive with all other properties |
remoteAddress DeliveryRuleRemoteAddressCondition |
RemoteAddress: Mutually exclusive with all other properties |
requestBody DeliveryRuleRequestBodyCondition |
RequestBody: Mutually exclusive with all other properties |
requestHeader DeliveryRuleRequestHeaderCondition |
RequestHeader: Mutually exclusive with all other properties |
requestMethod DeliveryRuleRequestMethodCondition |
RequestMethod: Mutually exclusive with all other properties |
requestScheme DeliveryRuleRequestSchemeCondition |
RequestScheme: Mutually exclusive with all other properties |
requestUri DeliveryRuleRequestUriCondition |
RequestUri: Mutually exclusive with all other properties |
serverPort DeliveryRuleServerPortCondition |
ServerPort: Mutually exclusive with all other properties |
socketAddr DeliveryRuleSocketAddrCondition |
SocketAddr: Mutually exclusive with all other properties |
sslProtocol DeliveryRuleSslProtocolCondition |
SslProtocol: Mutually exclusive with all other properties |
urlFileExtension DeliveryRuleUrlFileExtensionCondition |
UrlFileExtension: Mutually exclusive with all other properties |
urlFileName DeliveryRuleUrlFileNameCondition |
UrlFileName: Mutually exclusive with all other properties |
urlPath DeliveryRuleUrlPathCondition |
UrlPath: Mutually exclusive with all other properties |
DeliveryRuleCondition_STATUS
(Appears on:Rule_STATUS)
A condition for the delivery rule.
Field | Description |
---|---|
clientPort DeliveryRuleClientPortCondition_STATUS |
ClientPort: Mutually exclusive with all other properties |
cookies DeliveryRuleCookiesCondition_STATUS |
Cookies: Mutually exclusive with all other properties |
hostName DeliveryRuleHostNameCondition_STATUS |
HostName: Mutually exclusive with all other properties |
httpVersion DeliveryRuleHttpVersionCondition_STATUS |
HttpVersion: Mutually exclusive with all other properties |
isDevice DeliveryRuleIsDeviceCondition_STATUS |
IsDevice: Mutually exclusive with all other properties |
postArgs DeliveryRulePostArgsCondition_STATUS |
PostArgs: Mutually exclusive with all other properties |
queryString DeliveryRuleQueryStringCondition_STATUS |
QueryString: Mutually exclusive with all other properties |
remoteAddress DeliveryRuleRemoteAddressCondition_STATUS |
RemoteAddress: Mutually exclusive with all other properties |
requestBody DeliveryRuleRequestBodyCondition_STATUS |
RequestBody: Mutually exclusive with all other properties |
requestHeader DeliveryRuleRequestHeaderCondition_STATUS |
RequestHeader: Mutually exclusive with all other properties |
requestMethod DeliveryRuleRequestMethodCondition_STATUS |
RequestMethod: Mutually exclusive with all other properties |
requestScheme DeliveryRuleRequestSchemeCondition_STATUS |
RequestScheme: Mutually exclusive with all other properties |
requestUri DeliveryRuleRequestUriCondition_STATUS |
RequestUri: Mutually exclusive with all other properties |
serverPort DeliveryRuleServerPortCondition_STATUS |
ServerPort: Mutually exclusive with all other properties |
socketAddr DeliveryRuleSocketAddrCondition_STATUS |
SocketAddr: Mutually exclusive with all other properties |
sslProtocol DeliveryRuleSslProtocolCondition_STATUS |
SslProtocol: Mutually exclusive with all other properties |
urlFileExtension DeliveryRuleUrlFileExtensionCondition_STATUS |
UrlFileExtension: Mutually exclusive with all other properties |
urlFileName DeliveryRuleUrlFileNameCondition_STATUS |
UrlFileName: Mutually exclusive with all other properties |
urlPath DeliveryRuleUrlPathCondition_STATUS |
UrlPath: Mutually exclusive with all other properties |
DeliveryRuleCookiesCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleCookiesCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters CookiesMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleCookiesCondition_Name
(string
alias)
(Appears on:DeliveryRuleCookiesCondition)
Value | Description |
---|---|
"Cookies" |
DeliveryRuleCookiesCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleCookiesCondition_STATUS)
Value | Description |
---|---|
"Cookies" |
DeliveryRuleCookiesCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleCookiesCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters CookiesMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleHostNameCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleHostNameCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters HostNameMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleHostNameCondition_Name
(string
alias)
(Appears on:DeliveryRuleHostNameCondition)
Value | Description |
---|---|
"HostName" |
DeliveryRuleHostNameCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleHostNameCondition_STATUS)
Value | Description |
---|---|
"HostName" |
DeliveryRuleHostNameCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleHostNameCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters HostNameMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleHttpVersionCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleHttpVersionCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters HttpVersionMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleHttpVersionCondition_Name
(string
alias)
(Appears on:DeliveryRuleHttpVersionCondition)
Value | Description |
---|---|
"HttpVersion" |
DeliveryRuleHttpVersionCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleHttpVersionCondition_STATUS)
Value | Description |
---|---|
"HttpVersion" |
DeliveryRuleHttpVersionCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleHttpVersionCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters HttpVersionMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleIsDeviceCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleIsDeviceCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters IsDeviceMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleIsDeviceCondition_Name
(string
alias)
(Appears on:DeliveryRuleIsDeviceCondition)
Value | Description |
---|---|
"IsDevice" |
DeliveryRuleIsDeviceCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleIsDeviceCondition_STATUS)
Value | Description |
---|---|
"IsDevice" |
DeliveryRuleIsDeviceCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleIsDeviceCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters IsDeviceMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRulePostArgsCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRulePostArgsCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters PostArgsMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRulePostArgsCondition_Name
(string
alias)
(Appears on:DeliveryRulePostArgsCondition)
Value | Description |
---|---|
"PostArgs" |
DeliveryRulePostArgsCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRulePostArgsCondition_STATUS)
Value | Description |
---|---|
"PostArgs" |
DeliveryRulePostArgsCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRulePostArgsCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters PostArgsMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleQueryStringCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleQueryStringCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters QueryStringMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleQueryStringCondition_Name
(string
alias)
(Appears on:DeliveryRuleQueryStringCondition)
Value | Description |
---|---|
"QueryString" |
DeliveryRuleQueryStringCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleQueryStringCondition_STATUS)
Value | Description |
---|---|
"QueryString" |
DeliveryRuleQueryStringCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleQueryStringCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters QueryStringMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRemoteAddressCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleRemoteAddressCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters RemoteAddressMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRemoteAddressCondition_Name
(string
alias)
(Appears on:DeliveryRuleRemoteAddressCondition)
Value | Description |
---|---|
"RemoteAddress" |
DeliveryRuleRemoteAddressCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleRemoteAddressCondition_STATUS)
Value | Description |
---|---|
"RemoteAddress" |
DeliveryRuleRemoteAddressCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleRemoteAddressCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters RemoteAddressMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestBodyCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleRequestBodyCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters RequestBodyMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestBodyCondition_Name
(string
alias)
(Appears on:DeliveryRuleRequestBodyCondition)
Value | Description |
---|---|
"RequestBody" |
DeliveryRuleRequestBodyCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleRequestBodyCondition_STATUS)
Value | Description |
---|---|
"RequestBody" |
DeliveryRuleRequestBodyCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleRequestBodyCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters RequestBodyMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestHeaderAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name DeliveryRuleRequestHeaderAction_Name |
Name: The name of the action for the delivery rule. |
parameters HeaderActionParameters |
Parameters: Defines the parameters for the action. |
DeliveryRuleRequestHeaderAction_Name
(string
alias)
(Appears on:DeliveryRuleRequestHeaderAction)
Value | Description |
---|---|
"ModifyRequestHeader" |
DeliveryRuleRequestHeaderAction_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleRequestHeaderAction_STATUS)
Value | Description |
---|---|
"ModifyRequestHeader" |
DeliveryRuleRequestHeaderAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name DeliveryRuleRequestHeaderAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters HeaderActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
DeliveryRuleRequestHeaderCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleRequestHeaderCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters RequestHeaderMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestHeaderCondition_Name
(string
alias)
(Appears on:DeliveryRuleRequestHeaderCondition)
Value | Description |
---|---|
"RequestHeader" |
DeliveryRuleRequestHeaderCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleRequestHeaderCondition_STATUS)
Value | Description |
---|---|
"RequestHeader" |
DeliveryRuleRequestHeaderCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleRequestHeaderCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters RequestHeaderMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestMethodCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleRequestMethodCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters RequestMethodMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestMethodCondition_Name
(string
alias)
(Appears on:DeliveryRuleRequestMethodCondition)
Value | Description |
---|---|
"RequestMethod" |
DeliveryRuleRequestMethodCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleRequestMethodCondition_STATUS)
Value | Description |
---|---|
"RequestMethod" |
DeliveryRuleRequestMethodCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleRequestMethodCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters RequestMethodMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestSchemeCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleRequestSchemeCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters RequestSchemeMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestSchemeCondition_Name
(string
alias)
(Appears on:DeliveryRuleRequestSchemeCondition)
Value | Description |
---|---|
"RequestScheme" |
DeliveryRuleRequestSchemeCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleRequestSchemeCondition_STATUS)
Value | Description |
---|---|
"RequestScheme" |
DeliveryRuleRequestSchemeCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleRequestSchemeCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters RequestSchemeMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestUriCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleRequestUriCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters RequestUriMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleRequestUriCondition_Name
(string
alias)
(Appears on:DeliveryRuleRequestUriCondition)
Value | Description |
---|---|
"RequestUri" |
DeliveryRuleRequestUriCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleRequestUriCondition_STATUS)
Value | Description |
---|---|
"RequestUri" |
DeliveryRuleRequestUriCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleRequestUriCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters RequestUriMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleResponseHeaderAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name DeliveryRuleResponseHeaderAction_Name |
Name: The name of the action for the delivery rule. |
parameters HeaderActionParameters |
Parameters: Defines the parameters for the action. |
DeliveryRuleResponseHeaderAction_Name
(string
alias)
(Appears on:DeliveryRuleResponseHeaderAction)
Value | Description |
---|---|
"ModifyResponseHeader" |
DeliveryRuleResponseHeaderAction_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleResponseHeaderAction_STATUS)
Value | Description |
---|---|
"ModifyResponseHeader" |
DeliveryRuleResponseHeaderAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name DeliveryRuleResponseHeaderAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters HeaderActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
DeliveryRuleRouteConfigurationOverrideAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name DeliveryRuleRouteConfigurationOverrideAction_Name |
Name: The name of the action for the delivery rule. |
parameters RouteConfigurationOverrideActionParameters |
Parameters: Defines the parameters for the action. |
DeliveryRuleRouteConfigurationOverrideAction_Name
(string
alias)
(Appears on:DeliveryRuleRouteConfigurationOverrideAction)
Value | Description |
---|---|
"RouteConfigurationOverride" |
DeliveryRuleRouteConfigurationOverrideAction_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleRouteConfigurationOverrideAction_STATUS)
Value | Description |
---|---|
"RouteConfigurationOverride" |
DeliveryRuleRouteConfigurationOverrideAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name DeliveryRuleRouteConfigurationOverrideAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters RouteConfigurationOverrideActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
DeliveryRuleServerPortCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleServerPortCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters ServerPortMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleServerPortCondition_Name
(string
alias)
(Appears on:DeliveryRuleServerPortCondition)
Value | Description |
---|---|
"ServerPort" |
DeliveryRuleServerPortCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleServerPortCondition_STATUS)
Value | Description |
---|---|
"ServerPort" |
DeliveryRuleServerPortCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleServerPortCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters ServerPortMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleSocketAddrCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleSocketAddrCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters SocketAddrMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleSocketAddrCondition_Name
(string
alias)
(Appears on:DeliveryRuleSocketAddrCondition)
Value | Description |
---|---|
"SocketAddr" |
DeliveryRuleSocketAddrCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleSocketAddrCondition_STATUS)
Value | Description |
---|---|
"SocketAddr" |
DeliveryRuleSocketAddrCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleSocketAddrCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters SocketAddrMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleSslProtocolCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleSslProtocolCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters SslProtocolMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleSslProtocolCondition_Name
(string
alias)
(Appears on:DeliveryRuleSslProtocolCondition)
Value | Description |
---|---|
"SslProtocol" |
DeliveryRuleSslProtocolCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleSslProtocolCondition_STATUS)
Value | Description |
---|---|
"SslProtocol" |
DeliveryRuleSslProtocolCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleSslProtocolCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters SslProtocolMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleUrlFileExtensionCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleUrlFileExtensionCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters UrlFileExtensionMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleUrlFileExtensionCondition_Name
(string
alias)
(Appears on:DeliveryRuleUrlFileExtensionCondition)
Value | Description |
---|---|
"UrlFileExtension" |
DeliveryRuleUrlFileExtensionCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleUrlFileExtensionCondition_STATUS)
Value | Description |
---|---|
"UrlFileExtension" |
DeliveryRuleUrlFileExtensionCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleUrlFileExtensionCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters UrlFileExtensionMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleUrlFileNameCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleUrlFileNameCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters UrlFileNameMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleUrlFileNameCondition_Name
(string
alias)
(Appears on:DeliveryRuleUrlFileNameCondition)
Value | Description |
---|---|
"UrlFileName" |
DeliveryRuleUrlFileNameCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleUrlFileNameCondition_STATUS)
Value | Description |
---|---|
"UrlFileName" |
DeliveryRuleUrlFileNameCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleUrlFileNameCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters UrlFileNameMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DeliveryRuleUrlPathCondition
(Appears on:DeliveryRuleCondition)
Field | Description |
---|---|
name DeliveryRuleUrlPathCondition_Name |
Name: The name of the condition for the delivery rule. |
parameters UrlPathMatchConditionParameters |
Parameters: Defines the parameters for the condition. |
DeliveryRuleUrlPathCondition_Name
(string
alias)
(Appears on:DeliveryRuleUrlPathCondition)
Value | Description |
---|---|
"UrlPath" |
DeliveryRuleUrlPathCondition_Name_STATUS
(string
alias)
(Appears on:DeliveryRuleUrlPathCondition_STATUS)
Value | Description |
---|---|
"UrlPath" |
DeliveryRuleUrlPathCondition_STATUS
(Appears on:DeliveryRuleCondition_STATUS)
Field | Description |
---|---|
name DeliveryRuleUrlPathCondition_Name_STATUS |
Name: The name of the condition for the delivery rule. |
parameters UrlPathMatchConditionParameters_STATUS |
Parameters: Defines the parameters for the condition. |
DomainValidationProperties_STATUS
(Appears on:AfdCustomDomain_STATUS)
The JSON object that contains the properties to validate a domain.
Field | Description |
---|---|
expirationDate string |
ExpirationDate: The date time that the token expires |
validationToken string |
ValidationToken: Challenge used for DNS TXT record or file based validation |
HeaderActionParameters
(Appears on:DeliveryRuleRequestHeaderAction, DeliveryRuleResponseHeaderAction)
Defines the parameters for the request header action.
Field | Description |
---|---|
headerAction HeaderActionParameters_HeaderAction |
HeaderAction: Action to perform |
headerName string |
HeaderName: Name of the header to modify |
typeName HeaderActionParameters_TypeName |
|
value string |
Value: Value for the specified action |
HeaderActionParameters_HeaderAction
(string
alias)
(Appears on:HeaderActionParameters)
Value | Description |
---|---|
"Append" |
|
"Delete" |
|
"Overwrite" |
HeaderActionParameters_HeaderAction_STATUS
(string
alias)
(Appears on:HeaderActionParameters_STATUS)
Value | Description |
---|---|
"Append" |
|
"Delete" |
|
"Overwrite" |
HeaderActionParameters_STATUS
(Appears on:DeliveryRuleRequestHeaderAction_STATUS, DeliveryRuleResponseHeaderAction_STATUS)
Defines the parameters for the request header action.
Field | Description |
---|---|
headerAction HeaderActionParameters_HeaderAction_STATUS |
HeaderAction: Action to perform |
headerName string |
HeaderName: Name of the header to modify |
typeName HeaderActionParameters_TypeName_STATUS |
|
value string |
Value: Value for the specified action |
HeaderActionParameters_TypeName
(string
alias)
(Appears on:HeaderActionParameters)
Value | Description |
---|---|
"DeliveryRuleHeaderActionParameters" |
HeaderActionParameters_TypeName_STATUS
(string
alias)
(Appears on:HeaderActionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleHeaderActionParameters" |
HealthProbeParameters
(Appears on:AfdOriginGroup_Spec)
The JSON object that contains the properties to send health probes to origin.
Field | Description |
---|---|
probeIntervalInSeconds int |
ProbeIntervalInSeconds: The number of seconds between health probes.Default is 240sec. |
probePath string |
ProbePath: The path relative to the origin that is used to determine the health of the origin. |
probeProtocol HealthProbeParameters_ProbeProtocol |
ProbeProtocol: Protocol to use for health probe. |
probeRequestType HealthProbeParameters_ProbeRequestType |
ProbeRequestType: The type of health probe request that is made. |
HealthProbeParameters_ProbeProtocol
(string
alias)
(Appears on:HealthProbeParameters)
Value | Description |
---|---|
"Http" |
|
"Https" |
|
"NotSet" |
HealthProbeParameters_ProbeProtocol_STATUS
(string
alias)
(Appears on:HealthProbeParameters_STATUS)
Value | Description |
---|---|
"Http" |
|
"Https" |
|
"NotSet" |
HealthProbeParameters_ProbeRequestType
(string
alias)
(Appears on:HealthProbeParameters)
Value | Description |
---|---|
"GET" |
|
"HEAD" |
|
"NotSet" |
HealthProbeParameters_ProbeRequestType_STATUS
(string
alias)
(Appears on:HealthProbeParameters_STATUS)
Value | Description |
---|---|
"GET" |
|
"HEAD" |
|
"NotSet" |
HealthProbeParameters_STATUS
(Appears on:AfdOriginGroup_STATUS)
The JSON object that contains the properties to send health probes to origin.
Field | Description |
---|---|
probeIntervalInSeconds int |
ProbeIntervalInSeconds: The number of seconds between health probes.Default is 240sec. |
probePath string |
ProbePath: The path relative to the origin that is used to determine the health of the origin. |
probeProtocol HealthProbeParameters_ProbeProtocol_STATUS |
ProbeProtocol: Protocol to use for health probe. |
probeRequestType HealthProbeParameters_ProbeRequestType_STATUS |
ProbeRequestType: The type of health probe request that is made. |
HostNameMatchConditionParameters
(Appears on:DeliveryRuleHostNameCondition)
Defines the parameters for HostName match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator HostNameMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName HostNameMatchConditionParameters_TypeName |
HostNameMatchConditionParameters_Operator
(string
alias)
(Appears on:HostNameMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
HostNameMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:HostNameMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
HostNameMatchConditionParameters_STATUS
(Appears on:DeliveryRuleHostNameCondition_STATUS)
Defines the parameters for HostName match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator HostNameMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName HostNameMatchConditionParameters_TypeName_STATUS |
HostNameMatchConditionParameters_TypeName
(string
alias)
(Appears on:HostNameMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleHostNameConditionParameters" |
HostNameMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:HostNameMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleHostNameConditionParameters" |
HttpVersionMatchConditionParameters
(Appears on:DeliveryRuleHttpVersionCondition)
Defines the parameters for HttpVersion match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator HttpVersionMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName HttpVersionMatchConditionParameters_TypeName |
HttpVersionMatchConditionParameters_Operator
(string
alias)
(Appears on:HttpVersionMatchConditionParameters)
Value | Description |
---|---|
"Equal" |
HttpVersionMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:HttpVersionMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Equal" |
HttpVersionMatchConditionParameters_STATUS
(Appears on:DeliveryRuleHttpVersionCondition_STATUS)
Defines the parameters for HttpVersion match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator HttpVersionMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName HttpVersionMatchConditionParameters_TypeName_STATUS |
HttpVersionMatchConditionParameters_TypeName
(string
alias)
(Appears on:HttpVersionMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleHttpVersionConditionParameters" |
HttpVersionMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:HttpVersionMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleHttpVersionConditionParameters" |
IdentityType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
The type of identity that creates/modifies resources
Value | Description |
---|---|
"application" |
|
"key" |
|
"managedIdentity" |
|
"user" |
IsDeviceMatchConditionParameters
(Appears on:DeliveryRuleIsDeviceCondition)
Defines the parameters for IsDevice match conditions
Field | Description |
---|---|
matchValues []IsDeviceMatchConditionParameters_MatchValues |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator IsDeviceMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName IsDeviceMatchConditionParameters_TypeName |
IsDeviceMatchConditionParameters_MatchValues
(string
alias)
(Appears on:IsDeviceMatchConditionParameters)
Value | Description |
---|---|
"Desktop" |
|
"Mobile" |
IsDeviceMatchConditionParameters_MatchValues_STATUS
(string
alias)
(Appears on:IsDeviceMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Desktop" |
|
"Mobile" |
IsDeviceMatchConditionParameters_Operator
(string
alias)
(Appears on:IsDeviceMatchConditionParameters)
Value | Description |
---|---|
"Equal" |
IsDeviceMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:IsDeviceMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Equal" |
IsDeviceMatchConditionParameters_STATUS
(Appears on:DeliveryRuleIsDeviceCondition_STATUS)
Defines the parameters for IsDevice match conditions
Field | Description |
---|---|
matchValues []IsDeviceMatchConditionParameters_MatchValues_STATUS |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator IsDeviceMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName IsDeviceMatchConditionParameters_TypeName_STATUS |
IsDeviceMatchConditionParameters_TypeName
(string
alias)
(Appears on:IsDeviceMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleIsDeviceConditionParameters" |
IsDeviceMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:IsDeviceMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleIsDeviceConditionParameters" |
LoadBalancingSettingsParameters
(Appears on:AfdOriginGroup_Spec)
Round-Robin load balancing settings for a backend pool
Field | Description |
---|---|
additionalLatencyInMilliseconds int |
AdditionalLatencyInMilliseconds: The additional latency in milliseconds for probes to fall into the lowest latency bucket |
sampleSize int |
SampleSize: The number of samples to consider for load balancing decisions |
successfulSamplesRequired int |
SuccessfulSamplesRequired: The number of samples within the sample period that must succeed |
LoadBalancingSettingsParameters_STATUS
(Appears on:AfdOriginGroup_STATUS)
Round-Robin load balancing settings for a backend pool
Field | Description |
---|---|
additionalLatencyInMilliseconds int |
AdditionalLatencyInMilliseconds: The additional latency in milliseconds for probes to fall into the lowest latency bucket |
sampleSize int |
SampleSize: The number of samples to consider for load balancing decisions |
successfulSamplesRequired int |
SuccessfulSamplesRequired: The number of samples within the sample period that must succeed |
ManagedCertificateParameters
(Appears on:SecretParameters)
Field | Description |
---|---|
type ManagedCertificateParameters_Type |
ManagedCertificateParameters_STATUS
(Appears on:SecretParameters_STATUS)
Field | Description |
---|---|
expirationDate string |
ExpirationDate: Certificate expiration date. |
subject string |
Subject: Subject name in the certificate. |
type ManagedCertificateParameters_Type_STATUS |
ManagedCertificateParameters_Type
(string
alias)
(Appears on:ManagedCertificateParameters)
Value | Description |
---|---|
"ManagedCertificate" |
ManagedCertificateParameters_Type_STATUS
(string
alias)
(Appears on:ManagedCertificateParameters_STATUS)
Value | Description |
---|---|
"ManagedCertificate" |
ManagedServiceIdentity
(Appears on:Profile_Spec)
Managed service identity (system assigned and/or user assigned identities)
Field | Description |
---|---|
type ManagedServiceIdentityType |
Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
userAssignedIdentities []UserAssignedIdentityDetails |
ManagedServiceIdentityType
(string
alias)
(Appears on:ManagedServiceIdentity)
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentityType_STATUS
(string
alias)
(Appears on:ManagedServiceIdentity_STATUS)
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned, UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentity_STATUS
(Appears on:Profile_STATUS)
Managed service identity (system assigned and/or user assigned identities)
Field | Description |
---|---|
principalId string |
PrincipalId: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId string |
TenantId: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
type ManagedServiceIdentityType_STATUS |
Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
userAssignedIdentities map[string]./api/cdn/v1api20230501.UserAssignedIdentity_STATUS |
OriginGroupOverride
(Appears on:RouteConfigurationOverrideActionParameters)
Defines the parameters for the origin group override configuration.
Field | Description |
---|---|
forwardingProtocol OriginGroupOverride_ForwardingProtocol |
ForwardingProtocol: Protocol this rule will use when forwarding traffic to backends. |
originGroup ResourceReference |
OriginGroup: defines the OriginGroup that would override the DefaultOriginGroup on route. |
OriginGroupOverrideAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name OriginGroupOverrideAction_Name |
Name: The name of the action for the delivery rule. |
parameters OriginGroupOverrideActionParameters |
Parameters: Defines the parameters for the action. |
OriginGroupOverrideActionParameters
(Appears on:OriginGroupOverrideAction)
Defines the parameters for the origin group override action.
Field | Description |
---|---|
originGroup ResourceReference |
OriginGroup: defines the OriginGroup that would override the DefaultOriginGroup. |
typeName OriginGroupOverrideActionParameters_TypeName |
OriginGroupOverrideActionParameters_STATUS
(Appears on:OriginGroupOverrideAction_STATUS)
Defines the parameters for the origin group override action.
Field | Description |
---|---|
originGroup ResourceReference_STATUS |
OriginGroup: defines the OriginGroup that would override the DefaultOriginGroup. |
typeName OriginGroupOverrideActionParameters_TypeName_STATUS |
OriginGroupOverrideActionParameters_TypeName
(string
alias)
(Appears on:OriginGroupOverrideActionParameters)
Value | Description |
---|---|
"DeliveryRuleOriginGroupOverrideActionParameters" |
OriginGroupOverrideActionParameters_TypeName_STATUS
(string
alias)
(Appears on:OriginGroupOverrideActionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleOriginGroupOverrideActionParameters" |
OriginGroupOverrideAction_Name
(string
alias)
(Appears on:OriginGroupOverrideAction)
Value | Description |
---|---|
"OriginGroupOverride" |
OriginGroupOverrideAction_Name_STATUS
(string
alias)
(Appears on:OriginGroupOverrideAction_STATUS)
Value | Description |
---|---|
"OriginGroupOverride" |
OriginGroupOverrideAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name OriginGroupOverrideAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters OriginGroupOverrideActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
OriginGroupOverride_ForwardingProtocol
(string
alias)
(Appears on:OriginGroupOverride)
Value | Description |
---|---|
"HttpOnly" |
|
"HttpsOnly" |
|
"MatchRequest" |
OriginGroupOverride_ForwardingProtocol_STATUS
(string
alias)
(Appears on:OriginGroupOverride_STATUS)
Value | Description |
---|---|
"HttpOnly" |
|
"HttpsOnly" |
|
"MatchRequest" |
OriginGroupOverride_STATUS
(Appears on:RouteConfigurationOverrideActionParameters_STATUS)
Defines the parameters for the origin group override configuration.
Field | Description |
---|---|
forwardingProtocol OriginGroupOverride_ForwardingProtocol_STATUS |
ForwardingProtocol: Protocol this rule will use when forwarding traffic to backends. |
originGroup ResourceReference_STATUS |
OriginGroup: defines the OriginGroup that would override the DefaultOriginGroup on route. |
PostArgsMatchConditionParameters
(Appears on:DeliveryRulePostArgsCondition)
Defines the parameters for PostArgs match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator PostArgsMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
selector string |
Selector: Name of PostArg to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName PostArgsMatchConditionParameters_TypeName |
PostArgsMatchConditionParameters_Operator
(string
alias)
(Appears on:PostArgsMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
PostArgsMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:PostArgsMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
PostArgsMatchConditionParameters_STATUS
(Appears on:DeliveryRulePostArgsCondition_STATUS)
Defines the parameters for PostArgs match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator PostArgsMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
selector string |
Selector: Name of PostArg to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName PostArgsMatchConditionParameters_TypeName_STATUS |
PostArgsMatchConditionParameters_TypeName
(string
alias)
(Appears on:PostArgsMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRulePostArgsConditionParameters" |
PostArgsMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:PostArgsMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRulePostArgsConditionParameters" |
Profile
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/cdn.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}p>
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||
spec Profile_Spec |
|
||||||||||||||||
status Profile_STATUS |
ProfileOperatorSpec
(Appears on:Profile_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
ProfileProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:Profile_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
ProfileProperties_ResourceState_STATUS
(string
alias)
(Appears on:Profile_STATUS)
Value | Description |
---|---|
"AbortingMigration" |
|
"Active" |
|
"CommittingMigration" |
|
"Creating" |
|
"Deleting" |
|
"Disabled" |
|
"Migrated" |
|
"Migrating" |
|
"PendingMigrationCommit" |
Profile_STATUS
(Appears on:Profile)
A profile is a logical grouping of endpoints that share the same settings.
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
extendedProperties map[string]string |
ExtendedProperties: Key-Value pair representing additional properties for profiles. |
frontDoorId string |
FrontDoorId: The Id of the frontdoor. |
id string |
Id: Resource ID. |
identity ManagedServiceIdentity_STATUS |
Identity: Managed service identity (system assigned and/or user assigned identities). |
kind string |
Kind: Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile. |
location string |
Location: Resource location. |
name string |
Name: Resource name. |
originResponseTimeoutSeconds int |
OriginResponseTimeoutSeconds: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. |
provisioningState ProfileProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status of the profile. |
resourceState ProfileProperties_ResourceState_STATUS |
ResourceState: Resource status of the profile. |
sku Sku_STATUS |
Sku: The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. |
systemData SystemData_STATUS |
SystemData: Read only system data |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: Resource type. |
Profile_Spec
(Appears on:Profile)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
identity ManagedServiceIdentity |
Identity: Managed service identity (system assigned and/or user assigned identities). |
location string |
Location: Resource location. |
operatorSpec ProfileOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
originResponseTimeoutSeconds int |
OriginResponseTimeoutSeconds: Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
sku Sku |
Sku: The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile. |
tags map[string]string |
Tags: Resource tags. |
QueryStringMatchConditionParameters
(Appears on:DeliveryRuleQueryStringCondition)
Defines the parameters for QueryString match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator QueryStringMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName QueryStringMatchConditionParameters_TypeName |
QueryStringMatchConditionParameters_Operator
(string
alias)
(Appears on:QueryStringMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
QueryStringMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:QueryStringMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
QueryStringMatchConditionParameters_STATUS
(Appears on:DeliveryRuleQueryStringCondition_STATUS)
Defines the parameters for QueryString match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator QueryStringMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName QueryStringMatchConditionParameters_TypeName_STATUS |
QueryStringMatchConditionParameters_TypeName
(string
alias)
(Appears on:QueryStringMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleQueryStringConditionParameters" |
QueryStringMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:QueryStringMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleQueryStringConditionParameters" |
RemoteAddressMatchConditionParameters
(Appears on:DeliveryRuleRemoteAddressCondition)
Defines the parameters for RemoteAddress match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match. |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RemoteAddressMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName RemoteAddressMatchConditionParameters_TypeName |
RemoteAddressMatchConditionParameters_Operator
(string
alias)
(Appears on:RemoteAddressMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"GeoMatch" |
|
"IPMatch" |
RemoteAddressMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:RemoteAddressMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"GeoMatch" |
|
"IPMatch" |
RemoteAddressMatchConditionParameters_STATUS
(Appears on:DeliveryRuleRemoteAddressCondition_STATUS)
Defines the parameters for RemoteAddress match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match. |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RemoteAddressMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName RemoteAddressMatchConditionParameters_TypeName_STATUS |
RemoteAddressMatchConditionParameters_TypeName
(string
alias)
(Appears on:RemoteAddressMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleRemoteAddressConditionParameters" |
RemoteAddressMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:RemoteAddressMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleRemoteAddressConditionParameters" |
RequestBodyMatchConditionParameters
(Appears on:DeliveryRuleRequestBodyCondition)
Defines the parameters for RequestBody match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestBodyMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName RequestBodyMatchConditionParameters_TypeName |
RequestBodyMatchConditionParameters_Operator
(string
alias)
(Appears on:RequestBodyMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
RequestBodyMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:RequestBodyMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
RequestBodyMatchConditionParameters_STATUS
(Appears on:DeliveryRuleRequestBodyCondition_STATUS)
Defines the parameters for RequestBody match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestBodyMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName RequestBodyMatchConditionParameters_TypeName_STATUS |
RequestBodyMatchConditionParameters_TypeName
(string
alias)
(Appears on:RequestBodyMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleRequestBodyConditionParameters" |
RequestBodyMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:RequestBodyMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleRequestBodyConditionParameters" |
RequestHeaderMatchConditionParameters
(Appears on:DeliveryRuleRequestHeaderCondition)
Defines the parameters for RequestHeader match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestHeaderMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
selector string |
Selector: Name of Header to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName RequestHeaderMatchConditionParameters_TypeName |
RequestHeaderMatchConditionParameters_Operator
(string
alias)
(Appears on:RequestHeaderMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
RequestHeaderMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:RequestHeaderMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
RequestHeaderMatchConditionParameters_STATUS
(Appears on:DeliveryRuleRequestHeaderCondition_STATUS)
Defines the parameters for RequestHeader match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestHeaderMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
selector string |
Selector: Name of Header to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName RequestHeaderMatchConditionParameters_TypeName_STATUS |
RequestHeaderMatchConditionParameters_TypeName
(string
alias)
(Appears on:RequestHeaderMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleRequestHeaderConditionParameters" |
RequestHeaderMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:RequestHeaderMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleRequestHeaderConditionParameters" |
RequestMethodMatchConditionParameters
(Appears on:DeliveryRuleRequestMethodCondition)
Defines the parameters for RequestMethod match conditions
Field | Description |
---|---|
matchValues []RequestMethodMatchConditionParameters_MatchValues |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestMethodMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName RequestMethodMatchConditionParameters_TypeName |
RequestMethodMatchConditionParameters_MatchValues
(string
alias)
(Appears on:RequestMethodMatchConditionParameters)
Value | Description |
---|---|
"DELETE" |
|
"GET" |
|
"HEAD" |
|
"OPTIONS" |
|
"POST" |
|
"PUT" |
|
"TRACE" |
RequestMethodMatchConditionParameters_MatchValues_STATUS
(string
alias)
(Appears on:RequestMethodMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DELETE" |
|
"GET" |
|
"HEAD" |
|
"OPTIONS" |
|
"POST" |
|
"PUT" |
|
"TRACE" |
RequestMethodMatchConditionParameters_Operator
(string
alias)
(Appears on:RequestMethodMatchConditionParameters)
Value | Description |
---|---|
"Equal" |
RequestMethodMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:RequestMethodMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Equal" |
RequestMethodMatchConditionParameters_STATUS
(Appears on:DeliveryRuleRequestMethodCondition_STATUS)
Defines the parameters for RequestMethod match conditions
Field | Description |
---|---|
matchValues []RequestMethodMatchConditionParameters_MatchValues_STATUS |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestMethodMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName RequestMethodMatchConditionParameters_TypeName_STATUS |
RequestMethodMatchConditionParameters_TypeName
(string
alias)
(Appears on:RequestMethodMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleRequestMethodConditionParameters" |
RequestMethodMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:RequestMethodMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleRequestMethodConditionParameters" |
RequestSchemeMatchConditionParameters
(Appears on:DeliveryRuleRequestSchemeCondition)
Defines the parameters for RequestScheme match conditions
Field | Description |
---|---|
matchValues []RequestSchemeMatchConditionParameters_MatchValues |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestSchemeMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName RequestSchemeMatchConditionParameters_TypeName |
RequestSchemeMatchConditionParameters_MatchValues
(string
alias)
(Appears on:RequestSchemeMatchConditionParameters)
Value | Description |
---|---|
"HTTP" |
|
"HTTPS" |
RequestSchemeMatchConditionParameters_MatchValues_STATUS
(string
alias)
(Appears on:RequestSchemeMatchConditionParameters_STATUS)
Value | Description |
---|---|
"HTTP" |
|
"HTTPS" |
RequestSchemeMatchConditionParameters_Operator
(string
alias)
(Appears on:RequestSchemeMatchConditionParameters)
Value | Description |
---|---|
"Equal" |
RequestSchemeMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:RequestSchemeMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Equal" |
RequestSchemeMatchConditionParameters_STATUS
(Appears on:DeliveryRuleRequestSchemeCondition_STATUS)
Defines the parameters for RequestScheme match conditions
Field | Description |
---|---|
matchValues []RequestSchemeMatchConditionParameters_MatchValues_STATUS |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestSchemeMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName RequestSchemeMatchConditionParameters_TypeName_STATUS |
RequestSchemeMatchConditionParameters_TypeName
(string
alias)
(Appears on:RequestSchemeMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleRequestSchemeConditionParameters" |
RequestSchemeMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:RequestSchemeMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleRequestSchemeConditionParameters" |
RequestUriMatchConditionParameters
(Appears on:DeliveryRuleRequestUriCondition)
Defines the parameters for RequestUri match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestUriMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName RequestUriMatchConditionParameters_TypeName |
RequestUriMatchConditionParameters_Operator
(string
alias)
(Appears on:RequestUriMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
RequestUriMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:RequestUriMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
RequestUriMatchConditionParameters_STATUS
(Appears on:DeliveryRuleRequestUriCondition_STATUS)
Defines the parameters for RequestUri match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator RequestUriMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName RequestUriMatchConditionParameters_TypeName_STATUS |
RequestUriMatchConditionParameters_TypeName
(string
alias)
(Appears on:RequestUriMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleRequestUriConditionParameters" |
RequestUriMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:RequestUriMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleRequestUriConditionParameters" |
ResourceReference
(Appears on:AFDDomainHttpsParameters, AfdCustomDomain_Spec, AfdOrigin_Spec, CustomerCertificateParameters, OriginGroupOverride, OriginGroupOverrideActionParameters, Route_Spec, SecurityPolicyWebApplicationFirewallParameters, SharedPrivateLinkResourceProperties, UrlSigningKeyParameters)
Reference to another resource.
Field | Description |
---|---|
reference genruntime.ResourceReference |
Reference: Resource ID. |
ResourceReference_STATUS
(Appears on:AFDDomainHttpsParameters_STATUS, AfdCustomDomain_STATUS, AfdOrigin_STATUS, AzureFirstPartyManagedCertificateParameters_STATUS, CustomerCertificateParameters_STATUS, OriginGroupOverrideActionParameters_STATUS, OriginGroupOverride_STATUS, Route_STATUS, SecurityPolicyWebApplicationFirewallParameters_STATUS, SharedPrivateLinkResourceProperties_STATUS, UrlSigningKeyParameters_STATUS)
Reference to another resource.
Field | Description |
---|---|
id string |
Id: Resource ID. |
Route
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}p>
Field | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||
spec Route_Spec |
|
||||||||||||||||||||||||||||
status Route_STATUS |
RouteConfigurationOverrideActionParameters
(Appears on:DeliveryRuleRouteConfigurationOverrideAction)
Defines the parameters for the route configuration override action.
Field | Description |
---|---|
cacheConfiguration CacheConfiguration |
CacheConfiguration: The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object. |
originGroupOverride OriginGroupOverride |
OriginGroupOverride: A reference to the origin group override configuration. Leave empty to use the default origin group on route. |
typeName RouteConfigurationOverrideActionParameters_TypeName |
RouteConfigurationOverrideActionParameters_STATUS
(Appears on:DeliveryRuleRouteConfigurationOverrideAction_STATUS)
Defines the parameters for the route configuration override action.
Field | Description |
---|---|
cacheConfiguration CacheConfiguration_STATUS |
CacheConfiguration: The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object. |
originGroupOverride OriginGroupOverride_STATUS |
OriginGroupOverride: A reference to the origin group override configuration. Leave empty to use the default origin group on route. |
typeName RouteConfigurationOverrideActionParameters_TypeName_STATUS |
RouteConfigurationOverrideActionParameters_TypeName
(string
alias)
(Appears on:RouteConfigurationOverrideActionParameters)
Value | Description |
---|---|
"DeliveryRuleRouteConfigurationOverrideActionParameters" |
RouteConfigurationOverrideActionParameters_TypeName_STATUS
(string
alias)
(Appears on:RouteConfigurationOverrideActionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleRouteConfigurationOverrideActionParameters" |
RouteOperatorSpec
(Appears on:Route_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
RouteProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:Route_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
RouteProperties_EnabledState
(string
alias)
(Appears on:Route_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RouteProperties_EnabledState_STATUS
(string
alias)
(Appears on:Route_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RouteProperties_ForwardingProtocol
(string
alias)
(Appears on:Route_Spec)
Value | Description |
---|---|
"HttpOnly" |
|
"HttpsOnly" |
|
"MatchRequest" |
RouteProperties_ForwardingProtocol_STATUS
(string
alias)
(Appears on:Route_STATUS)
Value | Description |
---|---|
"HttpOnly" |
|
"HttpsOnly" |
|
"MatchRequest" |
RouteProperties_HttpsRedirect
(string
alias)
(Appears on:Route_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RouteProperties_HttpsRedirect_STATUS
(string
alias)
(Appears on:Route_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RouteProperties_LinkToDefaultDomain
(string
alias)
(Appears on:Route_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RouteProperties_LinkToDefaultDomain_STATUS
(string
alias)
(Appears on:Route_STATUS)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
RouteProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:Route_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
Route_STATUS
(Appears on:Route)
Field | Description |
---|---|
cacheConfiguration AfdRouteCacheConfiguration_STATUS |
CacheConfiguration: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
customDomains []ActivatedResourceReference_STATUS_Profiles_AfdEndpoints_Route_SubResourceEmbedded |
CustomDomains: Domains referenced by this endpoint. |
deploymentStatus RouteProperties_DeploymentStatus_STATUS |
|
enabledState RouteProperties_EnabledState_STATUS |
EnabledState: Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’ |
endpointName string |
EndpointName: The name of the endpoint which holds the route. |
forwardingProtocol RouteProperties_ForwardingProtocol_STATUS |
ForwardingProtocol: Protocol this rule will use when forwarding traffic to backends. |
httpsRedirect RouteProperties_HttpsRedirect_STATUS |
HttpsRedirect: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. |
id string |
Id: Resource ID. |
linkToDefaultDomain RouteProperties_LinkToDefaultDomain_STATUS |
LinkToDefaultDomain: whether this route will be linked to the default endpoint domain. |
name string |
Name: Resource name. |
originGroup ResourceReference_STATUS |
OriginGroup: A reference to the origin group. |
originPath string |
OriginPath: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. |
patternsToMatch []string |
PatternsToMatch: The route patterns of the rule. |
provisioningState RouteProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
ruleSets []ResourceReference_STATUS |
RuleSets: rule sets referenced by this endpoint. |
supportedProtocols []AFDEndpointProtocols_STATUS |
SupportedProtocols: List of supported protocols for this route. |
systemData SystemData_STATUS |
SystemData: Read only system data |
type string |
Type: Resource type. |
Route_Spec
(Appears on:Route)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
cacheConfiguration AfdRouteCacheConfiguration |
CacheConfiguration: The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object. |
customDomains []ActivatedResourceReference |
CustomDomains: Domains referenced by this endpoint. |
enabledState RouteProperties_EnabledState |
EnabledState: Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’ |
forwardingProtocol RouteProperties_ForwardingProtocol |
ForwardingProtocol: Protocol this rule will use when forwarding traffic to backends. |
httpsRedirect RouteProperties_HttpsRedirect |
HttpsRedirect: Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed. |
linkToDefaultDomain RouteProperties_LinkToDefaultDomain |
LinkToDefaultDomain: whether this route will be linked to the default endpoint domain. |
operatorSpec RouteOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
originGroup ResourceReference |
OriginGroup: A reference to the origin group. |
originPath string |
OriginPath: A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/AfdEndpoint resource |
patternsToMatch []string |
PatternsToMatch: The route patterns of the rule. |
ruleSets []ResourceReference |
RuleSets: rule sets referenced by this endpoint. |
supportedProtocols []AFDEndpointProtocols |
SupportedProtocols: List of supported protocols for this route. |
Rule
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}p>
Field | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
spec Rule_Spec |
|
||||||||||||||
status Rule_STATUS |
RuleOperatorSpec
(Appears on:Rule_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
RuleProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:Rule_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
RuleProperties_MatchProcessingBehavior
(string
alias)
(Appears on:Rule_Spec)
Value | Description |
---|---|
"Continue" |
|
"Stop" |
RuleProperties_MatchProcessingBehavior_STATUS
(string
alias)
(Appears on:Rule_STATUS)
Value | Description |
---|---|
"Continue" |
|
"Stop" |
RuleProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:Rule_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
RuleSet
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}p>
Field | Description | ||||||
---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
spec RuleSet_Spec |
|
||||||
status RuleSet_STATUS |
RuleSetOperatorSpec
(Appears on:RuleSet_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
RuleSetProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:RuleSet_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
RuleSetProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:RuleSet_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
RuleSet_STATUS
(Appears on:RuleSet)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deploymentStatus RuleSetProperties_DeploymentStatus_STATUS |
|
id string |
Id: Resource ID. |
name string |
Name: Resource name. |
profileName string |
ProfileName: The name of the profile which holds the rule set. |
provisioningState RuleSetProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
systemData SystemData_STATUS |
SystemData: Read only system data |
type string |
Type: Resource type. |
RuleSet_Spec
(Appears on:RuleSet)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
operatorSpec RuleSetOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/Profile resource |
Rule_STATUS
(Appears on:Rule)
Field | Description |
---|---|
actions []DeliveryRuleAction_STATUS |
Actions: A list of actions that are executed when all the conditions of a rule are satisfied. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deploymentStatus RuleProperties_DeploymentStatus_STATUS |
|
id string |
Id: Resource ID. |
matchProcessingBehavior RuleProperties_MatchProcessingBehavior_STATUS |
MatchProcessingBehavior: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. |
name string |
Name: Resource name. |
order int |
Order: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. |
provisioningState RuleProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
ruleconditions []DeliveryRuleCondition_STATUS |
RuleConditions: A list of conditions that must be matched for the actions to be executed |
ruleSetName string |
RuleSetName: The name of the rule set containing the rule. |
systemData SystemData_STATUS |
SystemData: Read only system data |
type string |
Type: Resource type. |
Rule_Spec
(Appears on:Rule)
Field | Description |
---|---|
actions []DeliveryRuleAction |
Actions: A list of actions that are executed when all the conditions of a rule are satisfied. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
matchProcessingBehavior RuleProperties_MatchProcessingBehavior |
MatchProcessingBehavior: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. |
operatorSpec RuleOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
order int |
Order: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/RuleSet resource |
ruleconditions []DeliveryRuleCondition |
RuleConditions: A list of conditions that must be matched for the actions to be executed |
Secret
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}p>
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec Secret_Spec |
|
||||||||
status Secret_STATUS |
SecretOperatorSpec
(Appears on:Secret_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
SecretParameters
(Appears on:Secret_Spec)
Field | Description |
---|---|
azureFirstPartyManagedCertificate AzureFirstPartyManagedCertificateParameters |
AzureFirstPartyManagedCertificate: Mutually exclusive with all other properties |
customerCertificate CustomerCertificateParameters |
CustomerCertificate: Mutually exclusive with all other properties |
managedCertificate ManagedCertificateParameters |
ManagedCertificate: Mutually exclusive with all other properties |
urlSigningKey UrlSigningKeyParameters |
UrlSigningKey: Mutually exclusive with all other properties |
SecretParameters_STATUS
(Appears on:Secret_STATUS)
Field | Description |
---|---|
azureFirstPartyManagedCertificate AzureFirstPartyManagedCertificateParameters_STATUS |
AzureFirstPartyManagedCertificate: Mutually exclusive with all other properties |
customerCertificate CustomerCertificateParameters_STATUS |
CustomerCertificate: Mutually exclusive with all other properties |
managedCertificate ManagedCertificateParameters_STATUS |
ManagedCertificate: Mutually exclusive with all other properties |
urlSigningKey UrlSigningKeyParameters_STATUS |
UrlSigningKey: Mutually exclusive with all other properties |
SecretProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:Secret_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
SecretProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:Secret_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
Secret_STATUS
(Appears on:Secret)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deploymentStatus SecretProperties_DeploymentStatus_STATUS |
|
id string |
Id: Resource ID. |
name string |
Name: Resource name. |
parameters SecretParameters_STATUS |
Parameters: object which contains secret parameters |
profileName string |
ProfileName: The name of the profile which holds the secret. |
provisioningState SecretProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
systemData SystemData_STATUS |
SystemData: Read only system data |
type string |
Type: Resource type. |
Secret_Spec
(Appears on:Secret)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
operatorSpec SecretOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/Profile resource |
parameters SecretParameters |
Parameters: object which contains secret parameters |
SecurityPolicy
Generator information: - Generated from: /cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/afdx.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}p>
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec SecurityPolicy_Spec |
|
||||||||
status SecurityPolicy_STATUS |
SecurityPolicyOperatorSpec
(Appears on:SecurityPolicy_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
SecurityPolicyPropertiesParameters
(Appears on:SecurityPolicy_Spec)
Field | Description |
---|---|
webApplicationFirewall SecurityPolicyWebApplicationFirewallParameters |
WebApplicationFirewall: Mutually exclusive with all other properties |
SecurityPolicyPropertiesParameters_STATUS
(Appears on:SecurityPolicy_STATUS)
Field | Description |
---|---|
webApplicationFirewall SecurityPolicyWebApplicationFirewallParameters_STATUS |
WebApplicationFirewall: Mutually exclusive with all other properties |
SecurityPolicyProperties_DeploymentStatus_STATUS
(string
alias)
(Appears on:SecurityPolicy_STATUS)
Value | Description |
---|---|
"Failed" |
|
"InProgress" |
|
"NotStarted" |
|
"Succeeded" |
SecurityPolicyProperties_ProvisioningState_STATUS
(string
alias)
(Appears on:SecurityPolicy_STATUS)
Value | Description |
---|---|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"Succeeded" |
|
"Updating" |
SecurityPolicyWebApplicationFirewallAssociation
(Appears on:SecurityPolicyWebApplicationFirewallParameters)
settings for security policy patterns to match
Field | Description |
---|---|
domains []ActivatedResourceReference |
Domains: List of domains. |
patternsToMatch []string |
PatternsToMatch: List of paths |
SecurityPolicyWebApplicationFirewallAssociation_STATUS
(Appears on:SecurityPolicyWebApplicationFirewallParameters_STATUS)
settings for security policy patterns to match
Field | Description |
---|---|
domains []ActivatedResourceReference_STATUS_Profiles_SecurityPolicy_SubResourceEmbedded |
Domains: List of domains. |
patternsToMatch []string |
PatternsToMatch: List of paths |
SecurityPolicyWebApplicationFirewallParameters
(Appears on:SecurityPolicyPropertiesParameters)
Field | Description |
---|---|
associations []SecurityPolicyWebApplicationFirewallAssociation |
Associations: Waf associations |
type SecurityPolicyWebApplicationFirewallParameters_Type |
Type: The type of the Security policy to create. |
wafPolicy ResourceReference |
WafPolicy: Resource ID. |
SecurityPolicyWebApplicationFirewallParameters_STATUS
(Appears on:SecurityPolicyPropertiesParameters_STATUS)
Field | Description |
---|---|
associations []SecurityPolicyWebApplicationFirewallAssociation_STATUS |
Associations: Waf associations |
type SecurityPolicyWebApplicationFirewallParameters_Type_STATUS |
Type: The type of the Security policy to create. |
wafPolicy ResourceReference_STATUS |
WafPolicy: Resource ID. |
SecurityPolicyWebApplicationFirewallParameters_Type
(string
alias)
(Appears on:SecurityPolicyWebApplicationFirewallParameters)
Value | Description |
---|---|
"WebApplicationFirewall" |
SecurityPolicyWebApplicationFirewallParameters_Type_STATUS
(string
alias)
(Appears on:SecurityPolicyWebApplicationFirewallParameters_STATUS)
Value | Description |
---|---|
"WebApplicationFirewall" |
SecurityPolicy_STATUS
(Appears on:SecurityPolicy)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
deploymentStatus SecurityPolicyProperties_DeploymentStatus_STATUS |
|
id string |
Id: Resource ID. |
name string |
Name: Resource name. |
parameters SecurityPolicyPropertiesParameters_STATUS |
Parameters: object which contains security policy parameters |
profileName string |
ProfileName: The name of the profile which holds the security policy. |
provisioningState SecurityPolicyProperties_ProvisioningState_STATUS |
ProvisioningState: Provisioning status |
systemData SystemData_STATUS |
SystemData: Read only system data |
type string |
Type: Resource type. |
SecurityPolicy_Spec
(Appears on:SecurityPolicy)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
operatorSpec SecurityPolicyOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a cdn.azure.com/Profile resource |
parameters SecurityPolicyPropertiesParameters |
Parameters: object which contains security policy parameters |
ServerPortMatchConditionParameters
(Appears on:DeliveryRuleServerPortCondition)
Defines the parameters for ServerPort match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator ServerPortMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName ServerPortMatchConditionParameters_TypeName |
ServerPortMatchConditionParameters_Operator
(string
alias)
(Appears on:ServerPortMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
ServerPortMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:ServerPortMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
ServerPortMatchConditionParameters_STATUS
(Appears on:DeliveryRuleServerPortCondition_STATUS)
Defines the parameters for ServerPort match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator ServerPortMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName ServerPortMatchConditionParameters_TypeName_STATUS |
ServerPortMatchConditionParameters_TypeName
(string
alias)
(Appears on:ServerPortMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleServerPortConditionParameters" |
ServerPortMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:ServerPortMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleServerPortConditionParameters" |
SharedPrivateLinkResourceProperties
(Appears on:AfdOrigin_Spec)
Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin.
Field | Description |
---|---|
groupId string |
GroupId: The group id from the provider of resource the shared private link resource is for. |
privateLink ResourceReference |
PrivateLink: The resource id of the resource the shared private link resource is for. |
privateLinkLocation string |
PrivateLinkLocation: The location of the shared private link resource |
requestMessage string |
RequestMessage: The request message for requesting approval of the shared private link resource. |
status SharedPrivateLinkResourceProperties_Status |
Status: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. |
SharedPrivateLinkResourceProperties_STATUS
(Appears on:AfdOrigin_STATUS)
Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin.
Field | Description |
---|---|
groupId string |
GroupId: The group id from the provider of resource the shared private link resource is for. |
privateLink ResourceReference_STATUS |
PrivateLink: The resource id of the resource the shared private link resource is for. |
privateLinkLocation string |
PrivateLinkLocation: The location of the shared private link resource |
requestMessage string |
RequestMessage: The request message for requesting approval of the shared private link resource. |
status SharedPrivateLinkResourceProperties_Status_STATUS |
Status: Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. |
SharedPrivateLinkResourceProperties_Status
(string
alias)
(Appears on:SharedPrivateLinkResourceProperties)
Value | Description |
---|---|
"Approved" |
|
"Disconnected" |
|
"Pending" |
|
"Rejected" |
|
"Timeout" |
SharedPrivateLinkResourceProperties_Status_STATUS
(string
alias)
(Appears on:SharedPrivateLinkResourceProperties_STATUS)
Value | Description |
---|---|
"Approved" |
|
"Disconnected" |
|
"Pending" |
|
"Rejected" |
|
"Timeout" |
Sku
(Appears on:Profile_Spec)
Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.
Field | Description |
---|---|
name Sku_Name |
Name: Name of the pricing tier. |
Sku_Name
(string
alias)
(Appears on:Sku)
Value | Description |
---|---|
"Custom_Verizon" |
|
"Premium_AzureFrontDoor" |
|
"Premium_Verizon" |
|
"StandardPlus_955BandWidth_ChinaCdn" |
|
"StandardPlus_AvgBandWidth_ChinaCdn" |
|
"StandardPlus_ChinaCdn" |
|
"Standard_955BandWidth_ChinaCdn" |
|
"Standard_Akamai" |
|
"Standard_AvgBandWidth_ChinaCdn" |
|
"Standard_AzureFrontDoor" |
|
"Standard_ChinaCdn" |
|
"Standard_Microsoft" |
|
"Standard_Verizon" |
Sku_Name_STATUS
(string
alias)
(Appears on:Sku_STATUS)
Value | Description |
---|---|
"Custom_Verizon" |
|
"Premium_AzureFrontDoor" |
|
"Premium_Verizon" |
|
"StandardPlus_955BandWidth_ChinaCdn" |
|
"StandardPlus_AvgBandWidth_ChinaCdn" |
|
"StandardPlus_ChinaCdn" |
|
"Standard_955BandWidth_ChinaCdn" |
|
"Standard_Akamai" |
|
"Standard_AvgBandWidth_ChinaCdn" |
|
"Standard_AzureFrontDoor" |
|
"Standard_ChinaCdn" |
|
"Standard_Microsoft" |
|
"Standard_Verizon" |
Sku_STATUS
(Appears on:Profile_STATUS)
Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.
Field | Description |
---|---|
name Sku_Name_STATUS |
Name: Name of the pricing tier. |
SocketAddrMatchConditionParameters
(Appears on:DeliveryRuleSocketAddrCondition)
Defines the parameters for SocketAddress match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator SocketAddrMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName SocketAddrMatchConditionParameters_TypeName |
SocketAddrMatchConditionParameters_Operator
(string
alias)
(Appears on:SocketAddrMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"IPMatch" |
SocketAddrMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:SocketAddrMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"IPMatch" |
SocketAddrMatchConditionParameters_STATUS
(Appears on:DeliveryRuleSocketAddrCondition_STATUS)
Defines the parameters for SocketAddress match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator SocketAddrMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName SocketAddrMatchConditionParameters_TypeName_STATUS |
SocketAddrMatchConditionParameters_TypeName
(string
alias)
(Appears on:SocketAddrMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleSocketAddrConditionParameters" |
SocketAddrMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:SocketAddrMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleSocketAddrConditionParameters" |
SslProtocol
(string
alias)
(Appears on:SslProtocolMatchConditionParameters)
The protocol of an established TLS connection.
Value | Description |
---|---|
"TLSv1" |
|
"TLSv1.1" |
|
"TLSv1.2" |
SslProtocolMatchConditionParameters
(Appears on:DeliveryRuleSslProtocolCondition)
Defines the parameters for SslProtocol match conditions
Field | Description |
---|---|
matchValues []SslProtocol |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator SslProtocolMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName SslProtocolMatchConditionParameters_TypeName |
SslProtocolMatchConditionParameters_Operator
(string
alias)
(Appears on:SslProtocolMatchConditionParameters)
Value | Description |
---|---|
"Equal" |
SslProtocolMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:SslProtocolMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Equal" |
SslProtocolMatchConditionParameters_STATUS
(Appears on:DeliveryRuleSslProtocolCondition_STATUS)
Defines the parameters for SslProtocol match conditions
Field | Description |
---|---|
matchValues []SslProtocol_STATUS |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator SslProtocolMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName SslProtocolMatchConditionParameters_TypeName_STATUS |
SslProtocolMatchConditionParameters_TypeName
(string
alias)
(Appears on:SslProtocolMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleSslProtocolConditionParameters" |
SslProtocolMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:SslProtocolMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleSslProtocolConditionParameters" |
SslProtocol_STATUS
(string
alias)
(Appears on:SslProtocolMatchConditionParameters_STATUS)
The protocol of an established TLS connection.
Value | Description |
---|---|
"TLSv1" |
|
"TLSv1.1" |
|
"TLSv1.2" |
SystemData_STATUS
(Appears on:AfdCustomDomain_STATUS, AfdEndpoint_STATUS, AfdOriginGroup_STATUS, AfdOrigin_STATUS, Profile_STATUS, Route_STATUS, RuleSet_STATUS, Rule_STATUS, Secret_STATUS, SecurityPolicy_STATUS)
Read only system data
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC) |
createdBy string |
CreatedBy: An identifier for the identity that created the resource |
createdByType IdentityType_STATUS |
CreatedByType: The type of identity that created the resource |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: An identifier for the identity that last modified the resource |
lastModifiedByType IdentityType_STATUS |
LastModifiedByType: The type of identity that last modified the resource |
Transform
(string
alias)
(Appears on:ClientPortMatchConditionParameters, CookiesMatchConditionParameters, HostNameMatchConditionParameters, HttpVersionMatchConditionParameters, IsDeviceMatchConditionParameters, PostArgsMatchConditionParameters, QueryStringMatchConditionParameters, RemoteAddressMatchConditionParameters, RequestBodyMatchConditionParameters, RequestHeaderMatchConditionParameters, RequestMethodMatchConditionParameters, RequestSchemeMatchConditionParameters, RequestUriMatchConditionParameters, ServerPortMatchConditionParameters, SocketAddrMatchConditionParameters, SslProtocolMatchConditionParameters, UrlFileExtensionMatchConditionParameters, UrlFileNameMatchConditionParameters, UrlPathMatchConditionParameters)
Describes what transforms are applied before matching
Value | Description |
---|---|
"Lowercase" |
|
"RemoveNulls" |
|
"Trim" |
|
"Uppercase" |
|
"UrlDecode" |
|
"UrlEncode" |
Transform_STATUS
(string
alias)
(Appears on:ClientPortMatchConditionParameters_STATUS, CookiesMatchConditionParameters_STATUS, HostNameMatchConditionParameters_STATUS, HttpVersionMatchConditionParameters_STATUS, IsDeviceMatchConditionParameters_STATUS, PostArgsMatchConditionParameters_STATUS, QueryStringMatchConditionParameters_STATUS, RemoteAddressMatchConditionParameters_STATUS, RequestBodyMatchConditionParameters_STATUS, RequestHeaderMatchConditionParameters_STATUS, RequestMethodMatchConditionParameters_STATUS, RequestSchemeMatchConditionParameters_STATUS, RequestUriMatchConditionParameters_STATUS, ServerPortMatchConditionParameters_STATUS, SocketAddrMatchConditionParameters_STATUS, SslProtocolMatchConditionParameters_STATUS, UrlFileExtensionMatchConditionParameters_STATUS, UrlFileNameMatchConditionParameters_STATUS, UrlPathMatchConditionParameters_STATUS)
Describes what transforms are applied before matching
Value | Description |
---|---|
"Lowercase" |
|
"RemoveNulls" |
|
"Trim" |
|
"Uppercase" |
|
"UrlDecode" |
|
"UrlEncode" |
UrlFileExtensionMatchConditionParameters
(Appears on:DeliveryRuleUrlFileExtensionCondition)
Defines the parameters for UrlFileExtension match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator UrlFileExtensionMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName UrlFileExtensionMatchConditionParameters_TypeName |
UrlFileExtensionMatchConditionParameters_Operator
(string
alias)
(Appears on:UrlFileExtensionMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
UrlFileExtensionMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:UrlFileExtensionMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
UrlFileExtensionMatchConditionParameters_STATUS
(Appears on:DeliveryRuleUrlFileExtensionCondition_STATUS)
Defines the parameters for UrlFileExtension match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator UrlFileExtensionMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName UrlFileExtensionMatchConditionParameters_TypeName_STATUS |
UrlFileExtensionMatchConditionParameters_TypeName
(string
alias)
(Appears on:UrlFileExtensionMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleUrlFileExtensionMatchConditionParameters" |
UrlFileExtensionMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:UrlFileExtensionMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleUrlFileExtensionMatchConditionParameters" |
UrlFileNameMatchConditionParameters
(Appears on:DeliveryRuleUrlFileNameCondition)
Defines the parameters for UrlFilename match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator UrlFileNameMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName UrlFileNameMatchConditionParameters_TypeName |
UrlFileNameMatchConditionParameters_Operator
(string
alias)
(Appears on:UrlFileNameMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
UrlFileNameMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:UrlFileNameMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
UrlFileNameMatchConditionParameters_STATUS
(Appears on:DeliveryRuleUrlFileNameCondition_STATUS)
Defines the parameters for UrlFilename match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator UrlFileNameMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName UrlFileNameMatchConditionParameters_TypeName_STATUS |
UrlFileNameMatchConditionParameters_TypeName
(string
alias)
(Appears on:UrlFileNameMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleUrlFilenameConditionParameters" |
UrlFileNameMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:UrlFileNameMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleUrlFilenameConditionParameters" |
UrlPathMatchConditionParameters
(Appears on:DeliveryRuleUrlPathCondition)
Defines the parameters for UrlPath match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator UrlPathMatchConditionParameters_Operator |
Operator: Describes operator to be matched |
transforms []Transform |
Transforms: List of transforms |
typeName UrlPathMatchConditionParameters_TypeName |
UrlPathMatchConditionParameters_Operator
(string
alias)
(Appears on:UrlPathMatchConditionParameters)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
|
"Wildcard" |
UrlPathMatchConditionParameters_Operator_STATUS
(string
alias)
(Appears on:UrlPathMatchConditionParameters_STATUS)
Value | Description |
---|---|
"Any" |
|
"BeginsWith" |
|
"Contains" |
|
"EndsWith" |
|
"Equal" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
|
"RegEx" |
|
"Wildcard" |
UrlPathMatchConditionParameters_STATUS
(Appears on:DeliveryRuleUrlPathCondition_STATUS)
Defines the parameters for UrlPath match conditions
Field | Description |
---|---|
matchValues []string |
MatchValues: The match value for the condition of the delivery rule |
negateCondition bool |
NegateCondition: Describes if this is negate condition or not |
operator UrlPathMatchConditionParameters_Operator_STATUS |
Operator: Describes operator to be matched |
transforms []Transform_STATUS |
Transforms: List of transforms |
typeName UrlPathMatchConditionParameters_TypeName_STATUS |
UrlPathMatchConditionParameters_TypeName
(string
alias)
(Appears on:UrlPathMatchConditionParameters)
Value | Description |
---|---|
"DeliveryRuleUrlPathMatchConditionParameters" |
UrlPathMatchConditionParameters_TypeName_STATUS
(string
alias)
(Appears on:UrlPathMatchConditionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleUrlPathMatchConditionParameters" |
UrlRedirectAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name UrlRedirectAction_Name |
Name: The name of the action for the delivery rule. |
parameters UrlRedirectActionParameters |
Parameters: Defines the parameters for the action. |
UrlRedirectActionParameters
(Appears on:UrlRedirectAction)
Defines the parameters for the url redirect action.
Field | Description |
---|---|
customFragment string |
CustomFragment: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. |
customHostname string |
CustomHostname: Host to redirect. Leave empty to use the incoming host as the destination host. |
customPath string |
CustomPath: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. |
customQueryString string |
CustomQueryString: The set of query strings to be placed in the redirect URL. Setting this value would replace any
existing query string; leave empty to preserve the incoming query string. Query string must be in |
destinationProtocol UrlRedirectActionParameters_DestinationProtocol |
DestinationProtocol: Protocol to use for the redirect. The default value is MatchRequest |
redirectType UrlRedirectActionParameters_RedirectType |
RedirectType: The redirect type the rule will use when redirecting traffic. |
typeName UrlRedirectActionParameters_TypeName |
UrlRedirectActionParameters_DestinationProtocol
(string
alias)
(Appears on:UrlRedirectActionParameters)
Value | Description |
---|---|
"Http" |
|
"Https" |
|
"MatchRequest" |
UrlRedirectActionParameters_DestinationProtocol_STATUS
(string
alias)
(Appears on:UrlRedirectActionParameters_STATUS)
Value | Description |
---|---|
"Http" |
|
"Https" |
|
"MatchRequest" |
UrlRedirectActionParameters_RedirectType
(string
alias)
(Appears on:UrlRedirectActionParameters)
Value | Description |
---|---|
"Found" |
|
"Moved" |
|
"PermanentRedirect" |
|
"TemporaryRedirect" |
UrlRedirectActionParameters_RedirectType_STATUS
(string
alias)
(Appears on:UrlRedirectActionParameters_STATUS)
Value | Description |
---|---|
"Found" |
|
"Moved" |
|
"PermanentRedirect" |
|
"TemporaryRedirect" |
UrlRedirectActionParameters_STATUS
(Appears on:UrlRedirectAction_STATUS)
Defines the parameters for the url redirect action.
Field | Description |
---|---|
customFragment string |
CustomFragment: Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. |
customHostname string |
CustomHostname: Host to redirect. Leave empty to use the incoming host as the destination host. |
customPath string |
CustomPath: The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. |
customQueryString string |
CustomQueryString: The set of query strings to be placed in the redirect URL. Setting this value would replace any
existing query string; leave empty to preserve the incoming query string. Query string must be in |
destinationProtocol UrlRedirectActionParameters_DestinationProtocol_STATUS |
DestinationProtocol: Protocol to use for the redirect. The default value is MatchRequest |
redirectType UrlRedirectActionParameters_RedirectType_STATUS |
RedirectType: The redirect type the rule will use when redirecting traffic. |
typeName UrlRedirectActionParameters_TypeName_STATUS |
UrlRedirectActionParameters_TypeName
(string
alias)
(Appears on:UrlRedirectActionParameters)
Value | Description |
---|---|
"DeliveryRuleUrlRedirectActionParameters" |
UrlRedirectActionParameters_TypeName_STATUS
(string
alias)
(Appears on:UrlRedirectActionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleUrlRedirectActionParameters" |
UrlRedirectAction_Name
(string
alias)
(Appears on:UrlRedirectAction)
Value | Description |
---|---|
"UrlRedirect" |
UrlRedirectAction_Name_STATUS
(string
alias)
(Appears on:UrlRedirectAction_STATUS)
Value | Description |
---|---|
"UrlRedirect" |
UrlRedirectAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name UrlRedirectAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters UrlRedirectActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
UrlRewriteAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name UrlRewriteAction_Name |
Name: The name of the action for the delivery rule. |
parameters UrlRewriteActionParameters |
Parameters: Defines the parameters for the action. |
UrlRewriteActionParameters
(Appears on:UrlRewriteAction)
Defines the parameters for the url rewrite action.
Field | Description |
---|---|
destination string |
Destination: Define the relative URL to which the above requests will be rewritten by. |
preserveUnmatchedPath bool |
PreserveUnmatchedPath: Whether to preserve unmatched path. Default value is true. |
sourcePattern string |
SourcePattern: define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. |
typeName UrlRewriteActionParameters_TypeName |
UrlRewriteActionParameters_STATUS
(Appears on:UrlRewriteAction_STATUS)
Defines the parameters for the url rewrite action.
Field | Description |
---|---|
destination string |
Destination: Define the relative URL to which the above requests will be rewritten by. |
preserveUnmatchedPath bool |
PreserveUnmatchedPath: Whether to preserve unmatched path. Default value is true. |
sourcePattern string |
SourcePattern: define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. |
typeName UrlRewriteActionParameters_TypeName_STATUS |
UrlRewriteActionParameters_TypeName
(string
alias)
(Appears on:UrlRewriteActionParameters)
Value | Description |
---|---|
"DeliveryRuleUrlRewriteActionParameters" |
UrlRewriteActionParameters_TypeName_STATUS
(string
alias)
(Appears on:UrlRewriteActionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleUrlRewriteActionParameters" |
UrlRewriteAction_Name
(string
alias)
(Appears on:UrlRewriteAction)
Value | Description |
---|---|
"UrlRewrite" |
UrlRewriteAction_Name_STATUS
(string
alias)
(Appears on:UrlRewriteAction_STATUS)
Value | Description |
---|---|
"UrlRewrite" |
UrlRewriteAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name UrlRewriteAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters UrlRewriteActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
UrlSigningAction
(Appears on:DeliveryRuleAction)
Field | Description |
---|---|
name UrlSigningAction_Name |
Name: The name of the action for the delivery rule. |
parameters UrlSigningActionParameters |
Parameters: Defines the parameters for the action. |
UrlSigningActionParameters
(Appears on:UrlSigningAction)
Defines the parameters for the Url Signing action.
Field | Description |
---|---|
algorithm UrlSigningActionParameters_Algorithm |
Algorithm: Algorithm to use for URL signing |
parameterNameOverride []UrlSigningParamIdentifier |
ParameterNameOverride: Defines which query string parameters in the url to be considered for expires, key id etc. |
typeName UrlSigningActionParameters_TypeName |
UrlSigningActionParameters_Algorithm
(string
alias)
(Appears on:UrlSigningActionParameters)
Value | Description |
---|---|
"SHA256" |
UrlSigningActionParameters_Algorithm_STATUS
(string
alias)
(Appears on:UrlSigningActionParameters_STATUS)
Value | Description |
---|---|
"SHA256" |
UrlSigningActionParameters_STATUS
(Appears on:UrlSigningAction_STATUS)
Defines the parameters for the Url Signing action.
Field | Description |
---|---|
algorithm UrlSigningActionParameters_Algorithm_STATUS |
Algorithm: Algorithm to use for URL signing |
parameterNameOverride []UrlSigningParamIdentifier_STATUS |
ParameterNameOverride: Defines which query string parameters in the url to be considered for expires, key id etc. |
typeName UrlSigningActionParameters_TypeName_STATUS |
UrlSigningActionParameters_TypeName
(string
alias)
(Appears on:UrlSigningActionParameters)
Value | Description |
---|---|
"DeliveryRuleUrlSigningActionParameters" |
UrlSigningActionParameters_TypeName_STATUS
(string
alias)
(Appears on:UrlSigningActionParameters_STATUS)
Value | Description |
---|---|
"DeliveryRuleUrlSigningActionParameters" |
UrlSigningAction_Name
(string
alias)
(Appears on:UrlSigningAction)
Value | Description |
---|---|
"UrlSigning" |
UrlSigningAction_Name_STATUS
(string
alias)
(Appears on:UrlSigningAction_STATUS)
Value | Description |
---|---|
"UrlSigning" |
UrlSigningAction_STATUS
(Appears on:DeliveryRuleAction_STATUS)
Field | Description |
---|---|
name UrlSigningAction_Name_STATUS |
Name: The name of the action for the delivery rule. |
parameters UrlSigningActionParameters_STATUS |
Parameters: Defines the parameters for the action. |
UrlSigningKeyParameters
(Appears on:SecretParameters)
Field | Description |
---|---|
keyId string |
KeyId: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. |
secretSource ResourceReference |
SecretSource: Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}p> |
secretVersion string |
SecretVersion: Version of the secret to be used |
type UrlSigningKeyParameters_Type |
UrlSigningKeyParameters_STATUS
(Appears on:SecretParameters_STATUS)
Field | Description |
---|---|
keyId string |
KeyId: Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. |
secretSource ResourceReference_STATUS |
SecretSource: Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}p> |
secretVersion string |
SecretVersion: Version of the secret to be used |
type UrlSigningKeyParameters_Type_STATUS |
UrlSigningKeyParameters_Type
(string
alias)
(Appears on:UrlSigningKeyParameters)
Value | Description |
---|---|
"UrlSigningKey" |
UrlSigningKeyParameters_Type_STATUS
(string
alias)
(Appears on:UrlSigningKeyParameters_STATUS)
Value | Description |
---|---|
"UrlSigningKey" |
UrlSigningParamIdentifier
(Appears on:UrlSigningActionParameters)
Defines how to identify a parameter for a specific purpose e.g. expires
Field | Description |
---|---|
paramIndicator UrlSigningParamIdentifier_ParamIndicator |
ParamIndicator: Indicates the purpose of the parameter |
paramName string |
ParamName: Parameter name |
UrlSigningParamIdentifier_ParamIndicator
(string
alias)
(Appears on:UrlSigningParamIdentifier)
Value | Description |
---|---|
"Expires" |
|
"KeyId" |
|
"Signature" |
UrlSigningParamIdentifier_ParamIndicator_STATUS
(string
alias)
(Appears on:UrlSigningParamIdentifier_STATUS)
Value | Description |
---|---|
"Expires" |
|
"KeyId" |
|
"Signature" |
UrlSigningParamIdentifier_STATUS
(Appears on:UrlSigningActionParameters_STATUS)
Defines how to identify a parameter for a specific purpose e.g. expires
Field | Description |
---|---|
paramIndicator UrlSigningParamIdentifier_ParamIndicator_STATUS |
ParamIndicator: Indicates the purpose of the parameter |
paramName string |
ParamName: Parameter name |
UserAssignedIdentityDetails
(Appears on:ManagedServiceIdentity)
Information about the user assigned identity for the resource
Field | Description |
---|---|
reference genruntime.ResourceReference |
UserAssignedIdentity_STATUS
(Appears on:ManagedServiceIdentity_STATUS)
User assigned identity properties
Field | Description |
---|---|
clientId string |
ClientId: The client ID of the assigned identity. |
principalId string |
PrincipalId: The principal ID of the assigned identity. |