Tjänsten Microsoft.ApiManagement/groups 2022-08-01
Bicep-resursdefinition
Resurstypen tjänst/grupper kan distribueras med åtgärder som är avsedda för:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/groups-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/groups@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
externalId: 'string'
type: 'string'
}
}
Egenskapsvärden
tjänst/grupper
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: tjänst |
| Egenskaper | Egenskaper som anges för åtgärden Skapa grupp. | GroupCreateParametersPropertiesOrGroupContractProper... |
GroupCreateParametersPropertiesOrGroupContractProper...
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Gruppbeskrivning. | sträng |
| displayName | Gruppnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300 |
| externalId | Identifierare för de externa grupperna, den här egenskapen innehåller id:t för gruppen från den externa identitetsprovidern, t.ex. för Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; annars är värdet null. |
sträng |
| typ | Grupptyp. | "anpassad" "extern" "system" |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen
|
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Resursdefinition för ARM-mall
Resurstypen tjänst/grupper kan distribueras med åtgärder som är avsedda för:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/groups-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/groups",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"externalId": "string",
"type": "string"
}
}
Egenskapsvärden
tjänst/grupper
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/groups" |
| apiVersion | Resurs-API-versionen | '2022-08-01' |
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| Egenskaper | Egenskaper som anges för åtgärden Skapa grupp. | GroupCreateParametersPropertiesOrGroupContractProper... |
GroupCreateParametersPropertiesOrGroupContractProper...
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Gruppbeskrivning. | sträng |
| displayName | Gruppnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300 |
| externalId | Identifierare för de externa grupperna, den här egenskapen innehåller id:t för gruppen från den externa identitetsprovidern, t.ex. för Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; annars är värdet null. |
sträng |
| typ | Grupptyp. | "anpassad" "extern" "system" |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
| Mall | Beskrivning |
|---|---|
|
Skapa en API Management-instans och alla underresurser med hjälp av mallen
|
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen tjänst/grupper kan distribueras med åtgärder som är avsedda för:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/groups-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/groups@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
externalId = "string"
type = "string"
}
})
}
Egenskapsvärden
tjänst/grupper
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/groups@2022-08-01" |
| Namn | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
| Egenskaper | Egenskaper som anges för åtgärden Skapa grupp. | GroupCreateParametersPropertiesOrGroupContractProper... |
GroupCreateParametersPropertiesOrGroupContractProper...
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Gruppbeskrivning. | sträng |
| displayName | Gruppnamn. | sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300 |
| externalId | Identifierare för de externa grupperna, den här egenskapen innehåller id:t för gruppen från den externa identitetsprovidern, t.ex. för Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; annars är värdet null. |
sträng |
| typ | Grupptyp. | "anpassad" "extern" "system" |