Share via

Microsoft.ApiManagement service/groups 2022-04-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.ApiManagement/service/groups@2022-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    externalId: 'string'
    type: 'string'
  }
}

Property Values

Microsoft.ApiManagement/service/groups

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 256 (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
properties Properties supplied to Create Group operation. GroupCreateParametersPropertiesOrGroupContractProperties

GroupCreateParametersPropertiesOrGroupContractProperties

Name Description Value
description Group description. string
displayName Group name. string

Constraints:
Min length = 1
Max length = 300 (required)
externalId Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null. string
type Group type. 'custom'
'external'
'system'

ARM template resource definition

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

{
  "type": "Microsoft.ApiManagement/service/groups",
  "apiVersion": "2022-04-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "externalId": "string",
    "type": "string"
  }
}

Property Values

Microsoft.ApiManagement/service/groups

Name Description Value
apiVersion The api version '2022-04-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 256 (required)
properties Properties supplied to Create Group operation. GroupCreateParametersPropertiesOrGroupContractProperties
type The resource type 'Microsoft.ApiManagement/service/groups'

GroupCreateParametersPropertiesOrGroupContractProperties

Name Description Value
description Group description. string
displayName Group name. string

Constraints:
Min length = 1
Max length = 300 (required)
externalId Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null. string
type Group type. 'custom'
'external'
'system'

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/groups@2022-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      description = "string"
      displayName = "string"
      externalId = "string"
      type = "string"
    }
  }
}

Property Values

Microsoft.ApiManagement/service/groups

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 256 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service
properties Properties supplied to Create Group operation. GroupCreateParametersPropertiesOrGroupContractProperties
type The resource type "Microsoft.ApiManagement/service/groups@2022-04-01-preview"

GroupCreateParametersPropertiesOrGroupContractProperties

Name Description Value
description Group description. string
displayName Group name. string

Constraints:
Min length = 1
Max length = 300 (required)
externalId Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null. string
type Group type. 'custom'
'external'
'system'

Usage Examples

Terraform Samples

A basic example of deploying API Management Group.

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 = "westeurope"
}

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@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  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.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"   = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"   = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384"      = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168"                         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30"                              = "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 = 1
      name     = "Developer"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  timeouts {
    create = "180m"
    update = "180m"
    delete = "180m"
  }
}

resource "azapi_resource" "group" {
  type      = "Microsoft.ApiManagement/service/groups@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      description = ""
      displayName = "Test Group"
      externalId  = ""
      type        = "custom"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on