Freigeben über

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

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp service/groups kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/groups-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep-Ressource hinzu.

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

Eigenschaftswerte

service/groups

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource vom Typ: Dienst
properties Eigenschaften, die für den Vorgang "Gruppe erstellen" bereitgestellt werden. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Name BESCHREIBUNG Wert
description Beschreibung der Gruppe. Zeichenfolge
displayName Gruppenname. Zeichenfolge (erforderlich)
externalId Bezeichner der externen Gruppen, diese Eigenschaft enthält die ID der Gruppe aus dem externen Identitätsanbieter, z. B. für Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; andernfalls ist der Wert NULL. Zeichenfolge
type Gruppentyp. "Benutzerdefiniert"
"extern"
"System"

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage

Bereitstellen in Azure		 Diese Vorlage veranschaulicht, wie Sie einen API Management-Dienst erstellen und Untergeordnetetitäten konfigurieren.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp service/groups kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/groups-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

service/groups

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.ApiManagement/service/groups"
apiVersion Die Version der Ressourcen-API "2021-04-01-preview"
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
properties Eigenschaften, die für den Vorgang "Gruppe erstellen" bereitgestellt werden. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Name BESCHREIBUNG Wert
description Beschreibung der Gruppe. Zeichenfolge
displayName Gruppenname. Zeichenfolge (erforderlich)
externalId Bezeichner der externen Gruppen, diese Eigenschaft enthält die ID der Gruppe vom externen Identitätsanbieter, z. B. für Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; andernfalls ist der Wert NULL. Zeichenfolge
type Gruppentyp. "Benutzerdefiniert"
"extern"
"System"

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen einer API Management-Instanz und aller Unterressourcen mithilfe einer Vorlage

Bereitstellen in Azure		 Diese Vorlage veranschaulicht, wie Sie einen API Management Dienst erstellen und Unterentitäten konfigurieren.

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp Dienst/Gruppen kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/groups-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.

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

Eigenschaftswerte

service/groups

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/groups@2021-04-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: Dienst
properties Eigenschaften, die für den Vorgang "Gruppe erstellen" angegeben werden. GroupCreateParametersPropertiesOrGroupContractProper...

GroupCreateParametersPropertiesOrGroupContractProper...

Name BESCHREIBUNG Wert
description Beschreibung der Gruppe. Zeichenfolge
displayName Gruppenname. Zeichenfolge (erforderlich)
externalId Bezeichner der externen Gruppen, diese Eigenschaft enthält die ID der Gruppe vom externen Identitätsanbieter, z. B. für Azure Active Directory aad://{tenant}.onmicrosoft.com/groups/{group object id}; andernfalls ist der Wert NULL. Zeichenfolge
type Gruppentyp. "custom"
"extern"
"System"