Microsoft.ApiManagement service/apiVersionSets

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp service/apiVersionSets kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

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 Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/apiVersionSets@2023-05-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)
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 API VersionSet-Vertragseigenschaften. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Name BESCHREIBUNG Wert
description Beschreibung des API-Versionssatzes. Zeichenfolge
displayName Name des API-Versionssatzes Zeichenfolge (erforderlich)
versionHeaderName Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. Zeichenfolge
versionsverwaltungScheme Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. "Header"
"Abfrage"
"Segment" (erforderlich)
versionQueryName Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp service/apiVersionSets kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

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-05-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

Eigenschaftswerte

service/apiVersionSets

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/apiVersionSets"
apiVersion Die Ressourcen-API-Version '2023-05-01-preview'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 Zeichenfolge (erforderlich)
properties API VersionSet-Vertragseigenschaften. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Name BESCHREIBUNG Wert
description Beschreibung des API-Versionssatzes. Zeichenfolge
displayName Name des API-Versionssatzes Zeichenfolge (erforderlich)
versionHeaderName Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. Zeichenfolge
versionsverwaltungScheme Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. "Header"
"Abfrage"
"Segment" (erforderlich)
versionQueryName Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. Zeichenfolge

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp service/apiVersionSets kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • 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 der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apiVersionSets@2023-05-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
type Ressourcentyp "Microsoft.ApiManagement/service/apiVersionSets@2023-05-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: Dienst
properties API VersionSet-Vertragseigenschaften. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Name BESCHREIBUNG Wert
description Beschreibung des API-Versionssatzes. Zeichenfolge
displayName Name des API-Versionssatzes Zeichenfolge (erforderlich)
versionHeaderName Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist. Zeichenfolge
versionsverwaltungScheme Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet. „Header“
"Abfrage"
"Segment" (erforderlich)
versionQueryName Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist. Zeichenfolge