Microsoft.ApiManagement service/groups 2023-09-01-preview
Bicep resource definition
The service/groups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
externalId: 'string'
type: 'string'
}
}
Property values
service/groups
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| 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. | GroupCreateParametersPropertiesOrGroupContractProper... |
GroupCreateParametersPropertiesOrGroupContractProper...
| Name | Description | Value |
|---|---|---|
| description | Group description. | string |
| displayName | Group name. | string (required) Constraints: Min length = 1 Max length = 300 |
| 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' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create an API Management instance and all sub resources using template |
This template demonstrates how to create a API Management service and configure sub-entities |
ARM template resource definition
The service/groups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2023-09-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"externalId": "string",
"type": "string"
}
}
Property values
service/groups
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/groups' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| properties | Properties supplied to Create Group operation. | GroupCreateParametersPropertiesOrGroupContractProper... |
GroupCreateParametersPropertiesOrGroupContractProper...
| Name | Description | Value |
|---|---|---|
| description | Group description. | string |
| displayName | Group name. | string (required) Constraints: Min length = 1 Max length = 300 |
| 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' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create an API Management instance and all sub resources using template |
This template demonstrates how to create a API Management service and configure sub-entities |
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@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
externalId = "string"
type = "string"
}
})
}
Property values
service/groups
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/groups@2023-09-01-preview" |
| name | The resource name | string (required) Character limit: 1-80 Valid characters: Alphanumerics and hyphens. Start with letter and end with alphanumeric. |
| 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. | GroupCreateParametersPropertiesOrGroupContractProper... |
GroupCreateParametersPropertiesOrGroupContractProper...
| Name | Description | Value |
|---|---|---|
| description | Group description. | string |
| displayName | Group name. | string (required) Constraints: Min length = 1 Max length = 300 |
| 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" |