Share via

Microsoft.ApiManagement service/apis/tags

Bicep resource definition

The service/apis/tags 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.ApiManagement/service/apis/tags resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/apis/tags@2025-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
}

Property Values

Microsoft.ApiManagement/service/apis/tags

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (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: service/apis

Usage Examples

Bicep Samples

A basic example of deploying API Management API Tag.

param resourceName string = 'acctest0001'
param location string = 'westus'

resource service 'Microsoft.ApiManagement/service@2022-08-01' = {
  name: '${resourceName}-service'
  location: location
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
  sku: {
    capacity: 0
    name: 'Consumption'
  }
}

resource api 'Microsoft.ApiManagement/service/apis@2022-08-01' = {
  parent: service
  name: '${resourceName}-api;rev=1'
  properties: {
    apiRevisionDescription: ''
    apiType: 'http'
    apiVersionDescription: ''
    authenticationSettings: {}
    displayName: 'api1'
    path: 'api1'
    protocols: [
      'https'
    ]
    subscriptionRequired: true
    type: 'http'
  }
}

resource tag 'Microsoft.ApiManagement/service/tags@2022-08-01' = {
  parent: service
  name: '${resourceName}-tag'
  properties: {
    displayName: 'acctest0001-tag'
  }
}

ARM template resource definition

The service/apis/tags 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.ApiManagement/service/apis/tags resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/apis/tags",
  "apiVersion": "2025-03-01-preview",
  "name": "string"
}

Property Values

Microsoft.ApiManagement/service/apis/tags

Name Description Value
apiVersion The api version '2025-03-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (required)
type The resource type 'Microsoft.ApiManagement/service/apis/tags'

Usage Examples

Terraform (AzAPI provider) resource definition

The service/apis/tags 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.ApiManagement/service/apis/tags resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/tags@2025-03-01-preview"
  name = "string"
  parent_id = "string"
}

Property Values

Microsoft.ApiManagement/service/apis/tags

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 80
Pattern = ^[^*#&+:<>?]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service/apis
type The resource type "Microsoft.ApiManagement/service/apis/tags@2025-03-01-preview"

Usage Examples

Terraform Samples

A basic example of deploying API Management API Tag.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2022-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-service"
  location  = var.location
  body = {
    properties = {
      certificates = []
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
}

resource "azapi_resource" "api" {
  type      = "Microsoft.ApiManagement/service/apis@2022-08-01"
  parent_id = azapi_resource.service.id
  name      = "${var.resource_name}-api;rev=1"
  body = {
    properties = {
      apiRevisionDescription = ""
      apiType                = "http"
      apiVersionDescription  = ""
      authenticationSettings = {}
      displayName            = "api1"
      path                   = "api1"
      protocols              = ["https"]
      subscriptionRequired   = true
      type                   = "http"
    }
  }
}

resource "azapi_resource" "tag" {
  type      = "Microsoft.ApiManagement/service/tags@2022-08-01"
  parent_id = azapi_resource.service.id
  name      = "${var.resource_name}-tag"
  body = {
    properties = {
      displayName = "${var.resource_name}-tag"
    }
  }
}
  • Last updated on