Microsoft.Network serviceEndpointPolicies 2021-08-01

Bicep resource definition

The serviceEndpointPolicies resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Network/serviceEndpointPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Network/serviceEndpointPolicies@2021-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    contextualServiceEndpointPolicies: [
      'string'
    ]
    serviceAlias: 'string'
    serviceEndpointPolicyDefinitions: [
      {
        id: 'string'
        name: 'string'
        properties: {
          description: 'string'
          service: 'string'
          serviceResources: [
            'string'
          ]
        }
        type: 'string'
      }
    ]
  }
}

Property values

serviceEndpointPolicies

Name Description Value
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with alphanumeric. End alphanumeric or underscore.
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Properties of the service end point policy. ServiceEndpointPolicyPropertiesFormat

ServiceEndpointPolicyPropertiesFormat

Name Description Value
contextualServiceEndpointPolicies A collection of contextual service endpoint policy. string[]
serviceAlias The alias indicating if the policy belongs to a service string
serviceEndpointPolicyDefinitions A collection of service endpoint policy definitions of the service endpoint policy. ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Properties of the service endpoint policy definition. ServiceEndpointPolicyDefinitionPropertiesFormat
type The type of the resource. string

ServiceEndpointPolicyDefinitionPropertiesFormat

Name Description Value
description A description for this rule. Restricted to 140 chars. string
service Service endpoint name. string
serviceResources A list of service resources. string[]

ARM template resource definition

The serviceEndpointPolicies resource type can be deployed with operations that target:

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

Resource format

To create a Microsoft.Network/serviceEndpointPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.Network/serviceEndpointPolicies",
  "apiVersion": "2021-08-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "contextualServiceEndpointPolicies": [ "string" ],
    "serviceAlias": "string",
    "serviceEndpointPolicyDefinitions": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "description": "string",
          "service": "string",
          "serviceResources": [ "string" ]
        },
        "type": "string"
      }
    ]
  }
}

Property values

serviceEndpointPolicies

Name Description Value
type The resource type 'Microsoft.Network/serviceEndpointPolicies'
apiVersion The resource api version '2021-08-01'
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with alphanumeric. End alphanumeric or underscore.
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Properties of the service end point policy. ServiceEndpointPolicyPropertiesFormat

ServiceEndpointPolicyPropertiesFormat

Name Description Value
contextualServiceEndpointPolicies A collection of contextual service endpoint policy. string[]
serviceAlias The alias indicating if the policy belongs to a service string
serviceEndpointPolicyDefinitions A collection of service endpoint policy definitions of the service endpoint policy. ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Properties of the service endpoint policy definition. ServiceEndpointPolicyDefinitionPropertiesFormat
type The type of the resource. string

ServiceEndpointPolicyDefinitionPropertiesFormat

Name Description Value
description A description for this rule. Restricted to 140 chars. string
service Service endpoint name. string
serviceResources A list of service resources. string[]

Terraform (AzAPI provider) resource definition

The serviceEndpointPolicies resource type can be deployed with operations that target:

  • Resource groups

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

Resource format

To create a Microsoft.Network/serviceEndpointPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/serviceEndpointPolicies@2021-08-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      contextualServiceEndpointPolicies = [
        "string"
      ]
      serviceAlias = "string"
      serviceEndpointPolicyDefinitions = [
        {
          id = "string"
          name = "string"
          properties = {
            description = "string"
            service = "string"
            serviceResources = [
              "string"
            ]
          }
          type = "string"
        }
      ]
    }
  })
}

Property values

serviceEndpointPolicies

Name Description Value
type The resource type "Microsoft.Network/serviceEndpointPolicies@2021-08-01"
name The resource name string (required)

Character limit: 1-80

Valid characters:
Alphanumerics, underscores, periods, and hyphens.

Start with alphanumeric. End alphanumeric or underscore.
location Resource location. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
properties Properties of the service end point policy. ServiceEndpointPolicyPropertiesFormat

ServiceEndpointPolicyPropertiesFormat

Name Description Value
contextualServiceEndpointPolicies A collection of contextual service endpoint policy. string[]
serviceAlias The alias indicating if the policy belongs to a service string
serviceEndpointPolicyDefinitions A collection of service endpoint policy definitions of the service endpoint policy. ServiceEndpointPolicyDefinition[]

ServiceEndpointPolicyDefinition

Name Description Value
id Resource ID. string
name The name of the resource that is unique within a resource group. This name can be used to access the resource. string
properties Properties of the service endpoint policy definition. ServiceEndpointPolicyDefinitionPropertiesFormat
type The type of the resource. string

ServiceEndpointPolicyDefinitionPropertiesFormat

Name Description Value
description A description for this rule. Restricted to 140 chars. string
service Service endpoint name. string
serviceResources A list of service resources. string[]