@azure/arm-cdn package
Classes
| CdnManagementClient |
Interfaces
| AFDCustomDomainsCreateOptionalParams |
Optional parameters. |
| AFDCustomDomainsDeleteOptionalParams |
Optional parameters. |
| AFDCustomDomainsGetOptionalParams |
Optional parameters. |
| AFDCustomDomainsListByProfileOptionalParams |
Optional parameters. |
| AFDCustomDomainsOperations |
Interface representing a AFDCustomDomains operations. |
| AFDCustomDomainsRefreshValidationTokenOptionalParams |
Optional parameters. |
| AFDCustomDomainsUpdateOptionalParams |
Optional parameters. |
| AFDDomain |
Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. |
| AFDDomainHttpsCustomizedCipherSuiteSet |
Customized cipher suite set object that will be used for Https when cipherSuiteSetType is Customized. |
| AFDDomainHttpsParameters |
The JSON object that contains the properties to secure a domain. |
| AFDDomainProperties |
The JSON object that contains the properties of the domain to create. |
| AFDDomainUpdateParameters |
The domain JSON object required for domain creation or update. |
| AFDDomainUpdatePropertiesParameters |
The JSON object that contains the properties of the domain to create. |
| 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. |
| AFDEndpointProperties |
The JSON object that contains the properties required to create an endpoint. |
| AFDEndpointPropertiesUpdateParameters |
The JSON object containing endpoint update parameters. |
| AFDEndpointUpdateParameters |
Properties required to create or update an endpoint. |
| AFDEndpointsCreateOptionalParams |
Optional parameters. |
| AFDEndpointsDeleteOptionalParams |
Optional parameters. |
| AFDEndpointsGetOptionalParams |
Optional parameters. |
| AFDEndpointsListByProfileOptionalParams |
Optional parameters. |
| AFDEndpointsListResourceUsageOptionalParams |
Optional parameters. |
| AFDEndpointsOperations |
Interface representing a AFDEndpoints operations. |
| AFDEndpointsPurgeContentOptionalParams |
Optional parameters. |
| AFDEndpointsUpdateOptionalParams |
Optional parameters. |
| AFDEndpointsValidateCustomDomainOptionalParams |
Optional parameters. |
| 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. |
| AFDOriginGroup |
AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door. |
| AFDOriginGroupProperties |
The JSON object that contains the properties of the origin group. |
| AFDOriginGroupUpdateParameters |
AFDOrigin group properties needed for origin group creation or update. |
| AFDOriginGroupUpdatePropertiesParameters |
The JSON object that contains the properties of the origin group. |
| AFDOriginGroupsCreateOptionalParams |
Optional parameters. |
| AFDOriginGroupsDeleteOptionalParams |
Optional parameters. |
| AFDOriginGroupsGetOptionalParams |
Optional parameters. |
| AFDOriginGroupsListByProfileOptionalParams |
Optional parameters. |
| AFDOriginGroupsListResourceUsageOptionalParams |
Optional parameters. |
| AFDOriginGroupsOperations |
Interface representing a AFDOriginGroups operations. |
| AFDOriginGroupsUpdateOptionalParams |
Optional parameters. |
| AFDOriginProperties |
The JSON object that contains the properties of the origin. |
| AFDOriginUpdateParameters |
AFDOrigin properties needed for origin update. |
| AFDOriginUpdatePropertiesParameters |
The JSON object that contains the properties of the origin. |
| AFDOriginsCreateOptionalParams |
Optional parameters. |
| AFDOriginsDeleteOptionalParams |
Optional parameters. |
| AFDOriginsGetOptionalParams |
Optional parameters. |
| AFDOriginsListByOriginGroupOptionalParams |
Optional parameters. |
| AFDOriginsOperations |
Interface representing a AFDOrigins operations. |
| AFDOriginsUpdateOptionalParams |
Optional parameters. |
| AFDProfilesCheckEndpointNameAvailabilityOptionalParams |
Optional parameters. |
| AFDProfilesCheckHostNameAvailabilityOptionalParams |
Optional parameters. |
| AFDProfilesListResourceUsageOptionalParams |
Optional parameters. |
| AFDProfilesOperations |
Interface representing a AFDProfiles operations. |
| AFDProfilesUpgradeOptionalParams |
Optional parameters. |
| AFDProfilesValidateSecretOptionalParams |
Optional parameters. |
| AFDStateProperties |
The tracking states for afd resources. |
| ActivatedResourceReference |
Reference to another resource along with its state. |
| AfdPurgeParameters |
Parameters required for content purge. |
| AfdRouteCacheConfiguration |
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. |
| AzureFirstPartyManagedCertificateParameters |
Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS. |
| BatchRuleProperties |
The JSON object that contains a rule with its name for batch mode operations. |
| 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. |
| CacheKeyQueryStringActionParameters |
Defines the parameters for the cache-key query string action. |
| CanMigrateParameters |
Request body for CanMigrate operation. |
| CanMigrateProperties |
model interface CanMigrateProperties |
| CanMigrateResult |
Result for canMigrate operation. |
| CdnCertificateSourceParameters |
Defines the parameters for using CDN managed certificate for securing custom domain. |
| CdnEndpoint |
Defines the ARM Resource ID for the linked endpoints |
| CdnManagedHttpsParameters |
Defines the certificate source parameters using CDN managed certificate for enabling SSL. |
| CdnManagementClientOptionalParams |
Optional parameters for the client. |
| CdnMigrationToAfdParameters |
Request body for Migrate operation. |
| CdnWebApplicationFirewallPolicy |
Defines web application firewall policy for Azure CDN. |
| CdnWebApplicationFirewallPolicyPatchParameters |
Properties required to update a CdnWebApplicationFirewallPolicy. |
| CdnWebApplicationFirewallPolicyProperties |
Defines CDN web application firewall policy properties. |
| CertificateSourceParameters |
Defines the parameters for certificate source |
| CheckEndpointNameAvailabilityInput |
Input of CheckNameAvailability API. |
| CheckEndpointNameAvailabilityOptionalParams |
Optional parameters. |
| CheckEndpointNameAvailabilityOutput |
Output of check name availability API. |
| CheckHostNameAvailabilityInput |
Input of CheckHostNameAvailability API. |
| CheckNameAvailabilityInput |
Input of CheckNameAvailability API. |
| CheckNameAvailabilityOptionalParams |
Optional parameters. |
| CheckNameAvailabilityOutput |
Output of check name availability API. |
| CheckNameAvailabilityWithSubscriptionOptionalParams |
Optional parameters. |
| CidrIpAddress |
CIDR Ip address |
| ClientPortMatchConditionParameters |
Defines the parameters for ClientPort match conditions |
| Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems |
model interface Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems |
| Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems |
model interface Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems |
| ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems |
model interface ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems |
| CompressionSettings |
settings for compression. |
| ContinentsResponse |
Continents Response |
| ContinentsResponseContinentsItem |
model interface ContinentsResponseContinentsItem |
| ContinentsResponseCountryOrRegionsItem |
model interface ContinentsResponseCountryOrRegionsItem |
| CookiesMatchConditionParameters |
Defines the parameters for Cookies match conditions |
| CustomDomain |
Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. |
| CustomDomainHttpsParameters |
The JSON object that contains the properties to secure a custom domain. |
| CustomDomainParameters |
The customDomain JSON object required for custom domain creation or update. |
| CustomDomainProperties |
The JSON object that contains the properties of the custom domain to create. |
| CustomDomainPropertiesParameters |
The JSON object that contains the properties of the custom domain to create. |
| CustomDomainsCreateOptionalParams |
Optional parameters. |
| CustomDomainsDeleteOptionalParams |
Optional parameters. |
| CustomDomainsDisableCustomHttpsOptionalParams |
Optional parameters. |
| CustomDomainsEnableCustomHttpsOptionalParams |
Optional parameters. |
| CustomDomainsGetOptionalParams |
Optional parameters. |
| CustomDomainsListByEndpointOptionalParams |
Optional parameters. |
| CustomDomainsOperations |
Interface representing a CustomDomains operations. |
| CustomRule |
Defines the common attributes for a custom rule that can be included in a waf policy |
| CustomRuleList |
Defines contents of custom rules |
| CustomerCertificateParameters |
Customer Certificate used for https |
| DeepCreatedCustomDomain |
Custom domains created on the CDN endpoint. |
| DeepCreatedCustomDomainProperties |
Properties of the custom domain created on the CDN endpoint. |
| DeepCreatedOrigin |
The main origin of CDN content which is added when creating a CDN endpoint. |
| 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. |
| DeepCreatedOriginGroupProperties |
Properties of the origin group created on the CDN endpoint. |
| DeepCreatedOriginProperties |
Properties of the origin created on the CDN endpoint. |
| DeliveryRule |
A rule that specifies a set of actions and conditions |
| DeliveryRuleAction |
An action for the delivery rule. |
| DeliveryRuleActionParameters |
Defines the parameters for delivery rule actions |
| DeliveryRuleCacheExpirationAction |
Defines the cache expiration action for the delivery rule. |
| DeliveryRuleCacheKeyQueryStringAction |
Defines the cache-key query string action for the delivery rule. |
| DeliveryRuleClientPortCondition |
Defines the ClientPort condition for the delivery rule. |
| DeliveryRuleCondition |
A condition for the delivery rule. |
| DeliveryRuleConditionParameters |
Defines the parameters for delivery rule match conditions |
| DeliveryRuleCookiesCondition |
Defines the Cookies condition for the delivery rule. |
| DeliveryRuleHostNameCondition |
Defines the HostName condition for the delivery rule. |
| DeliveryRuleHttpVersionCondition |
Defines the HttpVersion condition for the delivery rule. |
| DeliveryRuleIsDeviceCondition |
Defines the IsDevice condition for the delivery rule. |
| DeliveryRulePostArgsCondition |
Defines the PostArgs condition for the delivery rule. |
| DeliveryRuleQueryStringCondition |
Defines the QueryString condition for the delivery rule. |
| DeliveryRuleRemoteAddressCondition |
Defines the RemoteAddress condition for the delivery rule. |
| DeliveryRuleRequestBodyCondition |
Defines the RequestBody condition for the delivery rule. |
| DeliveryRuleRequestHeaderAction |
Defines the request header action for the delivery rule. |
| DeliveryRuleRequestHeaderCondition |
Defines the RequestHeader condition for the delivery rule. |
| DeliveryRuleRequestMethodCondition |
Defines the RequestMethod condition for the delivery rule. |
| DeliveryRuleRequestSchemeCondition |
Defines the RequestScheme condition for the delivery rule. |
| DeliveryRuleRequestUriCondition |
Defines the RequestUri condition for the delivery rule. |
| DeliveryRuleResponseHeaderAction |
Defines the response header action for the delivery rule. |
| DeliveryRuleRouteConfigurationOverrideAction |
Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles. |
| DeliveryRuleServerPortCondition |
Defines the ServerPort condition for the delivery rule. |
| DeliveryRuleSocketAddrCondition |
Defines the SocketAddress condition for the delivery rule. |
| DeliveryRuleSslProtocolCondition |
Defines the SslProtocol condition for the delivery rule. |
| DeliveryRuleUrlFileExtensionCondition |
Defines the UrlFileExtension condition for the delivery rule. |
| DeliveryRuleUrlFileNameCondition |
Defines the UrlFileName condition for the delivery rule. |
| DeliveryRuleUrlPathCondition |
Defines the UrlPath condition for the delivery rule. |
| DimensionProperties |
Type of operation: get, read, delete, etc. |
| DomainValidationProperties |
The JSON object that contains the properties to validate a domain. |
| EdgeNode |
Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users. |
| EdgeNodeProperties |
The JSON object that contains the properties required to create an edgenode. |
| EdgeNodesListOptionalParams |
Optional parameters. |
| EdgeNodesOperations |
Interface representing a EdgeNodes operations. |
| 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. |
| EndpointProperties |
The JSON object that contains the properties required to create an endpoint. |
| EndpointPropertiesUpdateParameters |
The JSON object containing endpoint update parameters. |
| EndpointPropertiesUpdateParametersDeliveryPolicy |
A policy that specifies the delivery rules to be used for an endpoint. |
| EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink |
Defines the Web Application Firewall policy for the endpoint (if applicable) |
| EndpointUpdateParameters |
Properties required to create or update an endpoint. |
| EndpointsCreateOptionalParams |
Optional parameters. |
| EndpointsDeleteOptionalParams |
Optional parameters. |
| EndpointsGetOptionalParams |
Optional parameters. |
| EndpointsListByProfileOptionalParams |
Optional parameters. |
| EndpointsListResourceUsageOptionalParams |
Optional parameters. |
| EndpointsLoadContentOptionalParams |
Optional parameters. |
| EndpointsOperations |
Interface representing a Endpoints operations. |
| EndpointsPurgeContentOptionalParams |
Optional parameters. |
| EndpointsStartOptionalParams |
Optional parameters. |
| EndpointsStopOptionalParams |
Optional parameters. |
| EndpointsUpdateOptionalParams |
Optional parameters. |
| EndpointsValidateCustomDomainOptionalParams |
Optional parameters. |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. |
| GeoFilter |
Rules defining user's geo access within a CDN endpoint. |
| HeaderActionParameters |
Defines the parameters for the request header action. |
| HealthProbeParameters |
The JSON object that contains the properties to send health probes to origin. |
| HostNameMatchConditionParameters |
Defines the parameters for HostName match conditions |
| HttpErrorRangeParameters |
The JSON object that represents the range for http status codes |
| HttpVersionMatchConditionParameters |
Defines the parameters for HttpVersion match conditions |
| IpAddressGroup |
CDN Ip address group |
| IsDeviceMatchConditionParameters |
Defines the parameters for IsDevice match conditions |
| KeyVaultCertificateSourceParameters |
Describes the parameters for using a user's KeyVault certificate for securing custom domain. |
| KeyVaultSigningKeyParameters |
Describes the parameters for using a user's KeyVault for URL Signing Key. |
| LoadBalancingSettingsParameters |
Round-Robin load balancing settings for a backend pool |
| LoadParameters |
Parameters required for content load. |
| LogAnalyticsGetLogAnalyticsLocationsOptionalParams |
Optional parameters. |
| LogAnalyticsGetLogAnalyticsMetricsOptionalParams |
Optional parameters. |
| LogAnalyticsGetLogAnalyticsRankingsOptionalParams |
Optional parameters. |
| LogAnalyticsGetLogAnalyticsResourcesOptionalParams |
Optional parameters. |
| LogAnalyticsGetWafLogAnalyticsMetricsOptionalParams |
Optional parameters. |
| LogAnalyticsGetWafLogAnalyticsRankingsOptionalParams |
Optional parameters. |
| LogAnalyticsOperations |
Interface representing a LogAnalytics operations. |
| LogSpecification |
Log specification of operation. |
| ManagedCertificateParameters |
Managed Certificate used for https |
| ManagedRuleDefinition |
Describes a managed rule definition. |
| ManagedRuleGroupDefinition |
Describes a managed rule group. |
| ManagedRuleGroupOverride |
Defines a managed rule group override setting. |
| ManagedRuleOverride |
Defines a managed rule group override setting. |
| ManagedRuleSet |
Defines a managed rule set. |
| ManagedRuleSetDefinition |
Describes a managed rule set definition. |
| ManagedRuleSetDefinitionProperties |
Properties for a managed rule set definition. |
| ManagedRuleSetList |
Defines the list of managed rule sets for the policy. |
| ManagedRuleSetsListOptionalParams |
Optional parameters. |
| ManagedRuleSetsOperations |
Interface representing a ManagedRuleSets operations. |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| MatchCondition |
Define match conditions |
| MetricAvailability |
Retention policy of a resource metric. |
| MetricSpecification |
Metric specification of operation. |
| MetricsResponse |
Metrics Response |
| MetricsResponseSeriesItem |
model interface MetricsResponseSeriesItem |
| MetricsResponseSeriesPropertiesItemsItem |
model interface MetricsResponseSeriesPropertiesItemsItem |
| MigrateResult |
Result for migrate operation. |
| MigrateResultProperties |
model interface MigrateResultProperties |
| MigrationEndpointMapping |
CDN Endpoint Mapping. |
| MigrationErrorType |
Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message. |
| MigrationParameters |
Request body for Migrate operation. |
| MigrationWebApplicationFirewallMapping |
Web Application Firewall Mapping |
| Operation |
CDN REST API operation |
| OperationDisplay |
The object that represents the operation. |
| OperationProperties |
Properties of operation, include metric specifications. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| 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. |
| OriginAuthenticationProperties |
The JSON object that contains the properties of the origin authentication settings. |
| OriginGroup |
Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN. |
| OriginGroupOverride |
Defines the parameters for the origin group override configuration. |
| OriginGroupOverrideAction |
Defines the origin group override action for the delivery rule. |
| OriginGroupOverrideActionParameters |
Defines the parameters for the origin group override action. |
| OriginGroupProperties |
The JSON object that contains the properties of the origin group. |
| OriginGroupUpdateParameters |
Origin group properties needed for origin group creation or update. |
| OriginGroupUpdatePropertiesParameters |
The JSON object that contains the properties of the origin group. |
| OriginGroupsCreateOptionalParams |
Optional parameters. |
| OriginGroupsDeleteOptionalParams |
Optional parameters. |
| OriginGroupsGetOptionalParams |
Optional parameters. |
| OriginGroupsListByEndpointOptionalParams |
Optional parameters. |
| OriginGroupsOperations |
Interface representing a OriginGroups operations. |
| OriginGroupsUpdateOptionalParams |
Optional parameters. |
| OriginProperties |
The JSON object that contains the properties of the origin. |
| OriginUpdateParameters |
Origin properties needed for origin update. |
| OriginUpdatePropertiesParameters |
The JSON object that contains the properties of the origin. |
| OriginsCreateOptionalParams |
Optional parameters. |
| OriginsDeleteOptionalParams |
Optional parameters. |
| OriginsGetOptionalParams |
Optional parameters. |
| OriginsListByEndpointOptionalParams |
Optional parameters. |
| OriginsOperations |
Interface representing a Origins operations. |
| OriginsUpdateOptionalParams |
Optional parameters. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| PoliciesCreateOrUpdateOptionalParams |
Optional parameters. |
| PoliciesDeleteOptionalParams |
Optional parameters. |
| PoliciesGetOptionalParams |
Optional parameters. |
| PoliciesListOptionalParams |
Optional parameters. |
| PoliciesOperations |
Interface representing a Policies operations. |
| PoliciesUpdateOptionalParams |
Optional parameters. |
| PolicySettings |
Defines contents of a web application firewall global configuration |
| PostArgsMatchConditionParameters |
Defines the parameters for PostArgs match conditions |
| Profile |
A profile is a logical grouping of endpoints that share the same settings. |
| ProfileChangeSkuWafMapping |
Parameters required for profile upgrade. |
| ProfileLogScrubbing |
Defines rules that scrub sensitive fields in the Azure Front Door profile logs. |
| ProfileProperties |
The JSON object that contains the properties required to create a profile. |
| ProfilePropertiesUpdateParameters |
The JSON object containing profile update parameters. |
| ProfileScrubbingRules |
Defines the contents of the log scrubbing rules. |
| ProfileUpdateParameters |
Properties required to update a profile. |
| ProfileUpgradeParameters |
Parameters required for profile upgrade. |
| ProfilesCanMigrateOptionalParams |
Optional parameters. |
| ProfilesCdnCanMigrateToAfdOptionalParams |
Optional parameters. |
| ProfilesCdnMigrateToAfdOptionalParams |
Optional parameters. |
| ProfilesCreateOptionalParams |
Optional parameters. |
| ProfilesDeleteOptionalParams |
Optional parameters. |
| ProfilesGenerateSsoUriOptionalParams |
Optional parameters. |
| ProfilesGetOptionalParams |
Optional parameters. |
| ProfilesListByResourceGroupOptionalParams |
Optional parameters. |
| ProfilesListOptionalParams |
Optional parameters. |
| ProfilesListResourceUsageOptionalParams |
Optional parameters. |
| ProfilesListSupportedOptimizationTypesOptionalParams |
Optional parameters. |
| ProfilesMigrateOptionalParams |
Optional parameters. |
| ProfilesMigrationAbortOptionalParams |
Optional parameters. |
| ProfilesMigrationCommitOptionalParams |
Optional parameters. |
| ProfilesOperations |
Interface representing a Profiles operations. |
| ProfilesUpdateOptionalParams |
Optional parameters. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| PurgeParameters |
Parameters required for content purge. |
| QueryStringMatchConditionParameters |
Defines the parameters for QueryString match conditions |
| RankingsResponse |
Rankings Response |
| RankingsResponseTablesItem |
model interface RankingsResponseTablesItem |
| RankingsResponseTablesPropertiesItemsItem |
model interface RankingsResponseTablesPropertiesItemsItem |
| RankingsResponseTablesPropertiesItemsMetricsItem |
model interface RankingsResponseTablesPropertiesItemsMetricsItem |
| RateLimitRule |
Defines a rate limiting rule that can be included in a waf policy |
| RateLimitRuleList |
Defines contents of rate limit rules |
| RemoteAddressMatchConditionParameters |
Defines the parameters for RemoteAddress match conditions |
| RequestBodyMatchConditionParameters |
Defines the parameters for RequestBody match conditions |
| RequestHeaderMatchConditionParameters |
Defines the parameters for RequestHeader match conditions |
| RequestMethodMatchConditionParameters |
Defines the parameters for RequestMethod match conditions |
| RequestSchemeMatchConditionParameters |
Defines the parameters for RequestScheme match conditions |
| RequestUriMatchConditionParameters |
Defines the parameters for RequestUri match conditions |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceReference |
Reference to another resource. |
| ResourceUsage |
Output of check resource usage API. |
| ResourceUsageOperationsListOptionalParams |
Optional parameters. |
| ResourceUsageOperationsOperations |
Interface representing a ResourceUsageOperations operations. |
| ResourcesResponse |
Resources Response |
| ResourcesResponseCustomDomainsItem |
model interface ResourcesResponseCustomDomainsItem |
| ResourcesResponseEndpointsItem |
model interface ResourcesResponseEndpointsItem |
| ResourcesResponseEndpointsPropertiesItemsItem |
model interface ResourcesResponseEndpointsPropertiesItemsItem |
| ResponseBasedOriginErrorDetectionParameters |
The JSON object that contains the properties to determine origin health using real requests/responses. |
| RestorePollerOptions | |
| Route |
Friendly Routes name mapping to the any Routes or secret related information. |
| RouteConfigurationOverrideActionParameters |
Defines the parameters for the route configuration override action. |
| RouteProperties |
The JSON object that contains the properties of the Routes to create. |
| RouteUpdateParameters |
The domain JSON object required for domain creation or update. |
| RouteUpdatePropertiesParameters |
The JSON object that contains the properties of the domain to create. |
| RoutesCreateOptionalParams |
Optional parameters. |
| RoutesDeleteOptionalParams |
Optional parameters. |
| RoutesGetOptionalParams |
Optional parameters. |
| RoutesListByEndpointOptionalParams |
Optional parameters. |
| RoutesOperations |
Interface representing a Routes operations. |
| RoutesUpdateOptionalParams |
Optional parameters. |
| Rule |
Friendly Rules name mapping to the any Rules or secret related information. |
| RuleProperties |
The JSON object that contains the properties of the Rules to create. |
| RuleSet |
Friendly RuleSet name mapping to the any RuleSet or secret related information. |
| RuleSetProperties |
The JSON object that contains the properties of the Rule Set to create. |
| RuleSetsCreateOptionalParams |
Optional parameters. |
| RuleSetsDeleteOptionalParams |
Optional parameters. |
| RuleSetsGetOptionalParams |
Optional parameters. |
| RuleSetsListByProfileOptionalParams |
Optional parameters. |
| RuleSetsListResourceUsageOptionalParams |
Optional parameters. |
| RuleSetsOperations |
Interface representing a RuleSets operations. |
| RuleUpdateParameters |
The domain JSON object required for domain creation or update. |
| RuleUpdatePropertiesParameters |
The JSON object that contains the properties of the rule to update. |
| RulesCreateOptionalParams |
Optional parameters. |
| RulesDeleteOptionalParams |
Optional parameters. |
| RulesGetOptionalParams |
Optional parameters. |
| RulesListByRuleSetOptionalParams |
Optional parameters. |
| RulesOperations |
Interface representing a Rules operations. |
| RulesUpdateOptionalParams |
Optional parameters. |
| Secret |
Friendly Secret name mapping to the any Secret or secret related information. |
| SecretParameters |
The json object containing secret parameters |
| SecretProperties |
The JSON object that contains the properties of the Secret to create. |
| SecretsCreateOptionalParams |
Optional parameters. |
| SecretsDeleteOptionalParams |
Optional parameters. |
| SecretsGetOptionalParams |
Optional parameters. |
| SecretsListByProfileOptionalParams |
Optional parameters. |
| SecretsOperations |
Interface representing a Secrets operations. |
| SecurityPoliciesCreateOptionalParams |
Optional parameters. |
| SecurityPoliciesDeleteOptionalParams |
Optional parameters. |
| SecurityPoliciesGetOptionalParams |
Optional parameters. |
| SecurityPoliciesListByProfileOptionalParams |
Optional parameters. |
| SecurityPoliciesOperations |
Interface representing a SecurityPolicies operations. |
| SecurityPoliciesPatchOptionalParams |
Optional parameters. |
| SecurityPolicy |
SecurityPolicy association for AzureFrontDoor profile |
| SecurityPolicyProperties |
The json object that contains properties required to create a security policy |
| SecurityPolicyPropertiesParameters |
The json object containing security policy parameters |
| SecurityPolicyUpdateParameters |
The JSON object containing security policy update parameters. |
| SecurityPolicyUpdateProperties |
The json object that contains properties required to update a security policy |
| SecurityPolicyWebApplicationFirewallAssociation |
settings for security policy patterns to match |
| SecurityPolicyWebApplicationFirewallParameters |
The json object containing security policy waf parameters |
| ServerPortMatchConditionParameters |
Defines the parameters for ServerPort match conditions |
| 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. |
| SimplePollerLike |
A simple poller that can be used to poll a long running operation. |
| 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 |
| SslProtocolMatchConditionParameters |
Defines the parameters for SslProtocol match conditions |
| SsoUri |
The URI required to login to the supplemental portal from the Azure portal. |
| SupportedOptimizationTypesListResult |
The result of the GetSupportedOptimizationTypes API |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| UrlFileExtensionMatchConditionParameters |
Defines the parameters for UrlFileExtension match conditions |
| UrlFileNameMatchConditionParameters |
Defines the parameters for UrlFilename match conditions |
| UrlPathMatchConditionParameters |
Defines the parameters for UrlPath match conditions |
| UrlRedirectAction |
Defines the url redirect action for the delivery rule. |
| UrlRedirectActionParameters |
Defines the parameters for the url redirect action. |
| UrlRewriteAction |
Defines the url rewrite action for the delivery rule. |
| UrlRewriteActionParameters |
Defines the parameters for the url rewrite action. |
| UrlSigningAction |
Defines the url signing action for the delivery rule. |
| UrlSigningActionParameters |
Defines the parameters for the Url Signing action. |
| UrlSigningKey |
Url signing key |
| UrlSigningKeyParameters |
Url signing key parameters |
| UrlSigningParamIdentifier |
Defines how to identify a parameter for a specific purpose e.g. expires |
| Usage |
Describes resource usage. |
| UsageName |
The usage names. |
| UserAssignedIdentity |
User assigned identity properties |
| UserManagedHttpsParameters |
Defines the certificate source parameters using user's keyvault certificate for enabling SSL. |
| ValidateCustomDomainInput |
Input of the custom domain to be validated for DNS mapping. |
| ValidateCustomDomainOutput |
Output of custom domain validation. |
| ValidateProbeInput |
Input of the validate probe API. |
| ValidateProbeOptionalParams |
Optional parameters. |
| ValidateProbeOutput |
Output of the validate probe API. |
| ValidateSecretInput |
Input of the secret to be validated. |
| ValidateSecretOutput |
Output of the validated secret. |
| WafMetricsResponse |
Waf Metrics Response |
| WafMetricsResponseSeriesItem |
model interface WafMetricsResponseSeriesItem |
| WafMetricsResponseSeriesPropertiesItemsItem |
model interface WafMetricsResponseSeriesPropertiesItemsItem |
| WafRankingsResponse |
Waf Rankings Response |
| WafRankingsResponseDataItem |
model interface WafRankingsResponseDataItem |
Type Aliases
| AFDEndpointProtocols |
Supported protocols for the customer's endpoint. Known values supported by the serviceHttp |
| ActionType |
Defines the action to take on rule match. Known values supported by the serviceAllow |
| AfdCertificateType |
Defines the source of the SSL certificate. Known values supported by the serviceCustomerCertificate |
| AfdCipherSuiteSetType |
cipher suite set type that will be used for Https Known values supported by the serviceCustomized |
| AfdCustomizedCipherSuiteForTls12 |
Type of AfdCustomizedCipherSuiteForTls12 |
| AfdCustomizedCipherSuiteForTls13 |
Type of AfdCustomizedCipherSuiteForTls13 |
| AfdMinimumTlsVersion |
TLS protocol version that will be used for Https when cipherSuiteSetType is Customized. |
| AfdProvisioningState |
Provisioning status Known values supported by the serviceSucceeded |
| 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. Known values supported by the serviceIgnoreQueryString |
| Algorithm |
Algorithm to use for URL signing Known values supported by the serviceSHA256 |
| AutoGeneratedDomainNameLabelScope |
Indicates the endpoint name reuse scope. The default value is TenantReuse. Known values supported by the serviceTenantReuse |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| CacheBehavior |
Caching behavior for the requests Known values supported by the serviceBypassCache |
| CacheType |
The level at which the content needs to be cached. Known values supported by the serviceAll |
| CanMigrateDefaultSku |
Recommended sku for the migration Known values supported by the serviceStandard_AzureFrontDoor |
| CertificateSource |
Defines the source of the SSL certificate. Known values supported by the serviceAzureKeyVault |
| CertificateSourceParametersType |
Type of CertificateSourceParametersType |
| CertificateSourceParametersUnion |
Alias for CertificateSourceParametersUnion |
| CertificateType |
Type of certificate used Known values supported by the serviceShared |
| ClientPortOperator |
Describes operator to be matched Known values supported by the serviceAny |
| ContinuablePage |
An interface that describes a page of results. |
| CookiesOperator |
Describes operator to be matched Known values supported by the serviceAny |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| CustomDomainHttpsParametersUnion |
Alias for CustomDomainHttpsParametersUnion |
| CustomDomainResourceState |
Resource status of the custom domain. Known values supported by the serviceCreating |
| CustomHttpsProvisioningState |
Provisioning status of the custom domain. Known values supported by the serviceEnabling |
| CustomHttpsProvisioningSubstate |
Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. Known values supported by the serviceSubmittingDomainControlValidationRequest |
| CustomRuleEnabledState |
Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. Known values supported by the serviceDisabled |
| DeleteRule |
Describes the action that shall be taken when the certificate is removed from Key Vault. Known values supported by the serviceNoAction |
| DeliveryRuleActionName |
The name of the action for the delivery rule. Known values supported by the serviceCacheExpiration |
| DeliveryRuleActionParametersType |
Type of DeliveryRuleActionParametersType |
| DeliveryRuleActionParametersUnion |
Alias for DeliveryRuleActionParametersUnion |
| DeliveryRuleActionUnion |
Alias for DeliveryRuleActionUnion |
| DeliveryRuleConditionParametersType |
Type of DeliveryRuleConditionParametersType |
| DeliveryRuleConditionParametersUnion |
Alias for DeliveryRuleConditionParametersUnion |
| DeliveryRuleConditionUnion |
Alias for DeliveryRuleConditionUnion |
| DeploymentStatus |
Type of DeploymentStatus |
| DestinationProtocol |
Protocol to use for the redirect. The default value is MatchRequest Known values supported by the serviceMatchRequest |
| DomainValidationState |
Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. Known values supported by the serviceUnknown |
| EnabledState |
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' Known values supported by the serviceEnabled |
| EndpointProvisioningState |
Provisioning status of the endpoint. Known values supported by the serviceSucceeded |
| EndpointResourceState |
Resource status of the endpoint. Known values supported by the serviceCreating |
| ForwardingProtocol |
Protocol this rule will use when forwarding traffic to backends. Known values supported by the serviceHttpOnly |
| GeoFilterActions |
Action of the geo filter, i.e. allow or block access. |
| HeaderAction |
Action to perform Known values supported by the serviceAppend |
| HealthProbeRequestType |
The type of health probe request that is made. |
| HostNameOperator |
Describes operator to be matched Known values supported by the serviceAny |
| HttpVersionOperator |
Describes operator to be matched Known values supported by the serviceEqual |
| 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. Known values supported by the serviceEnabled |
| IsDeviceMatchConditionParametersMatchValuesItem |
Type of IsDeviceMatchConditionParametersMatchValuesItem |
| IsDeviceOperator |
Describes operator to be matched Known values supported by the serviceEqual |
| KeyVaultSigningKeyParametersType |
Type of KeyVaultSigningKeyParametersType |
| LinkToDefaultDomain |
whether this route will be linked to the default endpoint domain. Known values supported by the serviceEnabled |
| LogMetric |
Type of LogMetric |
| LogMetricsGranularity |
Type of LogMetricsGranularity |
| LogMetricsGroupBy |
Type of LogMetricsGroupBy |
| LogRanking |
Type of LogRanking |
| LogRankingMetric |
Type of LogRankingMetric |
| ManagedRuleEnabledState |
Describes if the managed rule is in enabled or disabled state. Known values supported by the serviceDisabled |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| MatchProcessingBehavior |
If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values supported by the serviceContinue |
| MatchVariable |
Request variable to compare with. Known values supported by the serviceRemoteAddress |
| MetricsGranularity |
Type of MetricsGranularity |
| MetricsSeriesUnit |
Type of MetricsSeriesUnit |
| MinimumTlsVersion |
TLS protocol version that will be used for Https |
| Operator |
Describes operator to be matched Known values supported by the serviceAny |
| 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. Known values supported by the serviceGeneralWebDelivery |
| OriginAuthenticationType |
The type of the authentication for the origin. Known values supported by the serviceSystemAssignedIdentity |
| OriginGroupProvisioningState |
Provisioning status of the origin group. Known values supported by the serviceSucceeded |
| OriginGroupResourceState |
Resource status of the origin group. Known values supported by the serviceCreating |
| OriginProvisioningState |
Provisioning status of the origin. Known values supported by the serviceSucceeded |
| OriginResourceState |
Resource status of the origin. Known values supported by the serviceCreating |
| ParamIndicator |
Indicates the purpose of the parameter Known values supported by the serviceExpires |
| PolicyEnabledState |
Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. Known values supported by the serviceDisabled |
| PolicyMode |
Describes if it is in detection mode or prevention mode at policy level. Known values supported by the servicePrevention |
| PolicyResourceState |
Resource status of the policy. Known values supported by the serviceCreating |
| PolicySettingsDefaultCustomBlockResponseStatusCode |
If the action type is block, this field defines the default customer overridable http response status code. Known values supported by the service200 |
| PostArgsOperator |
Describes operator to be matched Known values supported by the serviceAny |
| PrivateEndpointStatus |
The approval status for the connection to the Private Link Known values supported by the servicePending |
| ProbeProtocol |
Protocol to use for health probe. |
| ProfileProvisioningState |
Provisioning status of the profile. Known values supported by the serviceSucceeded |
| ProfileResourceState |
Resource status of the profile. Known values supported by the serviceCreating |
| ProfileScrubbingState |
State of the log scrubbing config. Default value is Enabled. Known values supported by the serviceEnabled |
| ProtocolType |
Defines the TLS extension protocol that is used for secure delivery. Known values supported by the serviceServerNameIndication |
| ProvisioningState |
Provisioning state of the WebApplicationFirewallPolicy. Known values supported by the serviceCreating |
| QueryStringBehavior |
Caching behavior for the requests Known values supported by the serviceInclude |
| 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. |
| QueryStringOperator |
Describes operator to be matched Known values supported by the serviceAny |
| RedirectType |
The redirect type the rule will use when redirecting traffic. Known values supported by the serviceMoved |
| RemoteAddressOperator |
Describes operator to be matched Known values supported by the serviceAny |
| RequestBodyOperator |
Describes operator to be matched Known values supported by the serviceAny |
| RequestHeaderOperator |
Describes operator to be matched Known values supported by the serviceAny |
| RequestMethodMatchConditionParametersMatchValuesItem |
Type of RequestMethodMatchConditionParametersMatchValuesItem |
| RequestMethodOperator |
Describes operator to be matched Known values supported by the serviceEqual |
| RequestSchemeMatchConditionParametersMatchValuesItem |
Type of RequestSchemeMatchConditionParametersMatchValuesItem |
| RequestSchemeMatchConditionParametersOperator |
Describes operator to be matched Known values supported by the serviceEqual |
| RequestUriOperator |
Describes operator to be matched Known values supported by the serviceAny |
| ResourceType |
Type of CDN resource used in CheckNameAvailability. Known values supported by the serviceMicrosoft.Cdn/Profiles/Endpoints |
| ResourceUsageUnit |
Unit of the usage. e.g. count. Known values supported by the servicecount |
| ResponseBasedDetectedErrorTypes |
Type of response errors for real user requests for which origin will be deemed unhealthy |
| RuleCacheBehavior |
Caching behavior for the requests Known values supported by the serviceHonorOrigin |
| 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. Known values supported by the serviceEnabled |
| 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. Known values supported by the serviceIgnoreQueryString |
| ScrubbingRuleEntryMatchOperator |
When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. Known values supported by the serviceEqualsAny |
| ScrubbingRuleEntryMatchVariable |
The variable to be scrubbed from the logs. Known values supported by the serviceRequestIPAddress |
| ScrubbingRuleEntryState |
Defines the state of a log scrubbing rule. Default value is enabled. Known values supported by the serviceEnabled |
| SecretParametersUnion |
Alias for SecretParametersUnion |
| SecretType |
The type of the secret resource. Known values supported by the serviceUrlSigningKey |
| SecurityPolicyPropertiesParametersUnion |
Alias for SecurityPolicyPropertiesParametersUnion |
| SecurityPolicyType |
The type of the Security policy to create. Known values supported by the serviceWebApplicationFirewall |
| ServerPortOperator |
Describes operator to be matched Known values supported by the serviceAny |
| SharedPrivateLinkResourceStatus |
Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. |
| SkuName |
Name of the pricing tier. Known values supported by the serviceStandard_Verizon |
| SocketAddrOperator |
Describes operator to be matched Known values supported by the serviceAny |
| SslProtocol |
The protocol of an established TLS connection. Known values supported by the serviceTLSv1 |
| SslProtocolOperator |
Describes operator to be matched Known values supported by the serviceEqual |
| Status |
The validation status. Known values supported by the serviceValid |
| Transform |
Describes what transforms are applied before matching Known values supported by the serviceLowercase |
| TransformType |
Describes what transforms were applied before matching. Known values supported by the serviceLowercase |
| UpdateRule |
Describes the action that shall be taken when the certificate is updated in Key Vault. Known values supported by the serviceNoAction |
| UrlFileExtensionOperator |
Describes operator to be matched Known values supported by the serviceAny |
| UrlFileNameOperator |
Describes operator to be matched Known values supported by the serviceAny |
| UrlPathOperator |
Describes operator to be matched Known values supported by the serviceAny |
| UsageUnit |
An enum describing the unit of measurement. Known values supported by the serviceCount |
| WafAction |
Type of WafAction |
| WafGranularity |
Type of WafGranularity |
| WafMatchVariable |
Match variable to compare against. Known values supported by the serviceRemoteAddr |
| WafMetric |
Type of WafMetric |
| WafMetricsGranularity |
Type of WafMetricsGranularity |
| WafMetricsSeriesUnit |
Type of WafMetricsSeriesUnit |
| WafRankingGroupBy |
Type of WafRankingGroupBy |
| WafRankingType |
Type of WafRankingType |
| WafRuleType |
Type of WafRuleType |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownAFDEndpointProtocols |
Supported protocols for the customer's endpoint. |
| KnownActionType |
Defines the action to take on rule match. |
| KnownAfdCertificateType |
Defines the source of the SSL certificate. |
| KnownAfdCipherSuiteSetType |
cipher suite set type that will be used for Https |
| KnownAfdCustomizedCipherSuiteForTls12 |
Known values of AfdCustomizedCipherSuiteForTls12 that the service accepts. |
| KnownAfdCustomizedCipherSuiteForTls13 |
Known values of AfdCustomizedCipherSuiteForTls13 that the service accepts. |
| KnownAfdProvisioningState |
Provisioning status |
| KnownAfdQueryStringCachingBehavior |
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. |
| KnownAlgorithm |
Algorithm to use for URL signing |
| KnownAutoGeneratedDomainNameLabelScope |
Indicates the endpoint name reuse scope. The default value is TenantReuse. |
| KnownCacheBehavior |
Caching behavior for the requests |
| KnownCacheType |
The level at which the content needs to be cached. |
| KnownCanMigrateDefaultSku |
Recommended sku for the migration |
| KnownCertificateSource |
Defines the source of the SSL certificate. |
| KnownCertificateSourceParametersType |
Known values of CertificateSourceParametersType that the service accepts. |
| KnownCertificateType |
Type of certificate used |
| KnownClientPortOperator |
Describes operator to be matched |
| KnownCookiesOperator |
Describes operator to be matched |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownCustomDomainResourceState |
Resource status of the custom domain. |
| KnownCustomHttpsProvisioningState |
Provisioning status of the custom domain. |
| KnownCustomHttpsProvisioningSubstate |
Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. |
| KnownCustomRuleEnabledState |
Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. |
| KnownDeleteRule |
Describes the action that shall be taken when the certificate is removed from Key Vault. |
| KnownDeliveryRuleActionName |
The name of the action for the delivery rule. |
| KnownDeliveryRuleActionParametersType |
Known values of DeliveryRuleActionParametersType that the service accepts. |
| KnownDeliveryRuleConditionParametersType |
Known values of DeliveryRuleConditionParametersType that the service accepts. |
| KnownDeploymentStatus |
Known values of DeploymentStatus that the service accepts. |
| KnownDestinationProtocol |
Protocol to use for the redirect. The default value is MatchRequest |
| KnownDomainValidationState |
Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation. |
| KnownEnabledState |
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' |
| KnownEndpointProvisioningState |
Provisioning status of the endpoint. |
| KnownEndpointResourceState |
Resource status of the endpoint. |
| KnownForwardingProtocol |
Protocol this rule will use when forwarding traffic to backends. |
| KnownHeaderAction |
Action to perform |
| KnownHostNameOperator |
Describes operator to be matched |
| KnownHttpVersionOperator |
Describes operator to be matched |
| KnownHttpsRedirect |
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. |
| KnownIsDeviceMatchConditionParametersMatchValuesItem |
Known values of IsDeviceMatchConditionParametersMatchValuesItem that the service accepts. |
| KnownIsDeviceOperator |
Describes operator to be matched |
| KnownKeyVaultSigningKeyParametersType |
Known values of KeyVaultSigningKeyParametersType that the service accepts. |
| KnownLinkToDefaultDomain |
whether this route will be linked to the default endpoint domain. |
| KnownLogMetric |
Known values of LogMetric that the service accepts. |
| KnownLogMetricsGranularity |
Known values of LogMetricsGranularity that the service accepts. |
| KnownLogMetricsGroupBy |
Known values of LogMetricsGroupBy that the service accepts. |
| KnownLogRanking |
Known values of LogRanking that the service accepts. |
| KnownLogRankingMetric |
Known values of LogRankingMetric that the service accepts. |
| KnownManagedRuleEnabledState |
Describes if the managed rule is in enabled or disabled state. |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| KnownMatchProcessingBehavior |
If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. |
| KnownMatchVariable |
Request variable to compare with. |
| KnownMetricsGranularity |
Known values of MetricsGranularity that the service accepts. |
| KnownMetricsSeriesUnit |
Known values of MetricsSeriesUnit that the service accepts. |
| KnownOperator |
Describes operator to be matched |
| KnownOptimizationType |
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. |
| KnownOriginAuthenticationType |
The type of the authentication for the origin. |
| KnownOriginGroupProvisioningState |
Provisioning status of the origin group. |
| KnownOriginGroupResourceState |
Resource status of the origin group. |
| KnownOriginProvisioningState |
Provisioning status of the origin. |
| KnownOriginResourceState |
Resource status of the origin. |
| KnownParamIndicator |
Indicates the purpose of the parameter |
| KnownPolicyEnabledState |
Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. |
| KnownPolicyMode |
Describes if it is in detection mode or prevention mode at policy level. |
| KnownPolicyResourceState |
Resource status of the policy. |
| KnownPolicySettingsDefaultCustomBlockResponseStatusCode |
If the action type is block, this field defines the default customer overridable http response status code. |
| KnownPostArgsOperator |
Describes operator to be matched |
| KnownPrivateEndpointStatus |
The approval status for the connection to the Private Link |
| KnownProfileProvisioningState |
Provisioning status of the profile. |
| KnownProfileResourceState |
Resource status of the profile. |
| KnownProfileScrubbingState |
State of the log scrubbing config. Default value is Enabled. |
| KnownProtocolType |
Defines the TLS extension protocol that is used for secure delivery. |
| KnownProvisioningState |
Provisioning state of the WebApplicationFirewallPolicy. |
| KnownQueryStringBehavior |
Caching behavior for the requests |
| KnownQueryStringOperator |
Describes operator to be matched |
| KnownRedirectType |
The redirect type the rule will use when redirecting traffic. |
| KnownRemoteAddressOperator |
Describes operator to be matched |
| KnownRequestBodyOperator |
Describes operator to be matched |
| KnownRequestHeaderOperator |
Describes operator to be matched |
| KnownRequestMethodMatchConditionParametersMatchValuesItem |
Known values of RequestMethodMatchConditionParametersMatchValuesItem that the service accepts. |
| KnownRequestMethodOperator |
Describes operator to be matched |
| KnownRequestSchemeMatchConditionParametersMatchValuesItem |
Known values of RequestSchemeMatchConditionParametersMatchValuesItem that the service accepts. |
| KnownRequestSchemeMatchConditionParametersOperator |
Describes operator to be matched |
| KnownRequestUriOperator |
Describes operator to be matched |
| KnownResourceType |
Type of CDN resource used in CheckNameAvailability. |
| KnownResourceUsageUnit |
Unit of the usage. e.g. count. |
| KnownRuleCacheBehavior |
Caching behavior for the requests |
| KnownRuleIsCompressionEnabled |
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. |
| KnownRuleQueryStringCachingBehavior |
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. |
| KnownScrubbingRuleEntryMatchOperator |
When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. |
| KnownScrubbingRuleEntryMatchVariable |
The variable to be scrubbed from the logs. |
| KnownScrubbingRuleEntryState |
Defines the state of a log scrubbing rule. Default value is enabled. |
| KnownSecretType |
The type of the secret resource. |
| KnownSecurityPolicyType |
The type of the Security policy to create. |
| KnownServerPortOperator |
Describes operator to be matched |
| KnownSkuName |
Name of the pricing tier. |
| KnownSocketAddrOperator |
Describes operator to be matched |
| KnownSslProtocol |
The protocol of an established TLS connection. |
| KnownSslProtocolOperator |
Describes operator to be matched |
| KnownStatus |
The validation status. |
| KnownTransform |
Describes what transforms are applied before matching |
| KnownTransformType |
Describes what transforms were applied before matching. |
| KnownUpdateRule |
Describes the action that shall be taken when the certificate is updated in Key Vault. |
| KnownUrlFileExtensionOperator |
Describes operator to be matched |
| KnownUrlFileNameOperator |
Describes operator to be matched |
| KnownUrlPathOperator |
Describes operator to be matched |
| KnownUsageUnit |
An enum describing the unit of measurement. |
| KnownVersions |
The available API versions. |
| KnownWafAction |
Known values of WafAction that the service accepts. |
| KnownWafGranularity |
Known values of WafGranularity that the service accepts. |
| KnownWafMatchVariable |
Match variable to compare against. |
| KnownWafMetric |
Known values of WafMetric that the service accepts. |
| KnownWafMetricsGranularity |
Known values of WafMetricsGranularity that the service accepts. |
| KnownWafMetricsSeriesUnit |
Known values of WafMetricsSeriesUnit that the service accepts. |
| KnownWafRankingGroupBy |
Known values of WafRankingGroupBy that the service accepts. |
| KnownWafRankingType |
Known values of WafRankingType that the service accepts. |
| KnownWafRuleType |
Known values of WafRuleType that the service accepts. |
Functions
| is |
Typeguard for RestError |
| restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
restorePoller<TResponse, TResult>(CdnManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: CdnManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- CdnManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor