Dela via


Microsoft.ApiManagement-tjänsten/arbetsytor/grupper

Bicep-resursdefinition

Resurstypen tjänst/arbetsytor/grupper kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/workspaces/groups-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

tjänst/arbetsytor/grupper

Namn Beskrivning Värde
Namn Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.
sträng (krävs)
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: arbetsytor
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"

Resursdefinition för ARM-mall

Resurstypen tjänst/arbetsytor/grupper kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/workspaces/groups-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

tjänst/arbetsytor/grupper

Namn Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/workspaces/groups"
apiVersion Resurs-API-versionen "2023-09-01-preview"
Namn Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.
sträng (krävs)
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"

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/arbetsytor/grupper kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Resurs för Microsoft.ApiManagement/service/workspaces/groups lägger du till följande Terraform i mallen.

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

Egenskapsvärden

tjänst/arbetsytor/grupper

Namn Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/workspaces/groups@2023-09-01-preview"
Namn Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: arbetsytor
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"