Package-level declarations

Types

Link copied to clipboard
data class AFDDomainHttpsParametersResponse(val certificateType: String, val minimumTlsVersion: String? = null, val secret: ResourceReferenceResponse? = null)

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

Link copied to clipboard
data class CacheExpirationActionParametersResponse(val cacheBehavior: String, val cacheDuration: String? = null, val cacheType: String, val odataType: String)

Defines the parameters for the cache expiration action.

data class CacheKeyQueryStringActionParametersResponse(val odataType: String, val queryParameters: String? = null, val queryStringBehavior: String)

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

Link copied to clipboard
data class CdnCertificateSourceParametersResponse(val certificateType: String, val odataType: String)

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

Link copied to clipboard
data class CdnEndpointResponse(val id: String? = null)

Defines the ARM Resource ID for the linked endpoints

Link copied to clipboard
data class CdnManagedHttpsParametersResponse(val certificateSource: String, val certificateSourceParameters: CdnCertificateSourceParametersResponse, val minimumTlsVersion: String? = null, val protocolType: String)

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

Link copied to clipboard
data class CompressionSettingsResponse(val contentTypesToCompress: List<String>? = null, val isCompressionEnabled: Boolean? = null)

settings for compression.

Link copied to clipboard
data class CookiesMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val selector: String? = null, val transforms: List<String>? = null)

Defines the parameters for Cookies match conditions

Link copied to clipboard
data class CustomerCertificateParametersResponse(val certificateAuthority: String? = null, val secretSource: ResourceReferenceResponse, val secretVersion: String? = null, val subjectAlternativeNames: List<String>? = null, val type: String, val useLatestVersion: Boolean? = null)

Customer Certificate used for https

Link copied to clipboard
data class CustomRuleListResponse(val rules: List<CustomRuleResponse>? = null)

Defines contents of custom rules

Link copied to clipboard
data class CustomRuleResponse(val action: String, val enabledState: String? = null, val matchConditions: List<MatchConditionResponse>, val name: String, val priority: Int)

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

Link copied to clipboard
data class DeepCreatedOriginGroupResponse(val healthProbeSettings: HealthProbeParametersResponse? = null, val name: String, val origins: List<ResourceReferenceResponse>, val responseBasedOriginErrorDetectionSettings: ResponseBasedOriginErrorDetectionParametersResponse? = null, val trafficRestorationTimeToHealedOrNewEndpointsInMinutes: Int? = null)

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.

Link copied to clipboard
data class DeepCreatedOriginResponse(val enabled: Boolean? = null, val hostName: String, val httpPort: Int? = null, val httpsPort: Int? = null, val name: String, val originHostHeader: String? = null, val priority: Int? = null, val privateLinkAlias: String? = null, val privateLinkApprovalMessage: String? = null, val privateLinkLocation: String? = null, val privateLinkResourceId: String? = null, val weight: Int? = null)

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

Defines the cache expiration action for the delivery rule.

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

Link copied to clipboard

Defines the Cookies condition for the delivery rule.

Link copied to clipboard

Defines the HttpVersion condition for the delivery rule.

Link copied to clipboard

Defines the IsDevice condition for the delivery rule.

Link copied to clipboard

Defines the PostArgs condition for the delivery rule.

Link copied to clipboard

Defines the QueryString condition for the delivery rule.

Defines the RemoteAddress condition for the delivery rule.

Link copied to clipboard

Defines the RequestBody condition for the delivery rule.

Link copied to clipboard

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.

Link copied to clipboard

Defines the RequestUri condition for the delivery rule.

Link copied to clipboard
data class DeliveryRuleResponse(val actions: List<Any>, val conditions: List<Any>? = null, val name: String? = null, val order: Int)

A rule that specifies a set of actions and conditions

Link copied to clipboard

Defines the response header action for the delivery rule.

Defines the UrlFileExtension condition for the delivery rule.

Link copied to clipboard

Defines the UrlFileName condition for the delivery rule.

Link copied to clipboard

Defines the UrlPath condition for the delivery rule.

Link copied to clipboard
data class DomainValidationPropertiesResponse(val expirationDate: String, val validationToken: String)

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

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

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

Link copied to clipboard
data class GeoFilterResponse(val action: String, val countryCodes: List<String>, val relativePath: String)

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

Link copied to clipboard
data class GetAFDCustomDomainResult(val azureDnsZone: ResourceReferenceResponse? = null, val deploymentStatus: String, val domainValidationState: String, val hostName: String, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tlsSettings: AFDDomainHttpsParametersResponse? = null, val type: String, val validationProperties: DomainValidationPropertiesResponse)

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

Link copied to clipboard
data class GetAFDEndpointResult(val deploymentStatus: String, val enabledState: String? = null, val hostName: String, val id: String, val location: String, val name: String, val originResponseTimeoutSeconds: Int? = null, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

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

Link copied to clipboard
data class GetAFDOriginGroupResult(val deploymentStatus: String, val healthProbeSettings: HealthProbeParametersResponse? = null, val id: String, val loadBalancingSettings: LoadBalancingSettingsParametersResponse? = null, val name: String, val provisioningState: String, val responseBasedAfdOriginErrorDetectionSettings: ResponseBasedOriginErrorDetectionParametersResponse? = null, val sessionAffinityState: String? = null, val systemData: SystemDataResponse, val trafficRestorationTimeToHealedOrNewEndpointsInMinutes: Int? = null, val type: String)

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

Link copied to clipboard
data class GetAFDOriginResult(val azureOrigin: ResourceReferenceResponse? = null, val deploymentStatus: String, val enabledState: String? = null, val hostName: String, val httpPort: Int? = null, val httpsPort: Int? = null, val id: String, val name: String, val originHostHeader: String? = null, val priority: Int? = null, val provisioningState: String, val sharedPrivateLinkResource: SharedPrivateLinkResourcePropertiesResponse? = null, val systemData: SystemDataResponse, val type: String, val weight: Int? = null)

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.

Link copied to clipboard
data class GetCustomDomainResult(val customHttpsParameters: Either<CdnManagedHttpsParametersResponse, UserManagedHttpsParametersResponse>? = null, val customHttpsProvisioningState: String, val customHttpsProvisioningSubstate: String, val hostName: String, val id: String, val name: String, val provisioningState: String, val resourceState: String, val systemData: SystemDataResponse, val type: String, val validationData: String? = null)

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

Link copied to clipboard
data class GetEndpointResult(val contentTypesToCompress: List<String>? = null, val defaultOriginGroup: ResourceReferenceResponse? = null, val deliveryPolicy: EndpointPropertiesUpdateParametersResponseDeliveryPolicy? = null, val geoFilters: List<GeoFilterResponse>? = null, val hostName: String, val id: String, val isCompressionEnabled: Boolean? = null, val isHttpAllowed: Boolean? = null, val isHttpsAllowed: Boolean? = null, val location: String, val name: String, val optimizationType: String? = null, val originGroups: List<DeepCreatedOriginGroupResponse>? = null, val originHostHeader: String? = null, val originPath: String? = null, val origins: List<DeepCreatedOriginResponse>, val probePath: String? = null, val provisioningState: String, val queryStringCachingBehavior: String? = null, val resourceState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val urlSigningKeys: List<UrlSigningKeyResponse>? = null, val webApplicationFirewallPolicyLink: EndpointPropertiesUpdateParametersResponseWebApplicationFirewallPolicyLink? = null)

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 .azureedge.net.

Link copied to clipboard
data class GetOriginGroupResult(val healthProbeSettings: HealthProbeParametersResponse? = null, val id: String, val name: String, val origins: List<ResourceReferenceResponse>, val provisioningState: String, val resourceState: String, val responseBasedOriginErrorDetectionSettings: ResponseBasedOriginErrorDetectionParametersResponse? = null, val systemData: SystemDataResponse, val trafficRestorationTimeToHealedOrNewEndpointsInMinutes: Int? = null, val type: String)

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

Link copied to clipboard
data class GetOriginResult(val enabled: Boolean? = null, val hostName: String, val httpPort: Int? = null, val httpsPort: Int? = null, val id: String, val name: String, val originHostHeader: String? = null, val priority: Int? = null, val privateEndpointStatus: String, val privateLinkAlias: String? = null, val privateLinkApprovalMessage: String? = null, val privateLinkLocation: String? = null, val privateLinkResourceId: String? = null, val provisioningState: String, val resourceState: String, val systemData: SystemDataResponse, val type: String, val weight: Int? = null)

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.

Link copied to clipboard
data class GetPolicyResult(val customRules: CustomRuleListResponse? = null, val endpointLinks: List<CdnEndpointResponse>, val etag: String? = null, val id: String, val location: String, val managedRules: ManagedRuleSetListResponse? = null, val name: String, val policySettings: PolicySettingsResponse? = null, val provisioningState: String, val rateLimitRules: RateLimitRuleListResponse? = null, val resourceState: String, val sku: SkuResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Defines web application firewall policy for Azure CDN.

Link copied to clipboard
data class GetProfileResult(val frontdoorId: String, val id: String, val location: String, val name: String, val provisioningState: String, val resourceState: String, val sku: SkuResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

CDN profile is a logical grouping of endpoints that share the same settings, such as CDN provider and pricing tier.

data class GetProfileSupportedOptimizationTypesResult(val supportedOptimizationTypes: List<String>)

The result of the GetSupportedOptimizationTypes API

Link copied to clipboard
data class GetRouteResult(val compressionSettings: CompressionSettingsResponse? = null, val customDomains: List<ResourceReferenceResponse>? = null, val deploymentStatus: String, val enabledState: String? = null, val forwardingProtocol: String? = null, val httpsRedirect: String? = null, val id: String, val linkToDefaultDomain: String? = null, val name: String, val originGroup: ResourceReferenceResponse, val originPath: String? = null, val patternsToMatch: List<String>? = null, val provisioningState: String, val queryStringCachingBehavior: String? = null, val ruleSets: List<ResourceReferenceResponse>? = null, val supportedProtocols: List<String>? = null, val systemData: SystemDataResponse, val type: String)

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

Link copied to clipboard
data class GetRuleResult(val actions: List<Any>, val conditions: List<Any>? = null, val deploymentStatus: String, val id: String, val matchProcessingBehavior: String? = null, val name: String, val order: Int, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

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

Link copied to clipboard
data class GetRuleSetResult(val deploymentStatus: String, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

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

Link copied to clipboard
data class GetSecretResult(val deploymentStatus: String, val id: String, val name: String, val parameters: Any? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

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

Link copied to clipboard
data class GetSecurityPolicyResult(val deploymentStatus: String, val id: String, val name: String, val parameters: SecurityPolicyWebApplicationFirewallParametersResponse? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

SecurityPolicy association for AzureFrontDoor profile

Link copied to clipboard
data class HeaderActionParametersResponse(val headerAction: String, val headerName: String, val odataType: String, val value: String? = null)

Defines the parameters for the request header action.

Link copied to clipboard
data class HealthProbeParametersResponse(val probeIntervalInSeconds: Int? = null, val probePath: String? = null, val probeProtocol: String? = null, val probeRequestType: String? = null)

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

Link copied to clipboard
data class HttpErrorRangeParametersResponse(val begin: Int? = null, val end: Int? = null)

The JSON object that represents the range for http status codes

data class HttpVersionMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String)

Defines the parameters for HttpVersion match conditions

Link copied to clipboard
data class IsDeviceMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val transforms: List<String>? = null)

Defines the parameters for IsDevice match conditions

data class KeyVaultCertificateSourceParametersResponse(val deleteRule: String, val odataType: String, val resourceGroupName: String, val secretName: String, val secretVersion: String? = null, val subscriptionId: String, val updateRule: String, val vaultName: String)

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

Link copied to clipboard
data class KeyVaultSigningKeyParametersResponse(val odataType: String, val resourceGroupName: String, val secretName: String, val secretVersion: String, val subscriptionId: String, val vaultName: String)

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

Link copied to clipboard
data class LoadBalancingSettingsParametersResponse(val additionalLatencyInMilliseconds: Int? = null, val sampleSize: Int? = null, val successfulSamplesRequired: Int? = null)

Round-Robin load balancing settings for a backend pool

Link copied to clipboard

Managed Certificate used for https

Link copied to clipboard
data class ManagedRuleGroupOverrideResponse(val ruleGroupName: String, val rules: List<ManagedRuleOverrideResponse>? = null)

Defines a managed rule group override setting.

Link copied to clipboard
data class ManagedRuleOverrideResponse(val action: String? = null, val enabledState: String? = null, val ruleId: String)

Defines a managed rule group override setting.

Link copied to clipboard
data class ManagedRuleSetListResponse(val managedRuleSets: List<ManagedRuleSetResponse>? = null)

Defines the list of managed rule sets for the policy.

Link copied to clipboard
data class ManagedRuleSetResponse(val anomalyScore: Int? = null, val ruleGroupOverrides: List<ManagedRuleGroupOverrideResponse>? = null, val ruleSetType: String, val ruleSetVersion: String)

Defines a managed rule set.

Link copied to clipboard
data class MatchConditionResponse(val matchValue: List<String>, val matchVariable: String, val negateCondition: Boolean? = null, val operator: String, val selector: String? = null, val transforms: List<String>? = null)

Define match conditions

Defines the parameters for the origin group override action.

Link copied to clipboard

Defines the origin group override action for the delivery rule.

Link copied to clipboard
data class PolicySettingsResponse(val defaultCustomBlockResponseBody: String? = null, val defaultCustomBlockResponseStatusCode: Int? = null, val defaultRedirectUrl: String? = null, val enabledState: String? = null, val mode: String? = null)

Defines contents of a web application firewall global configuration

Link copied to clipboard
data class PostArgsMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val selector: String? = null, val transforms: List<String>? = null)

Defines the parameters for PostArgs match conditions

data class QueryStringMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val transforms: List<String>? = null)

Defines the parameters for QueryString match conditions

Link copied to clipboard
data class RateLimitRuleListResponse(val rules: List<RateLimitRuleResponse>? = null)

Defines contents of rate limit rules

Link copied to clipboard
data class RateLimitRuleResponse(val action: String, val enabledState: String? = null, val matchConditions: List<MatchConditionResponse>, val name: String, val priority: Int, val rateLimitDurationInMinutes: Int, val rateLimitThreshold: Int)

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

data class RemoteAddressMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val transforms: List<String>? = null)

Defines the parameters for RemoteAddress match conditions

data class RequestBodyMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val transforms: List<String>? = null)

Defines the parameters for RequestBody match conditions

data class RequestHeaderMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val selector: String? = null, val transforms: List<String>? = null)

Defines the parameters for RequestHeader match conditions

data class RequestMethodMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String)

Defines the parameters for RequestMethod match conditions

data class RequestSchemeMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String)

Defines the parameters for RequestScheme match conditions

data class RequestUriMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val transforms: List<String>? = null)

Defines the parameters for RequestUri match conditions

Link copied to clipboard
data class ResourceReferenceResponse(val id: String? = null)

Reference to another resource.

data class ResponseBasedOriginErrorDetectionParametersResponse(val httpErrorRanges: List<HttpErrorRangeParametersResponse>? = null, val responseBasedDetectedErrorTypes: String? = null, val responseBasedFailoverThresholdPercentage: Int? = null)

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

data class SecurityPolicyWebApplicationFirewallAssociationResponse(val domains: List<ResourceReferenceResponse>? = null, val patternsToMatch: List<String>? = null)

settings for security policy patterns to match

The json object containing security policy waf parameters

data class SharedPrivateLinkResourcePropertiesResponse(val groupId: String? = null, val privateLink: ResourceReferenceResponse? = null, val privateLinkLocation: String? = null, val requestMessage: String? = null, val status: String? = null)

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

Link copied to clipboard
data class SkuResponse(val name: String? = null)

The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Read only system data

data class UrlFileExtensionMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val transforms: List<String>? = null)

Defines the parameters for UrlFileExtension match conditions

data class UrlFileNameMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val transforms: List<String>? = null)

Defines the parameters for UrlFilename match conditions

Link copied to clipboard
data class UrlPathMatchConditionParametersResponse(val matchValues: List<String>? = null, val negateCondition: Boolean? = null, val odataType: String, val operator: String, val transforms: List<String>? = null)

Defines the parameters for UrlPath match conditions

Link copied to clipboard
data class UrlRedirectActionParametersResponse(val customFragment: String? = null, val customHostname: String? = null, val customPath: String? = null, val customQueryString: String? = null, val destinationProtocol: String? = null, val odataType: String, val redirectType: String)

Defines the parameters for the url redirect action.

Link copied to clipboard

Defines the url redirect action for the delivery rule.

Link copied to clipboard
data class UrlRewriteActionParametersResponse(val destination: String, val odataType: String, val preserveUnmatchedPath: Boolean? = null, val sourcePattern: String)

Defines the parameters for the url rewrite action.

Link copied to clipboard

Defines the url rewrite action for the delivery rule.

Link copied to clipboard
data class UrlSigningActionParametersResponse(val algorithm: String? = null, val odataType: String, val parameterNameOverride: List<UrlSigningParamIdentifierResponse>? = null)

Defines the parameters for the Url Signing action.

Link copied to clipboard

Defines the url signing action for the delivery rule.

Link copied to clipboard
data class UrlSigningKeyParametersResponse(val keyId: String, val secretSource: ResourceReferenceResponse, val secretVersion: String? = null, val type: String)

Url signing key parameters

Link copied to clipboard
data class UrlSigningKeyResponse(val keyId: String, val keySourceParameters: KeyVaultSigningKeyParametersResponse)

Url signing key

Link copied to clipboard
data class UrlSigningParamIdentifierResponse(val paramIndicator: String, val paramName: String)

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

Link copied to clipboard
data class UserManagedHttpsParametersResponse(val certificateSource: String, val certificateSourceParameters: KeyVaultCertificateSourceParametersResponse, val minimumTlsVersion: String? = null, val protocolType: String)

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