models Package

Classes

AFDDomain

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

Variables are only populated by the server, and will be ignored when sending a request.

AFDDomainHttpsParameters

The JSON object that contains the properties to secure a domain.

All required parameters must be populated in order to send to server.

AFDDomainListResult

Result of the request to list domains. It contains a list of domain objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

AFDDomainProperties

The JSON object that contains the properties of the domain to create.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

AFDDomainUpdateParameters

The domain JSON object required for domain creation or update.

Variables are only populated by the server, and will be ignored when sending a request.

AFDDomainUpdatePropertiesParameters

The JSON object that contains the properties of the domain to create.

Variables are only populated by the server, and will be ignored when sending a request.

AFDEndpoint

Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format <endpointname>.azureedge.net.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

AFDEndpointListResult

Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

AFDEndpointProperties

The JSON object that contains the properties required to create an endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

AFDEndpointPropertiesUpdateParameters

The JSON object containing endpoint update parameters.

Variables are only populated by the server, and will be ignored when sending a request.

AFDEndpointUpdateParameters

Properties required to create or update an endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOrigin

Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginGroup

AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginGroupListResult

Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginGroupProperties

The JSON object that contains the properties of the origin group.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginGroupUpdateParameters

AFDOrigin group properties needed for origin group creation or update.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginGroupUpdatePropertiesParameters

The JSON object that contains the properties of the origin group.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginListResult

Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginProperties

The JSON object that contains the properties of the origin.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginUpdateParameters

AFDOrigin properties needed for origin update.

Variables are only populated by the server, and will be ignored when sending a request.

AFDOriginUpdatePropertiesParameters

The JSON object that contains the properties of the origin.

Variables are only populated by the server, and will be ignored when sending a request.

AFDStateProperties

The tracking states for afd resources.

Variables are only populated by the server, and will be ignored when sending a request.

ActivatedResourceReference

Reference to another resource along with its state.

Variables are only populated by the server, and will be ignored when sending a request.

AfdErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

AfdPurgeParameters

Parameters required for content purge.

All required parameters must be populated in order to send to server.

AfdRouteCacheConfiguration

Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.

AzureFirstPartyManagedCertificate

Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.

Variables are only populated by the server, and will be ignored when sending a request.

AzureFirstPartyManagedCertificateParameters

Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

CacheConfiguration

Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.

CacheExpirationActionParameters

Defines the parameters for the cache expiration action.

All required parameters must be populated in order to send to server.

CacheKeyQueryStringActionParameters

Defines the parameters for the cache-key query string action.

All required parameters must be populated in order to send to server.

CanMigrateParameters

Request body for CanMigrate operation.

All required parameters must be populated in order to send to server.

CanMigrateResult

Result for canMigrate operation.

Variables are only populated by the server, and will be ignored when sending a request.

CdnCertificateSourceParameters

Defines the parameters for using CDN managed certificate for securing custom domain.

All required parameters must be populated in order to send to server.

CdnEndpoint

Defines the ARM Resource ID for the linked endpoints.

CdnManagedHttpsParameters

Defines the certificate source parameters using CDN managed certificate for enabling SSL.

All required parameters must be populated in order to send to server.

CdnWebApplicationFirewallPolicy

Defines web application firewall policy for Azure CDN.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

CdnWebApplicationFirewallPolicyList

Defines a list of WebApplicationFirewallPolicies for Azure CDN. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

CdnWebApplicationFirewallPolicyPatchParameters

Properties required to update a CdnWebApplicationFirewallPolicy.

Certificate

Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

CheckEndpointNameAvailabilityInput

Input of CheckNameAvailability API.

All required parameters must be populated in order to send to server.

CheckEndpointNameAvailabilityOutput

Output of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

CheckHostNameAvailabilityInput

Input of CheckHostNameAvailability API.

All required parameters must be populated in order to send to server.

CheckNameAvailabilityInput

Input of CheckNameAvailability API.

All required parameters must be populated in order to send to server.

CheckNameAvailabilityOutput

Output of check name availability API.

Variables are only populated by the server, and will be ignored when sending a request.

CidrIpAddress

CIDR Ip address.

ClientPortMatchConditionParameters

Defines the parameters for ClientPort match conditions.

All required parameters must be populated in order to send to server.

Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems

Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems.

Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems

Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems.

ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems

ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems.

CompressionSettings

settings for compression.

ContinentsResponse

Continents Response.

ContinentsResponseContinentsItem

ContinentsResponseContinentsItem.

ContinentsResponseCountryOrRegionsItem

ContinentsResponseCountryOrRegionsItem.

CookiesMatchConditionParameters

Defines the parameters for Cookies match conditions.

All required parameters must be populated in order to send to server.

CustomDomain

Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.

Variables are only populated by the server, and will be ignored when sending a request.

CustomDomainHttpsParameters

The JSON object that contains the properties to secure a custom domain.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: UserManagedHttpsParameters, CdnManagedHttpsParameters

All required parameters must be populated in order to send to server.

CustomDomainListResult

Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

CustomDomainParameters

The customDomain JSON object required for custom domain creation or update.

CustomRule

Defines the common attributes for a custom rule that can be included in a waf policy.

All required parameters must be populated in order to send to server.

CustomRuleList

Defines contents of custom rules.

CustomerCertificate

Customer Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

CustomerCertificateParameters

Customer Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

DeepCreatedCustomDomain

Custom domains created on the CDN endpoint.

All required parameters must be populated in order to send to server.

DeepCreatedOrigin

The main origin of CDN content which is added when creating a CDN endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

DeepCreatedOriginGroup

The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.

All required parameters must be populated in order to send to server.

DeliveryRule

A rule that specifies a set of actions and conditions.

All required parameters must be populated in order to send to server.

DeliveryRuleAction

An action for the delivery rule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DeliveryRuleCacheExpirationAction, DeliveryRuleCacheKeyQueryStringAction, DeliveryRuleRequestHeaderAction, DeliveryRuleResponseHeaderAction, OriginGroupOverrideAction, DeliveryRuleRouteConfigurationOverrideAction, UrlRedirectAction, UrlRewriteAction, UrlSigningAction

All required parameters must be populated in order to send to server.

DeliveryRuleCacheExpirationAction

Defines the cache expiration action for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleCacheKeyQueryStringAction

Defines the cache-key query string action for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleClientPortCondition

Defines the ClientPort condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleCondition

A condition for the delivery rule.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: DeliveryRuleClientPortCondition, DeliveryRuleCookiesCondition, DeliveryRuleHostNameCondition, DeliveryRuleHttpVersionCondition, DeliveryRuleIsDeviceCondition, DeliveryRulePostArgsCondition, DeliveryRuleQueryStringCondition, DeliveryRuleRemoteAddressCondition, DeliveryRuleRequestBodyCondition, DeliveryRuleRequestHeaderCondition, DeliveryRuleRequestMethodCondition, DeliveryRuleRequestSchemeCondition, DeliveryRuleRequestUriCondition, DeliveryRuleServerPortCondition, DeliveryRuleSocketAddrCondition, DeliveryRuleSslProtocolCondition, DeliveryRuleUrlFileExtensionCondition, DeliveryRuleUrlFileNameCondition, DeliveryRuleUrlPathCondition

All required parameters must be populated in order to send to server.

DeliveryRuleCookiesCondition

Defines the Cookies condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleHostNameCondition

Defines the HostName condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleHttpVersionCondition

Defines the HttpVersion condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleIsDeviceCondition

Defines the IsDevice condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRulePostArgsCondition

Defines the PostArgs condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleQueryStringCondition

Defines the QueryString condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleRemoteAddressCondition

Defines the RemoteAddress condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleRequestBodyCondition

Defines the RequestBody condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleRequestHeaderAction

Defines the request header action for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleRequestHeaderCondition

Defines the RequestHeader condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleRequestMethodCondition

Defines the RequestMethod condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleRequestSchemeCondition

Defines the RequestScheme condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleRequestUriCondition

Defines the RequestUri condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleResponseHeaderAction

Defines the response header action for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleRouteConfigurationOverrideAction

Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.

All required parameters must be populated in order to send to server.

DeliveryRuleServerPortCondition

Defines the ServerPort condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleSocketAddrCondition

Defines the SocketAddress condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleSslProtocolCondition

Defines the SslProtocol condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleUrlFileExtensionCondition

Defines the UrlFileExtension condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleUrlFileNameCondition

Defines the UrlFileName condition for the delivery rule.

All required parameters must be populated in order to send to server.

DeliveryRuleUrlPathCondition

Defines the UrlPath condition for the delivery rule.

All required parameters must be populated in order to send to server.

DimensionProperties

Type of operation: get, read, delete, etc.

DomainValidationProperties

The JSON object that contains the properties to validate a domain.

Variables are only populated by the server, and will be ignored when sending a request.

EdgeNode

Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.

Variables are only populated by the server, and will be ignored when sending a request.

EdgenodeResult

Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

Endpoint

CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format <endpointname>.azureedge.net.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

EndpointListResult

Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

EndpointProperties

The JSON object that contains the properties required to create an endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

EndpointPropertiesUpdateParameters

The JSON object containing endpoint update parameters.

EndpointPropertiesUpdateParametersDeliveryPolicy

A policy that specifies the delivery rules to be used for an endpoint.

All required parameters must be populated in order to send to server.

EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink

Defines the Web Application Firewall policy for the endpoint (if applicable).

EndpointUpdateParameters

Properties required to create or update an endpoint.

ErrorAdditionalInfo

The resource management error additional info.

Variables are only populated by the server, and will be ignored when sending a request.

ErrorDetail

The error detail.

Variables are only populated by the server, and will be ignored when sending a request.

ErrorResponse

Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.

GeoFilter

Rules defining user's geo access within a CDN endpoint.

All required parameters must be populated in order to send to server.

HeaderActionParameters

Defines the parameters for the request header action.

All required parameters must be populated in order to send to server.

HealthProbeParameters

The JSON object that contains the properties to send health probes to origin.

HostNameMatchConditionParameters

Defines the parameters for HostName match conditions.

All required parameters must be populated in order to send to server.

HttpErrorRangeParameters

The JSON object that represents the range for http status codes.

HttpVersionMatchConditionParameters

Defines the parameters for HttpVersion match conditions.

All required parameters must be populated in order to send to server.

IpAddressGroup

CDN Ip address group.

IsDeviceMatchConditionParameters

Defines the parameters for IsDevice match conditions.

All required parameters must be populated in order to send to server.

KeyVaultCertificateSourceParameters

Describes the parameters for using a user's KeyVault certificate for securing custom domain.

All required parameters must be populated in order to send to server.

KeyVaultSigningKeyParameters

Describes the parameters for using a user's KeyVault for URL Signing Key.

All required parameters must be populated in order to send to server.

LoadBalancingSettingsParameters

Round-Robin load balancing settings for a backend pool.

LoadParameters

Parameters required for content load.

All required parameters must be populated in order to send to server.

LogSpecification

Log specification of operation.

ManagedCertificate

Managed Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

ManagedCertificateParameters

Managed Certificate used for https.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

ManagedRuleDefinition

Describes a managed rule definition.

Variables are only populated by the server, and will be ignored when sending a request.

ManagedRuleGroupDefinition

Describes a managed rule group.

Variables are only populated by the server, and will be ignored when sending a request.

ManagedRuleGroupOverride

Defines a managed rule group override setting.

All required parameters must be populated in order to send to server.

ManagedRuleOverride

Defines a managed rule group override setting.

All required parameters must be populated in order to send to server.

ManagedRuleSet

Defines a managed rule set.

All required parameters must be populated in order to send to server.

ManagedRuleSetDefinition

Describes a managed rule set definition.

Variables are only populated by the server, and will be ignored when sending a request.

ManagedRuleSetDefinitionList

List of managed rule set definitions available for use in a policy.

Variables are only populated by the server, and will be ignored when sending a request.

ManagedRuleSetList

Defines the list of managed rule sets for the policy.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities).

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

MatchCondition

Define match conditions.

All required parameters must be populated in order to send to server.

MetricAvailability

Retention policy of a resource metric.

MetricSpecification

Metric specification of operation.

MetricsResponse

Metrics Response.

MetricsResponseSeriesItem

MetricsResponseSeriesItem.

MetricsResponseSeriesPropertiesItemsItem

MetricsResponseSeriesPropertiesItemsItem.

MigrateResult

Result for migrate operation.

Variables are only populated by the server, and will be ignored when sending a request.

MigrationErrorType

Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.

Variables are only populated by the server, and will be ignored when sending a request.

MigrationParameters

Request body for Migrate operation.

All required parameters must be populated in order to send to server.

MigrationWebApplicationFirewallMapping

Web Application Firewall Mapping.

Operation

CDN REST API operation.

Variables are only populated by the server, and will be ignored when sending a request.

OperationDisplay

The object that represents the operation.

Variables are only populated by the server, and will be ignored when sending a request.

OperationsListResult

Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.

Origin

CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

Variables are only populated by the server, and will be ignored when sending a request.

OriginGroup

Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.

Variables are only populated by the server, and will be ignored when sending a request.

OriginGroupListResult

Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

OriginGroupOverride

Defines the parameters for the origin group override configuration.

OriginGroupOverrideAction

Defines the origin group override action for the delivery rule.

All required parameters must be populated in order to send to server.

OriginGroupOverrideActionParameters

Defines the parameters for the origin group override action.

All required parameters must be populated in order to send to server.

OriginGroupProperties

The JSON object that contains the properties of the origin group.

Variables are only populated by the server, and will be ignored when sending a request.

OriginGroupUpdateParameters

Origin group properties needed for origin group creation or update.

OriginGroupUpdatePropertiesParameters

The JSON object that contains the properties of the origin group.

OriginListResult

Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

OriginProperties

The JSON object that contains the properties of the origin.

Variables are only populated by the server, and will be ignored when sending a request.

OriginUpdateParameters

Origin properties needed for origin update.

OriginUpdatePropertiesParameters

The JSON object that contains the properties of the origin.

PolicySettings

Defines contents of a web application firewall global configuration.

PostArgsMatchConditionParameters

Defines the parameters for PostArgs match conditions.

All required parameters must be populated in order to send to server.

Profile

A profile is a logical grouping of endpoints that share the same settings.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

ProfileChangeSkuWafMapping

Parameters required for profile upgrade.

All required parameters must be populated in order to send to server.

ProfileListResult

Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

ProfileLogScrubbing

Defines rules that scrub sensitive fields in the Azure Front Door profile logs.

ProfileScrubbingRules

Defines the contents of the log scrubbing rules.

All required parameters must be populated in order to send to server.

ProfileUpdateParameters

Properties required to update a profile.

ProfileUpgradeParameters

Parameters required for profile upgrade.

All required parameters must be populated in order to send to server.

ProxyResource

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

Variables are only populated by the server, and will be ignored when sending a request.

PurgeParameters

Parameters required for content purge.

All required parameters must be populated in order to send to server.

QueryStringMatchConditionParameters

Defines the parameters for QueryString match conditions.

All required parameters must be populated in order to send to server.

RankingsResponse

Rankings Response.

RankingsResponseTablesItem

RankingsResponseTablesItem.

RankingsResponseTablesPropertiesItemsItem

RankingsResponseTablesPropertiesItemsItem.

RankingsResponseTablesPropertiesItemsMetricsItem

RankingsResponseTablesPropertiesItemsMetricsItem.

RateLimitRule

Defines a rate limiting rule that can be included in a waf policy.

All required parameters must be populated in order to send to server.

RateLimitRuleList

Defines contents of rate limit rules.

RemoteAddressMatchConditionParameters

Defines the parameters for RemoteAddress match conditions.

All required parameters must be populated in order to send to server.

RequestBodyMatchConditionParameters

Defines the parameters for RequestBody match conditions.

All required parameters must be populated in order to send to server.

RequestHeaderMatchConditionParameters

Defines the parameters for RequestHeader match conditions.

All required parameters must be populated in order to send to server.

RequestMethodMatchConditionParameters

Defines the parameters for RequestMethod match conditions.

All required parameters must be populated in order to send to server.

RequestSchemeMatchConditionParameters

Defines the parameters for RequestScheme match conditions.

All required parameters must be populated in order to send to server.

RequestUriMatchConditionParameters

Defines the parameters for RequestUri match conditions.

All required parameters must be populated in order to send to server.

Resource

The core properties of ARM resources.

Variables are only populated by the server, and will be ignored when sending a request.

ResourceReference

Reference to another resource.

ResourceUsage

Output of check resource usage API.

Variables are only populated by the server, and will be ignored when sending a request.

ResourceUsageListResult

Output of check resource usage API.

Variables are only populated by the server, and will be ignored when sending a request.

ResourcesResponse

Resources Response.

ResourcesResponseCustomDomainsItem

ResourcesResponseCustomDomainsItem.

ResourcesResponseEndpointsItem

ResourcesResponseEndpointsItem.

ResourcesResponseEndpointsPropertiesItemsItem

ResourcesResponseEndpointsPropertiesItemsItem.

ResponseBasedOriginErrorDetectionParameters

The JSON object that contains the properties to determine origin health using real requests/responses.

Route

Friendly Routes name mapping to the any Routes or secret related information.

Variables are only populated by the server, and will be ignored when sending a request.

RouteConfigurationOverrideActionParameters

Defines the parameters for the route configuration override action.

All required parameters must be populated in order to send to server.

RouteListResult

Result of the request to list routes. It contains a list of route objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

RouteProperties

The JSON object that contains the properties of the Routes to create.

Variables are only populated by the server, and will be ignored when sending a request.

RouteUpdateParameters

The domain JSON object required for domain creation or update.

Variables are only populated by the server, and will be ignored when sending a request.

RouteUpdatePropertiesParameters

The JSON object that contains the properties of the domain to create.

Variables are only populated by the server, and will be ignored when sending a request.

Rule

Friendly Rules name mapping to the any Rules or secret related information.

Variables are only populated by the server, and will be ignored when sending a request.

RuleListResult

Result of the request to list rules. It contains a list of rule objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

RuleProperties

The JSON object that contains the properties of the Rules to create.

Variables are only populated by the server, and will be ignored when sending a request.

RuleSet

Friendly RuleSet name mapping to the any RuleSet or secret related information.

Variables are only populated by the server, and will be ignored when sending a request.

RuleSetListResult

Result of the request to list rule sets. It contains a list of rule set objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

RuleSetProperties

The JSON object that contains the properties of the Rule Set to create.

Variables are only populated by the server, and will be ignored when sending a request.

RuleUpdateParameters

The domain JSON object required for domain creation or update.

Variables are only populated by the server, and will be ignored when sending a request.

RuleUpdatePropertiesParameters

The JSON object that contains the properties of the rule to update.

Variables are only populated by the server, and will be ignored when sending a request.

Secret

Friendly Secret name mapping to the any Secret or secret related information.

Variables are only populated by the server, and will be ignored when sending a request.

SecretListResult

Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

SecretParameters

The json object containing secret parameters.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AzureFirstPartyManagedCertificateParameters, CustomerCertificateParameters, ManagedCertificateParameters, UrlSigningKeyParameters

All required parameters must be populated in order to send to server.

SecretProperties

The JSON object that contains the properties of the Secret to create.

Variables are only populated by the server, and will be ignored when sending a request.

SecurityPolicy

SecurityPolicy association for AzureFrontDoor profile.

Variables are only populated by the server, and will be ignored when sending a request.

SecurityPolicyListResult

Result of the request to list security policies. It contains a list of security policy objects and a URL link to get the next set of results.

Variables are only populated by the server, and will be ignored when sending a request.

SecurityPolicyProperties

The json object that contains properties required to create a security policy.

Variables are only populated by the server, and will be ignored when sending a request.

SecurityPolicyPropertiesParameters

The json object containing security policy parameters.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SecurityPolicyWebApplicationFirewallParameters

All required parameters must be populated in order to send to server.

SecurityPolicyUpdateParameters

The JSON object containing security policy update parameters.

SecurityPolicyWebApplicationFirewallAssociation

settings for security policy patterns to match.

SecurityPolicyWebApplicationFirewallParameters

The json object containing security policy waf parameters.

All required parameters must be populated in order to send to server.

ServerPortMatchConditionParameters

Defines the parameters for ServerPort match conditions.

All required parameters must be populated in order to send to server.

ServiceSpecification

One property of operation, include log specifications.

SharedPrivateLinkResourceProperties

Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin.

Sku

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.

SocketAddrMatchConditionParameters

Defines the parameters for SocketAddress match conditions.

All required parameters must be populated in order to send to server.

SslProtocolMatchConditionParameters

Defines the parameters for SslProtocol match conditions.

All required parameters must be populated in order to send to server.

SsoUri

The URI required to login to the supplemental portal from the Azure portal.

Variables are only populated by the server, and will be ignored when sending a request.

SupportedOptimizationTypesListResult

The result of the GetSupportedOptimizationTypes API.

Variables are only populated by the server, and will be ignored when sending a request.

SystemData

Read only system data.

TrackedResource

The resource model definition for a ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

UrlFileExtensionMatchConditionParameters

Defines the parameters for UrlFileExtension match conditions.

All required parameters must be populated in order to send to server.

UrlFileNameMatchConditionParameters

Defines the parameters for UrlFilename match conditions.

All required parameters must be populated in order to send to server.

UrlPathMatchConditionParameters

Defines the parameters for UrlPath match conditions.

All required parameters must be populated in order to send to server.

UrlRedirectAction

Defines the url redirect action for the delivery rule.

All required parameters must be populated in order to send to server.

UrlRedirectActionParameters

Defines the parameters for the url redirect action.

All required parameters must be populated in order to send to server.

UrlRewriteAction

Defines the url rewrite action for the delivery rule.

All required parameters must be populated in order to send to server.

UrlRewriteActionParameters

Defines the parameters for the url rewrite action.

All required parameters must be populated in order to send to server.

UrlSigningAction

Defines the url signing action for the delivery rule.

All required parameters must be populated in order to send to server.

UrlSigningActionParameters

Defines the parameters for the Url Signing action.

All required parameters must be populated in order to send to server.

UrlSigningKey

Url signing key.

All required parameters must be populated in order to send to server.

UrlSigningKeyParameters

Url signing key parameters.

All required parameters must be populated in order to send to server.

UrlSigningParamIdentifier

Defines how to identify a parameter for a specific purpose e.g. expires.

All required parameters must be populated in order to send to server.

Usage

Describes resource usage.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

UsageName

The usage names.

UsagesListResult

The list usages operation response.

UserAssignedIdentity

User assigned identity properties.

Variables are only populated by the server, and will be ignored when sending a request.

UserManagedHttpsParameters

Defines the certificate source parameters using user's keyvault certificate for enabling SSL.

All required parameters must be populated in order to send to server.

ValidateCustomDomainInput

Input of the custom domain to be validated for DNS mapping.

All required parameters must be populated in order to send to server.

ValidateCustomDomainOutput

Output of custom domain validation.

Variables are only populated by the server, and will be ignored when sending a request.

ValidateProbeInput

Input of the validate probe API.

All required parameters must be populated in order to send to server.

ValidateProbeOutput

Output of the validate probe API.

Variables are only populated by the server, and will be ignored when sending a request.

ValidateSecretInput

Input of the secret to be validated.

All required parameters must be populated in order to send to server.

ValidateSecretOutput

Output of the validated secret.

ValidationToken

The validation token.

Variables are only populated by the server, and will be ignored when sending a request.

WafMetricsResponse

Waf Metrics Response.

WafMetricsResponseSeriesItem

WafMetricsResponseSeriesItem.

WafMetricsResponseSeriesPropertiesItemsItem

WafMetricsResponseSeriesPropertiesItemsItem.

WafRankingsResponse

Waf Rankings Response.

WafRankingsResponseDataItem

WafRankingsResponseDataItem.

Enums

AFDEndpointProtocols

Supported protocols for the customer's endpoint.

ActionType

Defines the action to take on rule match.

AfdCertificateType

Defines the source of the SSL certificate.

AfdMinimumTlsVersion

TLS protocol version that will be used for Https.

AfdProvisioningState

Provisioning status.

AfdQueryStringCachingBehavior

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.

Algorithm

Algorithm to use for URL signing.

AutoGeneratedDomainNameLabelScope

Indicates the endpoint name reuse scope. The default value is TenantReuse.

CacheBehavior

Caching behavior for the requests.

CacheExpirationActionParametersTypeName

CacheExpirationActionParametersTypeName.

CacheKeyQueryStringActionParametersTypeName

CacheKeyQueryStringActionParametersTypeName.

CacheType

The level at which the content needs to be cached.

CanMigrateDefaultSku

Recommended sku for the migration.

CdnCertificateSourceParametersTypeName

CdnCertificateSourceParametersTypeName.

CertificateSource

Defines the source of the SSL certificate.

CertificateType

Type of certificate used.

ClientPortMatchConditionParametersTypeName

ClientPortMatchConditionParametersTypeName.

ClientPortOperator

Describes operator to be matched.

CookiesMatchConditionParametersTypeName

CookiesMatchConditionParametersTypeName.

CookiesOperator

Describes operator to be matched.

CustomDomainResourceState

Resource status of the custom domain.

CustomHttpsProvisioningState

Provisioning status of the custom domain.

CustomHttpsProvisioningSubstate

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

CustomRuleEnabledState

Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.

DeleteRule

Describes the action that shall be taken when the certificate is removed from Key Vault.

DeliveryRuleActionEnum

The name of the action for the delivery rule.

DeploymentStatus

DeploymentStatus.

DestinationProtocol

Protocol to use for the redirect. The default value is MatchRequest.

DomainValidationState

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.

EnabledState

Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'.

EndpointProvisioningState

Provisioning status of the endpoint.

EndpointResourceState

Resource status of the endpoint.

ForwardingProtocol

Protocol this rule will use when forwarding traffic to backends.

GeoFilterActions

Action of the geo filter, i.e. allow or block access.

HeaderAction

Action to perform.

HeaderActionParametersTypeName

HeaderActionParametersTypeName.

HealthProbeRequestType

The type of health probe request that is made.

HostNameMatchConditionParametersTypeName

HostNameMatchConditionParametersTypeName.

HostNameOperator

Describes operator to be matched.

HttpVersionMatchConditionParametersTypeName

HttpVersionMatchConditionParametersTypeName.

HttpVersionOperator

Describes operator to be matched.

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.

IdentityType

The type of identity that creates/modifies resources.

IsDeviceMatchConditionParametersMatchValuesItem

IsDeviceMatchConditionParametersMatchValuesItem.

IsDeviceMatchConditionParametersTypeName

IsDeviceMatchConditionParametersTypeName.

IsDeviceOperator

Describes operator to be matched.

KeyVaultCertificateSourceParametersTypeName

KeyVaultCertificateSourceParametersTypeName.

KeyVaultSigningKeyParametersTypeName

KeyVaultSigningKeyParametersTypeName.

LinkToDefaultDomain

whether this route will be linked to the default endpoint domain.

LogMetric

LogMetric.

LogMetricsGranularity

LogMetricsGranularity.

LogMetricsGroupBy

LogMetricsGroupBy.

LogRanking

LogRanking.

LogRankingMetric

LogRankingMetric.

ManagedRuleEnabledState

Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

MatchProcessingBehavior

If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

MatchVariable

The name of the condition for the delivery rule.

MetricsGranularity

MetricsGranularity.

MetricsSeriesUnit

MetricsSeriesUnit.

MinimumTlsVersion

TLS protocol version that will be used for Https.

Operator

Describes operator to be matched.

OptimizationType

Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.

OriginGroupOverrideActionParametersTypeName

OriginGroupOverrideActionParametersTypeName.

OriginGroupProvisioningState

Provisioning status of the origin group.

OriginGroupResourceState

Resource status of the origin group.

OriginProvisioningState

Provisioning status of the origin.

OriginResourceState

Resource status of the origin.

ParamIndicator

Indicates the purpose of the parameter.

PolicyEnabledState

describes if the policy is in enabled state or disabled state.

PolicyMode

Describes if it is in detection mode or prevention mode at policy level.

PolicyResourceState

Resource status of the policy.

PolicySettingsDefaultCustomBlockResponseStatusCode

If the action type is block, this field defines the default customer overridable http response status code.

PostArgsMatchConditionParametersTypeName

PostArgsMatchConditionParametersTypeName.

PostArgsOperator

Describes operator to be matched.

PrivateEndpointStatus

The approval status for the connection to the Private Link.

ProbeProtocol

Protocol to use for health probe.

ProfileProvisioningState

Provisioning status of the profile.

ProfileResourceState

Resource status of the profile.

ProfileScrubbingState

State of the log scrubbing config. Default value is Enabled.

ProtocolType

Defines the TLS extension protocol that is used for secure delivery.

ProvisioningState

Provisioning state of the WebApplicationFirewallPolicy.

QueryStringBehavior

Caching behavior for the requests.

QueryStringCachingBehavior

Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.

QueryStringMatchConditionParametersTypeName

QueryStringMatchConditionParametersTypeName.

QueryStringOperator

Describes operator to be matched.

RedirectType

The redirect type the rule will use when redirecting traffic.

RemoteAddressMatchConditionParametersTypeName

RemoteAddressMatchConditionParametersTypeName.

RemoteAddressOperator

Describes operator to be matched.

RequestBodyMatchConditionParametersTypeName

RequestBodyMatchConditionParametersTypeName.

RequestBodyOperator

Describes operator to be matched.

RequestHeaderMatchConditionParametersTypeName

RequestHeaderMatchConditionParametersTypeName.

RequestHeaderOperator

Describes operator to be matched.

RequestMethodMatchConditionParametersMatchValuesItem

RequestMethodMatchConditionParametersMatchValuesItem.

RequestMethodMatchConditionParametersTypeName

RequestMethodMatchConditionParametersTypeName.

RequestMethodOperator

Describes operator to be matched.

RequestSchemeMatchConditionParametersMatchValuesItem

RequestSchemeMatchConditionParametersMatchValuesItem.

RequestSchemeMatchConditionParametersOperator

Describes operator to be matched.

RequestSchemeMatchConditionParametersTypeName

RequestSchemeMatchConditionParametersTypeName.

RequestUriMatchConditionParametersTypeName

RequestUriMatchConditionParametersTypeName.

RequestUriOperator

Describes operator to be matched.

ResourceType

Type of CDN resource used in CheckNameAvailability.

ResourceUsageUnit

Unit of the usage. e.g. count.

ResponseBasedDetectedErrorTypes

Type of response errors for real user requests for which origin will be deemed unhealthy.

RouteConfigurationOverrideActionParametersTypeName

RouteConfigurationOverrideActionParametersTypeName.

RuleCacheBehavior

Caching behavior for the requests.

RuleIsCompressionEnabled

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.

RuleQueryStringCachingBehavior

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.

ScrubbingRuleEntryMatchOperator

When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.

ScrubbingRuleEntryMatchVariable

The variable to be scrubbed from the logs.

ScrubbingRuleEntryState

Defines the state of a log scrubbing rule. Default value is enabled.

SecretType

The type of the secret resource.

SecurityPolicyType

The type of the Security policy to create.

ServerPortMatchConditionParametersTypeName

ServerPortMatchConditionParametersTypeName.

ServerPortOperator

Describes operator to be matched.

SharedPrivateLinkResourceStatus

Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.

SkuName

Name of the pricing tier.

SocketAddrMatchConditionParametersTypeName

SocketAddrMatchConditionParametersTypeName.

SocketAddrOperator

Describes operator to be matched.

SslProtocol

The protocol of an established TLS connection.

SslProtocolMatchConditionParametersTypeName

SslProtocolMatchConditionParametersTypeName.

SslProtocolOperator

Describes operator to be matched.

Status

The validation status.

Transform

Describes what transforms are applied before matching.

TransformType

Describes what transforms were applied before matching.

UpdateRule

Describes the action that shall be taken when the certificate is updated in Key Vault.

UrlFileExtensionMatchConditionParametersTypeName

UrlFileExtensionMatchConditionParametersTypeName.

UrlFileExtensionOperator

Describes operator to be matched.

UrlFileNameMatchConditionParametersTypeName

UrlFileNameMatchConditionParametersTypeName.

UrlFileNameOperator

Describes operator to be matched.

UrlPathMatchConditionParametersTypeName

UrlPathMatchConditionParametersTypeName.

UrlPathOperator

Describes operator to be matched.

UrlRedirectActionParametersTypeName

UrlRedirectActionParametersTypeName.

UrlRewriteActionParametersTypeName

UrlRewriteActionParametersTypeName.

UrlSigningActionParametersTypeName

UrlSigningActionParametersTypeName.

UsageUnit

An enum describing the unit of measurement.

WafAction

WafAction.

WafGranularity

WafGranularity.

WafMatchVariable

Match variable to compare against.

WafMetric

WafMetric.

WafMetricsGranularity

WafMetricsGranularity.

WafMetricsSeriesUnit

WafMetricsSeriesUnit.

WafRankingGroupBy

WafRankingGroupBy.

WafRankingType

WafRankingType.

WafRuleType

WafRuleType.