Microsoft.Cdn profiles/originGroups/origins 2020-09-01

Template format

To create a Microsoft.Cdn/profiles/originGroups/origins resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Cdn/profiles/originGroups/origins",
  "apiVersion": "2020-09-01",
  "properties": {
    "azureOrigin": {
      "id": "string"
    },
    "hostName": "string",
    "httpPort": "integer",
    "httpsPort": "integer",
    "originHostHeader": "string",
    "priority": "integer",
    "weight": "integer",
    "sharedPrivateLinkResource": {},
    "enabledState": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Cdn/profiles/originGroups/origins object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Name of the origin, an arbitrary value but it needs to be unique under endpoint
type enum Yes For JSON -origins
-or-
Microsoft.Cdn/profiles/originGroups/origins

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2020-09-01
properties object Yes AFDOriginProperties object

AFDOriginProperties object

Name Type Required Value
azureOrigin object No Resource reference to the Azure origin resource. - ResourceReference object
hostName string Yes The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
httpPort integer No The value of the HTTP port. Must be between 1 and 65535.
httpsPort integer No The value of the HTTPS port. Must be between 1 and 65535.
originHostHeader string No The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
priority integer No Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
weight integer No Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
sharedPrivateLinkResource object No The properties of the private link resource for private origin.
enabledState enum No Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. - Enabled or Disabled

ResourceReference object

Name Type Required Value
id string No Resource ID.