Servizio Microsoft.ApiManagement/apiVersionSets 2022-08-01

Definizione di risorsa Bicep

Il tipo di risorsa service/apiVersionSets può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apiVersionSets, aggiungere il codice Bicep seguente al modello.

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

Valori delle proprietà

service/apiVersionSets

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.
stringa (obbligatoria)
padre In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.
Nome simbolico per la risorsa di tipo: servizio
properties Proprietà del contratto API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nome Descrizione Valore
description Descrizione del set di versioni dell'API. string
displayName Nome del set di versioni dell'API stringa (obbligatoria)
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione DELL'API se il controllo delle versioniScheme è impostato su header. string
controllo delle versioniScheme Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP. 'Intestazione'
'Query'
'Segmento' (obbligatorio)
versionQueryName Nome del parametro di query che indica la versione DELL'API se il controllo delle versioniScheme è impostato su query. string

Definizione della risorsa modello di Resource Manager

Il tipo di risorsa service/apiVersionSets può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apiVersionSets, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

service/apiVersionSets

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.ApiManagement/service/apiVersionSets'
apiVersion Versione dell'API risorsa '2022-08-01'
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.
stringa (obbligatoria)
properties Proprietà del contratto API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nome Descrizione Valore
description Descrizione del set di versioni dell'API. string
displayName Nome del set di versioni dell'API stringa (obbligatoria)
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione DELL'API se il controllo delle versioniScheme è impostato su header. string
controllo delle versioniScheme Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP. 'Intestazione'
'Query'
'Segmento' (obbligatorio)
versionQueryName Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query. string

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/apiVersionSets può essere distribuito con operazioni destinate:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apiVersionSets, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

service/apiVersionSets

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.ApiManagement/service/apiVersionSets@2022-08-01"
name Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
properties Proprietà del contratto api VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Nome Descrizione Valore
description Descrizione del set di versioni dell'API. string
displayName Nome del set di versioni dell'API stringa (obbligatorio)
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header. string
controllo delle versioniScheme Valore che determina dove si troverà l'identificatore della versione dell'API in una richiesta HTTP. "Intestazione"
"Query"
"Segmento" (obbligatorio)
versionQueryName Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query. string