Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201 Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| ActivatedResourceReference |
Reference to another resource along with its state. |
| AfdDomain |
Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com. |
| AfdDomainHttpsParameters |
The JSON object that contains the properties to secure a domain. |
| AfdDomainListResult |
Result of the request to list domains. It contains a list of domain objects and a URL link to get the next set of results. |
| AfdDomainProperties |
The JSON object that contains the properties of the domain to create. |
| AfdDomainPropertiesExtendedProperties |
Key-Value pair representing migration properties for domains. |
| 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 | |
| AfdEndpointListResult |
Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results. |
| 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. |
| AfdEndpointUpdateParametersTags |
Endpoint tags. |
| AfdErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
| 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. |
| AfdOriginGroupListResult |
Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results. |
| 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. |
| AfdOriginListResult |
Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results. |
| 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. |
| AfdPurgeParameters |
Parameters required for content purge. |
| AfdRouteCacheConfiguration |
Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. |
| AfdStateProperties |
The tracking states for afd resources. |
| AzureFirstPartyManagedCertificate |
Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS. |
| AzureFirstPartyManagedCertificateParameters |
Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS. |
| 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 | |
| CanMigrateResult |
Result for canMigrate operation. |
| CdnCertificateSourceParameters |
Defines the parameters for using CDN managed certificate for securing custom domain. |
| CdnManagedHttpsParameters |
Defines the certificate source parameters using CDN managed certificate for enabling SSL. |
| Certificate |
Certificate used for https |
| CheckEndpointNameAvailabilityInput |
Input of CheckNameAvailability API. |
| CheckEndpointNameAvailabilityOutput |
Output of check name availability API. |
| CheckHostNameAvailabilityInput |
Input of CheckHostNameAvailability API. |
| CheckNameAvailabilityInput |
Input of CheckNameAvailability API. |
| CheckNameAvailabilityOutput |
Output of check name availability API. |
| CidrIPAddress |
CIDR Ip address |
| ClientPortMatchConditionParameters |
Defines the parameters for ClientPort match conditions |
| Components18OrqelSchemasWafmetricsresponsePropertiesSeriesItemsPropertiesDataItems | |
| Components1Gs0LlpSchemasMetricsresponsePropertiesSeriesItemsPropertiesDataItems | |
| ComponentsKpo1PjSchemasWafrankingsresponsePropertiesDataItemsPropertiesMetricsItems | |
| CompressionSettings |
settings for compression. |
| ContinentsResponse |
Continents Response |
| ContinentsResponseContinentsItem | |
| 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. www.contoso.com. |
| CustomDomainHttpsParameters |
The JSON object that contains the properties to secure a custom domain. |
| CustomDomainListResult |
Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results. |
| 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. |
| CustomerCertificate |
Customer Certificate used for https |
| 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 |
| DeliveryRuleAction1 |
An action for the delivery rule. |
| 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. |
| 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. |
| EdgenodeResult |
Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results. |
| Endpoint | |
| EndpointListResult |
Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results. |
| 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. |
| EndpointUpdateParametersTags |
Endpoint tags. |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message. |
| GeoFilter |
Rules defining user's geo access within a CDN endpoint. |
| 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. |
| LogSpecification |
Log specification of operation. |
| ManagedCertificate |
Managed Certificate used for https |
| ManagedCertificateParameters |
Managed Certificate used for https |
| MetricAvailability |
Retention policy of a resource metric. |
| MetricSpecification |
Metric specification of operation. |
| MetricsResponse |
Metrics Response |
| MetricsResponseSeriesItem | |
| MetricsResponseSeriesPropertiesItemsItem | |
| MigrateResult |
Result for migrate operation. |
| MigrateResultProperties | |
| 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. |
| OperationsListResult |
Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results. |
| Origin |
CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins. |
| OriginGroup |
Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN. |
| OriginGroupListResult |
Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results. |
| 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. |
| OriginListResult |
Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results. |
| 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. |
| 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. |
| ProfileListResult |
Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results. |
| 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. |
| ProfilePropertiesExtendedProperties |
Key-Value pair representing additional properties for profiles. |
| ProfilePropertiesUpdateParameters |
The JSON object containing profile update parameters. |
| ProfileScrubbingRules |
Defines the contents of the log scrubbing rules. |
| ProfileUpdateParameters |
Properties required to update a profile. |
| ProfileUpdateParametersTags |
Profile tags |
| ProfileUpgradeParameters |
Parameters required for profile upgrade. |
| ProxyResource |
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags |
| PurgeParameters |
Parameters required for content purge. |
| QueryStringMatchConditionParameters |
Defines the parameters for QueryString match conditions |
| RankingsResponse |
Rankings Response |
| RankingsResponseTablesItem | |
| RankingsResponseTablesPropertiesItemsItem | |
| RankingsResponseTablesPropertiesItemsMetricsItem | |
| 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 |
The core properties of ARM resources |
| ResourceReference |
Reference to another resource. |
| ResourcesResponse |
Resources Response |
| ResourcesResponseCustomDomainsItem | |
| ResourcesResponseEndpointsItem | |
| ResourcesResponseEndpointsPropertiesItemsItem | |
| ResourceUsage |
Output of check resource usage API. |
| ResourceUsageListResult |
Output of check resource usage API. |
| ResponseBasedOriginErrorDetectionParameters |
The JSON object that contains the properties to determine origin health using real requests/responses. |
| Route |
Friendly Routes name mapping to the any Routes or secret related information. |
| RouteConfigurationOverrideActionParameters |
Defines the parameters for the route configuration override action. |
| RouteListResult |
Result of the request to list routes. It contains a list of route objects and a URL link to get the next set of results. |
| 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. |
| Rule |
Friendly Rules name mapping to the any Rules or secret related information. |
| RuleListResult |
Result of the request to list rules. It contains a list of rule objects and a URL link to get the next set of results. |
| 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. |
| RuleSetListResult |
Result of the request to list rule sets. It contains a list of rule set objects and a URL link to get the next set of results. |
| RuleSetProperties |
The JSON object that contains the properties of the Rule Set to create. |
| RuleUpdateParameters |
The domain JSON object required for domain creation or update. |
| RuleUpdatePropertiesParameters |
The JSON object that contains the properties of the rule to update. |
| Secret |
Friendly Secret name mapping to the any Secret or secret related information. |
| SecretListResult |
Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results. |
| SecretParameters |
The json object containing secret parameters |
| SecretProperties |
The JSON object that contains the properties of the Secret to create. |
| SecurityPolicy |
SecurityPolicy association for AzureFrontDoor profile |
| SecurityPolicyListResult |
Result of the request to list security policies. It contains a list of security policy objects and a URL link to get the next set of results. |
| 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. |
| 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 |
Read only system data |
| TrackedResource |
The resource model definition for a ARM tracked top level resource. |
| TrackedResourceTags |
Resource tags. |
| 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. |
| UsagesListResult |
The list usages operation response. |
| 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. |
| ValidateProbeOutput |
Output of the validate probe API. |
| ValidateSecretInput |
Input of the secret to be validated. |
| ValidateSecretOutput |
Output of the validated secret. |
| ValidationToken |
The validation token. |
| WafMetricsResponse |
Waf Metrics Response |
| WafMetricsResponseSeriesItem | |
| WafMetricsResponseSeriesPropertiesItemsItem | |
| WafRankingsResponse |
Waf Rankings Response |
| WafRankingsResponseDataItem | |