Share via

Microsoft.ApiManagement service/groups 2018-01-01

  • Article

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@2018-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    externalId: 'string'
    type: 'string'
  }
}

Property values

GroupCreateParametersPropertiesOrGroupContractProperties

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

Constraints:
Min length = 1
Max length = 1 (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'

Microsoft.ApiManagement/service/groups

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (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

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": "2018-01-01",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "externalId": "string",
    "type": "string"
  }
}

Property values

GroupCreateParametersPropertiesOrGroupContractProperties

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

Constraints:
Min length = 1
Max length = 1 (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'

Microsoft.ApiManagement/service/groups

Name Description Value
apiVersion The api version '2018-01-01'
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (required)
properties Properties supplied to Create Group operation. GroupCreateParametersPropertiesOrGroupContractProperties
type The resource type 'Microsoft.ApiManagement/service/groups'

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/groups@2018-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      externalId = "string"
      type = "string"
    }
  })
}

Property values

GroupCreateParametersPropertiesOrGroupContractProperties

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

Constraints:
Min length = 1
Max length = 1 (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'

Microsoft.ApiManagement/service/groups

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = (^[\w]+$)|(^[\w][\w\-]+[\w]$) (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@2018-01-01"