Microsoft.ApiManagement service/apiVersionSets

  • Artikel

Bicep-Ressourcendefinition

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

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

Ressourcenformat

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

resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

Eigenschaftswerte

service/apiVersionSets

Name Beschreibung Wert
Name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep-festlegen.		 Zeichenfolge (erforderlich)
Elternteil 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 des Typs: Dienst-
Eigenschaften Api VersionSet-Vertragseigenschaften. ApiVersionSetContractProperties-

ApiVersionSetContractProperties

Name Beschreibung Wert
Beschreibung Beschreibung des API-Versionssatzes. Schnur
displayName Name des API-Versionssatzes Zeichenfolge (erforderlich)

Zwänge:
Min. Länge = 1
Max. Länge = 100
versionHeaderName Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 100
versioningScheme Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. 'Kopfzeile'
'Abfrage'
"Segment" (erforderlich)
versionQueryName Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 100

ARM-Vorlagenressourcendefinition

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

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

Ressourcenformat

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

{
  "type": "Microsoft.ApiManagement/service/apiVersionSets",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

Eigenschaftswerte

service/apiVersionSets

Name Beschreibung Wert
Art Der Ressourcentyp 'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion Die Ressourcen-API-Version "2023-09-01-preview"
Name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON ARM-Vorlagenfestlegen.		 Zeichenfolge (erforderlich)
Eigenschaften Api VersionSet-Vertragseigenschaften. ApiVersionSetContractProperties-

ApiVersionSetContractProperties

Name Beschreibung Wert
Beschreibung Beschreibung des API-Versionssatzes. Schnur
displayName Name des API-Versionssatzes Zeichenfolge (erforderlich)

Zwänge:
Min. Länge = 1
Max. Länge = 100
versionHeaderName Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 100
versioningScheme Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. 'Kopfzeile'
'Abfrage'
"Segment" (erforderlich)
versionQueryName Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 100

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "service/apiVersionSets" 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/apiVersionSets-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

service/apiVersionSets

Name Beschreibung Wert
Art Der Ressourcentyp "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview"
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Dienst-
Eigenschaften Api VersionSet-Vertragseigenschaften. ApiVersionSetContractProperties-

ApiVersionSetContractProperties

Name Beschreibung Wert
Beschreibung Beschreibung des API-Versionssatzes. Schnur
displayName Name des API-Versionssatzes Zeichenfolge (erforderlich)

Zwänge:
Min. Länge = 1
Max. Länge = 100
versionHeaderName Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 100
versioningScheme Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. "Kopfzeile"
"Abfrage"
"Segment" (erforderlich)
versionQueryName Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 100