Share via


Microsoft.ApiManagement-service/apiVersionSets

Bicep-resourcedefinitie

Het resourcetype service/apiVersionSets kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/apiVersionSets-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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'
  }
}

Eigenschapswaarden

service/apiVersionSets

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.
tekenreeks (vereist)
Bovenliggende In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie Onderliggende resource buiten bovenliggende resource voor meer informatie.
Symbolische naam voor resource van het type: service
properties API VersionSet contracteigenschappen. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Naam Description Waarde
beschrijving Beschrijving van API-versieset. tekenreeks
displayName Naam van API-versieset tekenreeks (vereist)
versionHeaderName De naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header. tekenreeks
versiebeheerScheme Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. 'Koptekst'
'Query'
'Segment' (vereist)
versionQueryName Naam van queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query. tekenreeks

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/apiVersionSets kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/apiVersionSets-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

service/apiVersionSets

Naam Description Waarde
type Het resourcetype 'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion De resource-API-versie '2023-05-01-preview'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.
tekenreeks (vereist)
properties API VersionSet contracteigenschappen. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Naam Description Waarde
beschrijving Beschrijving van API-versieset. tekenreeks
displayName Naam van API-versieset tekenreeks (vereist)
versionHeaderName De naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header. tekenreeks
versiebeheerScheme Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. 'Koptekst'
'Query'
'Segment' (vereist)
versionQueryName Naam van queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query. tekenreeks

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype service/apiVersionSets kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/apiVersionSets-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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"
    }
  })
}

Eigenschapswaarden

service/apiVersionSets

Naam Description Waarde
type Het resourcetype "Microsoft.ApiManagement/service/apiVersionSets@2023-05-01-preview"
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van type: service
properties API VersionSet contracteigenschappen. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Naam Description Waarde
beschrijving Beschrijving van API-versieset. tekenreeks
displayName Naam van API-versieset tekenreeks (vereist)
versionHeaderName De naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header. tekenreeks
versiebeheerScheme Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. 'Header'
"Query"
'Segment' (vereist)
versionQueryName Naam van queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query. tekenreeks