Share via

Microsoft.Network NetworkExperimentProfiles/Experiments 2019-11-01

  • Article

Bicep resource definition

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

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

Property values

Endpoint

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

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

Microsoft.Network/NetworkExperimentProfiles/Experiments

Name Description Value
location Resource location. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$ (required)
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
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

ARM template resource definition

The NetworkExperimentProfiles/Experiments 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/NetworkExperimentProfiles/Experiments resource, add the following JSON to your template.

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

Property values

Endpoint

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

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

Microsoft.Network/NetworkExperimentProfiles/Experiments

Name Description Value
apiVersion The api version '2019-11-01'
location Resource location. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$ (required)
properties The properties of an Experiment ExperimentProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Network/NetworkExperimentProfiles/Experiments'

ResourceTags

Name Description Value

Terraform (AzAPI provider) resource definition

The NetworkExperimentProfiles/Experiments 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/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"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      description = "string"
      enabledState = "string"
      endpointA = {
        endpoint = "string"
        name = "string"
      }
      endpointB = {
        endpoint = "string"
        name = "string"
      }
    }
  })
}

Property values

Endpoint

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

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

Microsoft.Network/NetworkExperimentProfiles/Experiments

Name Description Value
location Resource location. string
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: NetworkExperimentProfiles
properties The properties of an Experiment ExperimentProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Network/NetworkExperimentProfiles/Experiments@2019-11-01"

ResourceTags

Name Description Value