Microsoft.Cdn profiles/ruleSets/rules

2024-12-09

Bicep resource definition

The profiles/ruleSets/rules 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/ruleSets/rules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cdn/profiles/ruleSets/rules@2025-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    actions: [
      {
        name: 'string'
        // For remaining properties, see DeliveryRuleAction objects
      }
    ]
    conditions: [
      {
        name: 'string'
        // For remaining properties, see DeliveryRuleCondition objects
      }
    ]
    matchProcessingBehavior: 'string'
    order: int
  }
}

DeliveryRuleCondition objects

Set the name property to specify the type of object.

For ClientPort, use:

{
  name: 'ClientPort'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For Cookies, use:

{
  name: 'Cookies'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For HostName, use:

{
  name: 'HostName'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For HttpVersion, use:

{
  name: 'HttpVersion'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For IsDevice, use:

{
  name: 'IsDevice'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For PostArgs, use:

{
  name: 'PostArgs'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For QueryString, use:

{
  name: 'QueryString'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For RemoteAddress, use:

{
  name: 'RemoteAddress'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For RequestBody, use:

{
  name: 'RequestBody'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For RequestHeader, use:

{
  name: 'RequestHeader'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    selector: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For RequestMethod, use:

{
  name: 'RequestMethod'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For RequestScheme, use:

{
  name: 'RequestScheme'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For RequestUri, use:

{
  name: 'RequestUri'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For ServerPort, use:

{
  name: 'ServerPort'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For SocketAddr, use:

{
  name: 'SocketAddr'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For SslProtocol, use:

{
  name: 'SslProtocol'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For UrlFileExtension, use:

{
  name: 'UrlFileExtension'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For UrlFileName, use:

{
  name: 'UrlFileName'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

For UrlPath, use:

{
  name: 'UrlPath'
  parameters: {
    matchValues: [
      'string'
    ]
    negateCondition: bool
    operator: 'string'
    transforms: [
      'string'
    ]
    typeName: 'string'
  }
}

DeliveryRuleAction objects

Set the name property to specify the type of object.

For CacheExpiration, use:

{
  name: 'CacheExpiration'
  parameters: {
    cacheBehavior: 'string'
    cacheDuration: 'string'
    cacheType: 'string'
    typeName: 'string'
  }
}

For CacheKeyQueryString, use:

{
  name: 'CacheKeyQueryString'
  parameters: {
    queryParameters: 'string'
    queryStringBehavior: 'string'
    typeName: 'string'
  }
}

For ModifyRequestHeader, use:

{
  name: 'ModifyRequestHeader'
  parameters: {
    headerAction: 'string'
    headerName: 'string'
    typeName: 'string'
    value: 'string'
  }
}

For ModifyResponseHeader, use:

{
  name: 'ModifyResponseHeader'
  parameters: {
    headerAction: 'string'
    headerName: 'string'
    typeName: 'string'
    value: 'string'
  }
}

For OriginGroupOverride, use:

{
  name: 'OriginGroupOverride'
  parameters: {
    originGroup: {
      id: 'string'
    }
    typeName: 'string'
  }
}

For RouteConfigurationOverride, use:

{
  name: 'RouteConfigurationOverride'
  parameters: {
    cacheConfiguration: {
      cacheBehavior: 'string'
      cacheDuration: 'string'
      isCompressionEnabled: 'string'
      queryParameters: 'string'
      queryStringCachingBehavior: 'string'
    }
    originGroupOverride: {
      forwardingProtocol: 'string'
      originGroup: {
        id: 'string'
      }
    }
    typeName: 'string'
  }
}

For UrlRedirect, use:

{
  name: 'UrlRedirect'
  parameters: {
    customFragment: 'string'
    customHostname: 'string'
    customPath: 'string'
    customQueryString: 'string'
    destinationProtocol: 'string'
    redirectType: 'string'
    typeName: 'string'
  }
}

For UrlRewrite, use:

{
  name: 'UrlRewrite'
  parameters: {
    destination: 'string'
    preserveUnmatchedPath: bool
    sourcePattern: 'string'
    typeName: 'string'
  }
}

For UrlSigning, use:

{
  name: 'UrlSigning'
  parameters: {
    algorithm: 'string'
    parameterNameOverride: [
      {
        paramIndicator: 'string'
        paramName: 'string'
      }
    ]
    typeName: 'string'
  }
}

Property Values