Condividi tramite


Servizio Microsoft.ApiManagement/apiVersionSets 2023-09-01-preview

Definizione di risorsa Bicep

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

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

Valori delle proprietà

ApiVersionSetContractProperties

Nome Descrizione Valore
descrizione Descrizione del set di versioni dell'API. corda
displayName Nome del set di versioni dell'API corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
controllo delle versioniScheme Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP. 'Header'
'Query'
'Segment' (obbligatorio)
versionQueryName Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1

Microsoft.ApiManagement/service/apiVersionSets

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
genitore 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 all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: servizio
proprietà Proprietà del contratto VersionSet dell'API. ApiVersionSetContractProperties

Definizione di risorsa del modello di Resource Manager

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

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

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

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

Valori delle proprietà

ApiVersionSetContractProperties

Nome Descrizione Valore
descrizione Descrizione del set di versioni dell'API. corda
displayName Nome del set di versioni dell'API corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
controllo delle versioniScheme Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP. 'Header'
'Query'
'Segment' (obbligatorio)
versionQueryName Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1

Microsoft.ApiManagement/service/apiVersionSets

Nome Descrizione Valore
apiVersion Versione dell'API '2023-09-01-preview'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
proprietà Proprietà del contratto VersionSet dell'API. ApiVersionSetContractProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/apiVersionSets'

Definizione di risorsa Terraform (provider AzAPI)

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

  • gruppi di risorse

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

Formato 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@2023-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

Valori delle proprietà

ApiVersionSetContractProperties

Nome Descrizione Valore
descrizione Descrizione del set di versioni dell'API. corda
displayName Nome del set di versioni dell'API corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
controllo delle versioniScheme Valore che determina dove si trova l'identificatore della versione dell'API in una richiesta HTTP. 'Header'
'Query'
'Segment' (obbligatorio)
versionQueryName Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1

Microsoft.ApiManagement/service/apiVersionSets

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Proprietà del contratto VersionSet dell'API. ApiVersionSetContractProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/apiVersionSets@2023-09-01-preview"