Microsoft.NetworkCloud cloudServicesNetworks 2023-07-01

Bicep resource definition

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

resource symbolicname 'Microsoft.NetworkCloud/cloudServicesNetworks@2023-07-01' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    additionalEgressEndpoints: [
      {
        category: 'string'
        endpoints: [
          {
            domainName: 'string'
            port: int
          }
        ]
      }
    ]
    enableDefaultEgressEndpoints: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.NetworkCloud/cloudServicesNetworks

Name Description Value
extendedLocation The extended location of the cluster associated with the resource. ExtendedLocation (required)
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required)
properties The list of the resource properties. CloudServicesNetworkProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

CloudServicesNetworkProperties

Name Description Value
additionalEgressEndpoints The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. EgressEndpoint[]
enableDefaultEgressEndpoints The indicator of whether the platform default endpoints are allowed for the egress traffic. 'False'
'True'

EgressEndpoint

Name Description Value
category The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. string (required)
endpoints The list of endpoint dependencies. EndpointDependency[] (required)

EndpointDependency

Name Description Value
domainName The domain name of the dependency. string (required)
port The port of this endpoint. int

Constraints:
Min value = 1
Max value = 65535

ExtendedLocation

Name Description Value
name The resource ID of the extended location on which the resource will be created. string (required)
type The extended location type, for example, CustomLocation. string (required)

TrackedResourceTags

Name Description Value

ARM template resource definition

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

Usage Examples

Resource format

To create a Microsoft.NetworkCloud/cloudServicesNetworks resource, add the following JSON to your template.

{
  "type": "Microsoft.NetworkCloud/cloudServicesNetworks",
  "apiVersion": "2023-07-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "additionalEgressEndpoints": [
      {
        "category": "string",
        "endpoints": [
          {
            "domainName": "string",
            "port": "int"
          }
        ]
      }
    ],
    "enableDefaultEgressEndpoints": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.NetworkCloud/cloudServicesNetworks

Name Description Value
apiVersion The api version '2023-07-01'
extendedLocation The extended location of the cluster associated with the resource. ExtendedLocation (required)
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required)
properties The list of the resource properties. CloudServicesNetworkProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.NetworkCloud/cloudServicesNetworks'

CloudServicesNetworkProperties

Name Description Value
additionalEgressEndpoints The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. EgressEndpoint[]
enableDefaultEgressEndpoints The indicator of whether the platform default endpoints are allowed for the egress traffic. 'False'
'True'

EgressEndpoint

Name Description Value
category The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. string (required)
endpoints The list of endpoint dependencies. EndpointDependency[] (required)

EndpointDependency

Name Description Value
domainName The domain name of the dependency. string (required)
port The port of this endpoint. int

Constraints:
Min value = 1
Max value = 65535

ExtendedLocation

Name Description Value
name The resource ID of the extended location on which the resource will be created. string (required)
type The extended location type, for example, CustomLocation. string (required)

TrackedResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

The cloudServicesNetworks 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.NetworkCloud/cloudServicesNetworks resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetworkCloud/cloudServicesNetworks@2023-07-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      additionalEgressEndpoints = [
        {
          category = "string"
          endpoints = [
            {
              domainName = "string"
              port = int
            }
          ]
        }
      ]
      enableDefaultEgressEndpoints = "string"
    }
  }
}

Property Values

Microsoft.NetworkCloud/cloudServicesNetworks

Name Description Value
extendedLocation The extended location of the cluster associated with the resource. ExtendedLocation (required)
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Pattern = ^([a-zA-Z0-9][a-zA-Z0-9-_]{0,28}[a-zA-Z0-9])$ (required)
properties The list of the resource properties. CloudServicesNetworkProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.NetworkCloud/cloudServicesNetworks@2023-07-01"

CloudServicesNetworkProperties

Name Description Value
additionalEgressEndpoints The list of egress endpoints. This allows for connection from a Hybrid AKS cluster to the specified endpoint. EgressEndpoint[]
enableDefaultEgressEndpoints The indicator of whether the platform default endpoints are allowed for the egress traffic. 'False'
'True'

EgressEndpoint

Name Description Value
category The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. string (required)
endpoints The list of endpoint dependencies. EndpointDependency[] (required)

EndpointDependency

Name Description Value
domainName The domain name of the dependency. string (required)
port The port of this endpoint. int

Constraints:
Min value = 1
Max value = 65535

ExtendedLocation

Name Description Value
name The resource ID of the extended location on which the resource will be created. string (required)
type The extended location type, for example, CustomLocation. string (required)

TrackedResourceTags

Name Description Value
  • Last updated on