Microsoft.Cdn profiles/endpoints 2020-04-15

2024-12-09

Bicep resource definition

The profiles/endpoints resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cdn/profiles/endpoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cdn/profiles/endpoints@2020-04-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    contentTypesToCompress: [
      'string'
    ]
    defaultOriginGroup: {
      id: 'string'
    }
    deliveryPolicy: {
      description: 'string'
      rules: [
        {
          actions: [
            {
              name: 'string'
              // For remaining properties, see DeliveryRuleActionAutoGenerated objects
            }
          ]
          conditions: [
            {
              name: 'string'
              // For remaining properties, see DeliveryRuleCondition objects
            }
          ]
          name: 'string'
          order: int
        }
      ]
    }
    geoFilters: [
      {
        action: 'string'
        countryCodes: [
          'string'
        ]
        relativePath: 'string'
      }
    ]
    isCompressionEnabled: bool
    isHttpAllowed: bool
    isHttpsAllowed: bool
    optimizationType: 'string'
    originGroups: [
      {
        name: 'string'
        properties: {
          healthProbeSettings: {
            probeIntervalInSeconds: int
            probePath: 'string'
            probeProtocol: 'string'
            probeRequestType: 'string'
          }
          origins: [
            {
              id: 'string'
            }
          ]
          responseBasedOriginErrorDetectionSettings: {
            httpErrorRanges: [
              {
                begin: int
                end: int
              }
            ]
            responseBasedDetectedErrorTypes: 'string'
            responseBasedFailoverThresholdPercentage: int
          }
          trafficRestorationTimeToHealedOrNewEndpointsInMinutes: int
        }
      }
    ]
    originHostHeader: 'string'
    originPath: 'string'
    origins: [
      {
        name: 'string'
        properties: {
          enabled: bool
          hostName: 'string'
          httpPort: int
          httpsPort: int
          originHostHeader: 'string'
          priority: int
          privateLinkAlias: 'string'
          privateLinkApprovalMessage: 'string'
          privateLinkLocation: 'string'
          privateLinkResourceId: 'string'
          weight: int
        }
      }
    ]
    probePath: 'string'
    queryStringCachingBehavior: 'string'
    urlSigningKeys: [
      {
        keyId: 'string'
        keySourceParameters: {
          @odata.type: 'string'
          resourceGroupName: 'string'
          secretName: 'string'
          secretVersion: 'string'
          subscriptionId: 'string'
          vaultName: 'string'
        }
      }
    ]
    webApplicationFirewallPolicyLink: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

DeliveryRuleActionAutoGenerated objects

Set the name property to specify the type of object.

For CacheExpiration, use:

{
  name: 'CacheExpiration'
  parameters: {
    @odata.type: 'string'
    cacheBehavior: 'string'
    cacheDuration: 'string'
    cacheType: 'string'
  }
}

For CacheKeyQueryString, use:

{
  name: 'CacheKeyQueryString'
  parameters: {
    @odata.type: 'string'
    queryParameters: 'string'
    queryStringBehavior: 'string'
  }
}

For ModifyRequestHeader, use:

{
  name: 'ModifyRequestHeader'
  parameters: {
    @odata.type: 'string'
    headerAction: 'string'
    headerName: 'string'
    value: 'string'
  }
}

For ModifyResponseHeader, use:

{
  name: 'ModifyResponseHeader'
  parameters: {
    @odata.type: 'string'
    headerAction: 'string'
    headerName: 'string'
    value: 'string'
  }
}

For UrlRedirect, use:

{
  name: 'UrlRedirect'
  parameters: {
    @odata.type: 'string'
    customFragment: 'string'
    customHostname: 'string'
    customPath: 'string'
    customQueryString: 'string'
    destinationProtocol: 'string'
    redirectType: 'string'
  }
}

For UrlRewrite, use:

{
  name: 'UrlRewrite'
  parameters: {
    @odata.type: 'string'
    destination: 'string'
    preserveUnmatchedPath: bool
    sourcePattern: 'string'
  }
}

For UrlSigning, use:

{
  name: 'UrlSigning'
  parameters: {
    @odata.type: 'string'
    algorithm: 'string'
    ipSubnets: [
      'string'
    ]
    keyId: 'string'
    parameterNameOverride: [
      {
        paramIndicator: 'string'
        paramName: 'string'
      }
    ]
  }
}

DeliveryRuleCondition objects

Set the name property to specify the type of object.

For Cookies, use:

{
  name: 'Cookies'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
  }
}

For HttpVersion, use:

{
  name: 'HttpVersion'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
  }
}

For IsDevice, use:

{
  name: 'IsDevice'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }
}

For PostArgs, use:

{
  name: 'PostArgs'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
  }
}

For QueryString, use:

{
  name: 'QueryString'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }
}

For RemoteAddress, use:

{
  name: 'RemoteAddress'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }
}

For RequestBody, use:

{
  name: 'RequestBody'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }
}

For RequestHeader, use:

{
  name: 'RequestHeader'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
  }
}

For RequestMethod, use:

{
  name: 'RequestMethod'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
  }
}

For RequestScheme, use:

{
  name: 'RequestScheme'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
  }
}

For RequestUri, use:

{
  name: 'RequestUri'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }
}

For UrlFileExtension, use:

{
  name: 'UrlFileExtension'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }
}

For UrlFileName, use:

{
  name: 'UrlFileName'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }
}

For UrlPath, use:

{
  name: 'UrlPath'
  parameters: {
    @odata.type: 'string'
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
  }
}

Property Values