models Package

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

Customized cipher suite set object that will be used for Https when cipherSuiteSetType is Customized.

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

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

The domain JSON object required for domain creation or update.

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

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.

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

The JSON object containing endpoint update parameters.

Properties required to create or update an endpoint.

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.

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

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

AFDOrigin group properties needed for origin group creation or update.

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

The JSON object that contains the properties of the origin.

AFDOrigin properties needed for origin update.

The JSON object that contains the properties of the origin.

The tracking states for afd resources.

Reference to another resource along with its state.

Parameters required for content purge.

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

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

The JSON object that contains a rule with its name for batch mode operations.

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

Defines the parameters for the cache expiration action.

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

Request body for CanMigrate operation.

CanMigrateProperties.

Result for canMigrate operation.

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

Defines the ARM Resource ID for the linked endpoints.

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

Request body for Migrate operation.

Defines web application firewall policy for Azure CDN.

Properties required to update a CdnWebApplicationFirewallPolicy.

Defines CDN web application firewall policy properties.

Defines the parameters for certificate source.

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

Input of CheckNameAvailability API.

Output of check name availability API.

Input of CheckHostNameAvailability API.

Input of CheckNameAvailability API.

Output of check name availability API.

CIDR Ip address.

Defines the parameters for ClientPort match conditions.

Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems.

Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems.

ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems.

settings for compression.

Continents Response.

ContinentsResponseContinentsItem.

ContinentsResponseCountryOrRegionsItem.

Defines the parameters for Cookies match conditions.

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

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

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

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

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

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

Defines contents of custom rules.

Customer Certificate used for https.

Custom domains created on the CDN endpoint.

Properties of the custom domain created on the CDN endpoint.

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

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.

Properties of the origin group created on the CDN endpoint.

Properties of the origin created on the CDN endpoint.

A rule that specifies a set of actions and conditions.

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

Defines the parameters for delivery rule actions.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CacheExpirationActionParameters, CacheKeyQueryStringActionParameters, HeaderActionParameters, OriginGroupOverrideActionParameters, RouteConfigurationOverrideActionParameters, UrlRedirectActionParameters, UrlRewriteActionParameters, UrlSigningActionParameters

Defines the cache expiration action for the delivery rule.

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

Defines the ClientPort condition for the delivery rule.

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

Defines the parameters for delivery rule match conditions.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClientPortMatchConditionParameters, CookiesMatchConditionParameters, HostNameMatchConditionParameters, HttpVersionMatchConditionParameters, IsDeviceMatchConditionParameters, PostArgsMatchConditionParameters, QueryStringMatchConditionParameters, RemoteAddressMatchConditionParameters, RequestBodyMatchConditionParameters, RequestHeaderMatchConditionParameters, RequestMethodMatchConditionParameters, RequestSchemeMatchConditionParameters, RequestUriMatchConditionParameters, ServerPortMatchConditionParameters, SocketAddrMatchConditionParameters, SslProtocolMatchConditionParameters, UrlFileExtensionMatchConditionParameters, UrlFileNameMatchConditionParameters, UrlPathMatchConditionParameters

Defines the Cookies condition for the delivery rule.

Defines the HostName condition for the delivery rule.

Defines the HttpVersion condition for the delivery rule.

Defines the IsDevice condition for the delivery rule.

Defines the PostArgs condition for the delivery rule.

Defines the QueryString condition for the delivery rule.

Defines the RemoteAddress condition for the delivery rule.

Defines the RequestBody condition for the delivery rule.

Defines the request header action for the delivery rule.

Defines the RequestHeader condition for the delivery rule.

Defines the RequestMethod condition for the delivery rule.

Defines the RequestScheme condition for the delivery rule.

Defines the RequestUri condition for the delivery rule.

Defines the response header action for the delivery rule.

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

Defines the ServerPort condition for the delivery rule.

Defines the SocketAddress condition for the delivery rule.

Defines the SslProtocol condition for the delivery rule.

Defines the UrlFileExtension condition for the delivery rule.

Defines the UrlFileName condition for the delivery rule.

Defines the UrlPath condition for the delivery rule.

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

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

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

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

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.

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

The JSON object containing endpoint update parameters.

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

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

Properties required to create or update an endpoint.

The resource management error additional info.

The error detail.

Error response.

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

Defines the parameters for the request header action.

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

Defines the parameters for HostName match conditions.

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

Defines the parameters for HttpVersion match conditions.

CDN Ip address group.

Defines the parameters for IsDevice match conditions.

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

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

Round-Robin load balancing settings for a backend pool.

Parameters required for content load.

Log specification of operation.

Managed Certificate used for https.

Describes a managed rule definition.

Describes a managed rule group.

Defines a managed rule group override setting.

Defines a managed rule group override setting.

Defines a managed rule set.

Describes a managed rule set definition.

Properties for a managed rule set definition.

Defines the list of managed rule sets for the policy.

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

Define match conditions.

Retention policy of a resource metric.

Metric specification of operation.

Metrics Response.

MetricsResponseSeriesItem.

MetricsResponseSeriesPropertiesItemsItem.

Result for migrate operation.

MigrateResultProperties.

CDN Endpoint Mapping.

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

Request body for Migrate operation.

Web Application Firewall Mapping.

CDN REST API operation.

The object that represents the operation.

Properties of operation, include metric specifications.

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.

The JSON object that contains the properties of the origin authentication settings.

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

Defines the parameters for the origin group override configuration.

Defines the origin group override action for the delivery rule.

Defines the parameters for the origin group override action.

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

Origin group properties needed for origin group creation or update.

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

The JSON object that contains the properties of the origin.

Origin properties needed for origin update.

The JSON object that contains the properties of the origin.

Defines contents of a web application firewall global configuration.

Defines the parameters for PostArgs match conditions.

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

Parameters required for profile upgrade.

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

The JSON object that contains the properties required to create a profile.

The JSON object containing profile update parameters.

Defines the contents of the log scrubbing rules.

Properties required to update a profile.

Parameters required for profile upgrade.

Proxy Resource.

Parameters required for content purge.

Defines the parameters for QueryString match conditions.

Rankings Response.

RankingsResponseTablesItem.

RankingsResponseTablesPropertiesItemsItem.

RankingsResponseTablesPropertiesItemsMetricsItem.

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

Defines contents of rate limit rules.

Defines the parameters for RemoteAddress match conditions.

Defines the parameters for RequestBody match conditions.

Defines the parameters for RequestHeader match conditions.

Defines the parameters for RequestMethod match conditions.

Defines the parameters for RequestScheme match conditions.

Defines the parameters for RequestUri match conditions.

Resource.

Reference to another resource.

Output of check resource usage API.

Resources Response.

ResourcesResponseCustomDomainsItem.

ResourcesResponseEndpointsItem.

ResourcesResponseEndpointsPropertiesItemsItem.

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

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

Defines the parameters for the route configuration override action.

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

The domain JSON object required for domain creation or update.

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

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

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

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

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

The domain JSON object required for domain creation or update.

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

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

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

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

SecurityPolicy association for AzureFrontDoor profile.

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

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

The JSON object containing security policy update parameters.

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

settings for security policy patterns to match.

The json object containing security policy waf parameters.

Defines the parameters for ServerPort match conditions.

One property of operation, include log specifications.

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

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.

Defines the parameters for SocketAddress match conditions.

Defines the parameters for SslProtocol match conditions.

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

The result of the GetSupportedOptimizationTypes API.

Metadata pertaining to creation and last modification of the resource.

Tracked Resource.

Defines the parameters for UrlFileExtension match conditions.

Defines the parameters for UrlFilename match conditions.

Defines the parameters for UrlPath match conditions.

Defines the url redirect action for the delivery rule.

Defines the parameters for the url redirect action.

Defines the url rewrite action for the delivery rule.

Defines the parameters for the url rewrite action.

Defines the url signing action for the delivery rule.

Defines the parameters for the Url Signing action.

Url signing key.

Url signing key parameters.

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

Describes resource usage.

The usage names.

User assigned identity properties.

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

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

Output of custom domain validation.

Input of the validate probe API.

Output of the validate probe API.

Input of the secret to be validated.

Output of the validated secret.

Waf Metrics Response.

WafMetricsResponseSeriesItem.

WafMetricsResponseSeriesPropertiesItemsItem.

Waf Rankings Response.

WafRankingsResponseDataItem.

Supported protocols for the customer's endpoint.

Defines the action to take on rule match.

Defines the source of the SSL certificate.

cipher suite set type that will be used for Https.

Type of AfdCustomizedCipherSuiteForTls12.

Type of AfdCustomizedCipherSuiteForTls13.

TLS protocol version that will be used for Https when cipherSuiteSetType is Customized.

Provisioning status.

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 to use for URL signing.

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

Caching behavior for the requests.

The level at which the content needs to be cached.

Recommended sku for the migration.

Defines the source of the SSL certificate.

Type of CertificateSourceParametersType.

Type of certificate used.

Describes operator to be matched.

Describes operator to be matched.

The kind of entity that created the resource.

Resource status of the custom domain.

Provisioning status of the custom domain.

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

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

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

The name of the action for the delivery rule.

Type of DeliveryRuleActionParametersType.

Type of DeliveryRuleConditionParametersType.

Type of DeploymentStatus.

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

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

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

Provisioning status of the endpoint.

Resource status of the endpoint.

Protocol this rule will use when forwarding traffic to backends.

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

Action to perform.

The type of health probe request that is made.

Describes operator to be matched.

Describes operator to be matched.

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.

Type of IsDeviceMatchConditionParametersMatchValuesItem.

Describes operator to be matched.

Type of KeyVaultSigningKeyParametersTypeName.

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

Type of LogMetric.

Type of LogMetricsGranularity.

Type of LogMetricsGroupBy.

Type of LogRanking.

Type of LogRankingMetric.

Describes if the managed rule is in enabled or disabled state.

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

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

Request variable to compare with.

Type of MetricsGranularity.

Type of MetricsSeriesUnit.

TLS protocol version that will be used for Https.

Describes operator to be matched.

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.

The type of the authentication for the origin.

Provisioning status of the origin group.

Resource status of the origin group.

Provisioning status of the origin.

Resource status of the origin.

Indicates the purpose of the parameter.

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

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

Resource status of the policy.

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

Describes operator to be matched.

The approval status for the connection to the Private Link.

Protocol to use for health probe.

Provisioning status of the profile.

Resource status of the profile.

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

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

Provisioning state of the WebApplicationFirewallPolicy.

Caching behavior for the requests.

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.

Describes operator to be matched.

The redirect type the rule will use when redirecting traffic.

Describes operator to be matched.

Describes operator to be matched.

Describes operator to be matched.

Type of RequestMethodMatchConditionParametersMatchValuesItem.

Describes operator to be matched.

Type of RequestSchemeMatchConditionParametersMatchValuesItem.

Describes operator to be matched.

Describes operator to be matched.

Type of CDN resource used in CheckNameAvailability.

Unit of the usage. e.g. count.

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

Caching behavior for the requests.

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.

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.

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

The variable to be scrubbed from the logs.

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

The type of the secret resource.

The type of the Security policy to create.

Describes operator to be matched.

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

Name of the pricing tier.

Describes operator to be matched.

The protocol of an established TLS connection.

Describes operator to be matched.

The validation status.

Describes what transforms are applied before matching.

Describes what transforms were applied before matching.

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

Describes operator to be matched.

Describes operator to be matched.

Describes operator to be matched.

An enum describing the unit of measurement.

Type of WafAction.

Type of WafGranularity.

Match variable to compare against.

Type of WafMetric.

Type of WafMetricsGranularity.

Type of WafMetricsSeriesUnit.

Type of WafRankingGroupBy.

Type of WafRankingType.

Type of WafRuleType.