Microsoft.Network NetworkExperimentProfiles/Experiments

  • Article

Bicep resource definition

The NetworkExperimentProfiles/Experiments resource type can be deployed to:

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

Resource format

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

resource symbolicname 'Microsoft.Network/NetworkExperimentProfiles/Experiments@2019-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    enabledState: 'string'
    endpointA: {
      endpoint: 'string'
      name: 'string'
    }
    endpointB: {
      endpoint: 'string'
      name: 'string'
    }
  }
}

Property values

NetworkExperimentProfiles/Experiments

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: NetworkExperimentProfiles
properties The properties of an Experiment ExperimentProperties

ExperimentProperties

Name Description Value
description The description of the details or intents of the Experiment string
enabledState The state of the Experiment 'Disabled'
'Enabled'
endpointA The endpoint A of an experiment Endpoint
endpointB The endpoint B of an experiment Endpoint

Endpoint

Name Description Value
endpoint The endpoint URL string
name The name of the endpoint string

ARM template resource definition

The NetworkExperimentProfiles/Experiments resource type can be deployed to:

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

Resource format

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

{
  "type": "Microsoft.Network/NetworkExperimentProfiles/Experiments",
  "apiVersion": "2019-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "description": "string",
    "enabledState": "string",
    "endpointA": {
      "endpoint": "string",
      "name": "string"
    },
    "endpointB": {
      "endpoint": "string",
      "name": "string"
    }
  }
}

Property values

NetworkExperimentProfiles/Experiments

Name Description Value
type The resource type 'Microsoft.Network/NetworkExperimentProfiles/Experiments'
apiVersion The resource api version '2019-11-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties The properties of an Experiment ExperimentProperties

ExperimentProperties

Name Description Value
description The description of the details or intents of the Experiment string
enabledState The state of the Experiment 'Disabled'
'Enabled'
endpointA The endpoint A of an experiment Endpoint
endpointB The endpoint B of an experiment Endpoint

Endpoint

Name Description Value
endpoint The endpoint URL string
name The name of the endpoint string

Terraform (AzAPI provider) resource definition

The NetworkExperimentProfiles/Experiments resource type can be deployed to:

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/NetworkExperimentProfiles/Experiments@2019-11-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      description = "string"
      enabledState = "string"
      endpointA = {
        endpoint = "string"
        name = "string"
      }
      endpointB = {
        endpoint = "string"
        name = "string"
      }
    }
  })
}

Property values

NetworkExperimentProfiles/Experiments

Name Description Value
type The resource type "Microsoft.Network/NetworkExperimentProfiles/Experiments@2019-11-01"
name The resource name string (required)
location Resource location. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: NetworkExperimentProfiles
tags Resource tags. Dictionary of tag names and values.
properties The properties of an Experiment ExperimentProperties

ExperimentProperties

Name Description Value
description The description of the details or intents of the Experiment string
enabledState The state of the Experiment "Disabled"
"Enabled"
endpointA The endpoint A of an experiment Endpoint
endpointB The endpoint B of an experiment Endpoint

Endpoint

Name Description Value
endpoint The endpoint URL string
name The name of the endpoint string