Servizio Microsoft.ApiManagement/apis/operations 2023-05-01-preview
Definizione di risorsa Bicep
Il tipo di risorsa service/apis/operations può essere distribuito con operazioni destinate:
- 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 di risorsa
Per creare una risorsa Microsoft.ApiManagement/service/apis/operations, aggiungere il codice Bicep seguente al modello.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
method: 'string'
policies: 'string'
request: {
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
queryParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
schemaId: 'string'
typeName: 'string'
}
]
}
responses: [
{
description: 'string'
headers: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
representations: [
{
contentType: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
schemaId: 'string'
typeName: 'string'
}
]
statusCode: int
}
]
templateParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
Valori delle proprietà
service/apis/operations
| Nome | Descrizione | valore |
|---|---|---|
| name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep. |
stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
| 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: api |
| properties | Proprietà del contratto di operazione. | OperationContractProperties |
OperationContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione dell'operazione. Può includere tag di formattazione HTML. | string |
| displayName | Nome operazione. | stringa (obbligatoria) |
| method | Metodo di operazione HTTP valido. Metodi Http tipici come GET, PUT, POST, ma non limitati solo da essi. | stringa (obbligatoria) |
| criteri | Criteri di operazione | string |
| richiesta | Entità contenente i dettagli della richiesta. | RequestContract |
| responses | Matrice di risposte all'operazione. | ResponseContract[] |
| templateParameters | Raccolta di parametri del modello URL. | ParameterContract[] |
| urlTemplate | Modello di URL relativo che identifica la risorsa di destinazione per questa operazione. Può includere parametri. Esempio: /customers/{cid}/orders/{oid}/?date={date} | stringa (obbligatoria) |
RequestContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione della richiesta dell'operazione. | string |
| headers | Raccolta di intestazioni per la richiesta di operazione. | ParameterContract[] |
| queryParameters | Raccolta di parametri di query per la richiesta di operazione. | ParameterContract[] |
| representations | Raccolta di rappresentazioni della richiesta dell'operazione. | RappresentazioneContract[] |
ParameterContract
| Nome | Descrizione | Valore |
|---|---|---|
| defaultValue | Valore predefinito del parametro. | string |
| description | Descrizione del parametro. | string |
| esempi | Esempio definito per il parametro. | ParameterExamplesContract |
| name | Nome del parametro. | stringa (obbligatorio) |
| necessario | Indica se il parametro è obbligatorio o no. | bool |
| schemaId | Identificatore dello schema. | string |
| type | Tipo di parametro. | stringa (obbligatorio) |
| typeName | Nome del tipo definito dallo schema. | string |
| valori | Valori del parametro. | string[] |
ParameterExamplesContract
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | ParameterExampleContract | |
| {proprietà personalizzata} | ParameterExampleContract |
ParameterExampleContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione estesa per l'esempio | string |
| externalValue | URL che punta all'esempio letterale | string |
| riepilogo | Breve descrizione per l'esempio | string |
| Valore | Valore di esempio. Può essere un valore primitivo o un oggetto . | Per Bicep, è possibile usare la funzione any(). |
RepresentationContract
| Nome | Descrizione | Valore |
|---|---|---|
| contentType | Specifica un tipo di contenuto registrato o personalizzato per questa rappresentazione, ad esempio application/xml. | stringa (obbligatorio) |
| esempi | Esempio definito per la rappresentazione. | ParameterExamplesContract |
| formParameters | Raccolta di parametri del modulo. Obbligatorio se il valore 'contentType' è 'application/x-www-form-urlencoded' o 'multipart/form-data'. | ParameterContract[] |
| schemaId | Identificatore dello schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'. | string |
| typeName | Nome del tipo definito dallo schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'. | string |
ResponseContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione della risposta dell'operazione. | string |
| headers | Raccolta di intestazioni di risposta dell'operazione. | ParameterContract[] |
| representations | Raccolta di rappresentazioni della risposta dell'operazione. | RepresentationContract[] |
| statusCode | Codice di stato HTTP della risposta dell'operazione. | int (obbligatorio) |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa service/apis/operations può essere distribuito con operazioni destinate:
- Gruppi di risorse - Vedere i comandi di distribuzione dei 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/apis/operations, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"method": "string",
"policies": "string",
"request": {
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"queryParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"schemaId": "string",
"typeName": "string"
}
]
},
"responses": [
{
"description": "string",
"headers": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"representations": [
{
"contentType": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"schemaId": "string",
"typeName": "string"
}
],
"statusCode": "int"
}
],
"templateParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"name": "string",
"required": "bool",
"schemaId": "string",
"type": "string",
"typeName": "string",
"values": [ "string" ]
}
],
"urlTemplate": "string"
}
}
Valori delle proprietà
service/apis/operations
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | 'Microsoft.ApiManagement/service/apis/operations' |
| apiVersion | Versione dell'API della risorsa | '2023-05-01-preview' |
| name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON. |
stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
| properties | Proprietà del contratto di operazione. | OperationContractProperties |
OperationContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione dell'operazione. Può includere tag di formattazione HTML. | string |
| displayName | Nome operazione. | stringa (obbligatoria) |
| method | Metodo di operazione HTTP valido. Metodi Http tipici come GET, PUT, POST, ma non limitati solo da essi. | stringa (obbligatoria) |
| criteri | Criteri di operazione | string |
| richiesta | Entità contenente i dettagli della richiesta. | RequestContract |
| responses | Matrice di risposte all'operazione. | ResponseContract[] |
| templateParameters | Raccolta di parametri del modello URL. | ParameterContract[] |
| urlTemplate | Modello di URL relativo che identifica la risorsa di destinazione per questa operazione. Può includere parametri. Esempio: /customers/{cid}/orders/{oid}/?date={date} | stringa (obbligatoria) |
RequestContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione della richiesta dell'operazione. | string |
| headers | Raccolta di intestazioni per la richiesta di operazione. | ParameterContract[] |
| queryParameters | Raccolta di parametri di query per la richiesta di operazione. | ParameterContract[] |
| representations | Raccolta di rappresentazioni della richiesta dell'operazione. | RappresentazioneContract[] |
ParameterContract
| Nome | Descrizione | Valore |
|---|---|---|
| defaultValue | Valore predefinito del parametro. | string |
| description | Descrizione del parametro. | string |
| esempi | Esempio definito per il parametro. | ParameterExamplesContract |
| name | Nome del parametro. | stringa (obbligatoria) |
| necessario | Indica se il parametro è obbligatorio o no. | bool |
| schemaId | Identificatore dello schema. | string |
| type | Tipo di parametro. | stringa (obbligatoria) |
| typeName | Nome del tipo definito dallo schema. | string |
| valori | Valori del parametro. | string[] |
ParameterExamplesContract
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | ParameterExampleContract | |
| {proprietà personalizzata} | ParameterExampleContract |
ParameterExampleContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione estesa per l'esempio | string |
| externalValue | URL che punta all'esempio letterale | string |
| riepilogo | Breve descrizione per l'esempio | string |
| Valore | Valore di esempio. Può essere un valore primitivo o un oggetto . |
RepresentationContract
| Nome | Descrizione | Valore |
|---|---|---|
| contentType | Specifica un tipo di contenuto registrato o personalizzato per questa rappresentazione, ad esempio application/xml. | stringa (obbligatorio) |
| esempi | Esempio definito per la rappresentazione. | ParameterExamplesContract |
| formParameters | Raccolta di parametri del modulo. Obbligatorio se il valore 'contentType' è 'application/x-www-form-urlencoded' o 'multipart/form-data'. | ParameterContract[] |
| schemaId | Identificatore dello schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'. | string |
| typeName | Nome del tipo definito dallo schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'. | string |
ResponseContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione della risposta dell'operazione. | string |
| headers | Raccolta di intestazioni di risposta dell'operazione. | ParameterContract[] |
| representations | Raccolta di rappresentazioni della risposta dell'operazione. | RepresentationContract[] |
| statusCode | Codice di stato HTTP della risposta dell'operazione. | int (obbligatorio) |
Definizione della risorsa Terraform (provider AzAPI)
Il tipo di risorsa service/apis/operations 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/apis/operations, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
method = "string"
policies = "string"
request = {
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
queryParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
schemaId = "string"
typeName = "string"
}
]
}
responses = [
{
description = "string"
headers = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
schemaId = "string"
typeName = "string"
}
]
statusCode = int
}
]
templateParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
urlTemplate = "string"
}
})
}
Valori delle proprietà
service/apis/operations
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | "Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview" |
| name | Nome della risorsa | stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
| parent_id | ID della risorsa padre per questa risorsa. | ID per la risorsa di tipo: api |
| properties | Proprietà del contratto dell'operazione. | OperationContractProperties |
OperationContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione dell'operazione. Può includere tag di formattazione HTML. | string |
| displayName | Nome operazione. | stringa (obbligatorio) |
| method | Metodo di operazione HTTP valido. Metodi Http tipici come GET, PUT, POST, ma non limitati solo da essi. | stringa (obbligatorio) |
| criteri | Criteri dell'operazione | string |
| richiesta | Entità contenente i dettagli della richiesta. | RequestContract |
| responses | Matrice di risposte all'operazione. | ResponseContract[] |
| templateParameters | Raccolta di parametri del modello URL. | ParameterContract[] |
| urlTemplate | Modello di URL relativo che identifica la risorsa di destinazione per questa operazione. Può includere parametri. Esempio: /customers/{cid}/orders/{oid}/?date={date} | stringa (obbligatoria) |
RequestContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione della richiesta dell'operazione. | string |
| headers | Raccolta di intestazioni per la richiesta di operazione. | ParameterContract[] |
| queryParameters | Raccolta di parametri di query per la richiesta di operazione. | ParameterContract[] |
| representations | Raccolta di rappresentazioni della richiesta dell'operazione. | RappresentazioneContract[] |
ParameterContract
| Nome | Descrizione | Valore |
|---|---|---|
| defaultValue | Valore predefinito del parametro. | string |
| description | Descrizione del parametro. | string |
| esempi | Esempio definito per il parametro. | ParameterExamplesContract |
| name | Nome del parametro. | stringa (obbligatoria) |
| necessario | Indica se il parametro è obbligatorio o no. | bool |
| schemaId | Identificatore dello schema. | string |
| type | Tipo di parametro. | stringa (obbligatoria) |
| typeName | Nome del tipo definito dallo schema. | string |
| valori | Valori del parametro. | string[] |
ParameterExamplesContract
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | ParameterExampleContract | |
| {proprietà personalizzata} | ParameterExampleContract |
ParameterExampleContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione prolungata per l'esempio | string |
| externalValue | URL che punta all'esempio letterale | string |
| riepilogo | Breve descrizione per l'esempio | string |
| Valore | Valore di esempio. Può essere un valore primitivo o un oggetto. |
RappresentazioneContract
| Nome | Descrizione | Valore |
|---|---|---|
| contentType | Specifica un tipo di contenuto registrato o personalizzato per questa rappresentazione, ad esempio applicazione/xml. | stringa (obbligatoria) |
| esempi | Esempio definito per la rappresentazione. | ParameterExamplesContract |
| formParameters | Raccolta di parametri di modulo. Obbligatorio se il valore 'contentType' è 'application/x-www-form-urlencoded' o 'multipart/form-data'. | ParameterContract[] |
| schemaId | Identificatore dello schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' o 'multipart/form-data'. | string |
| typeName | Nome del tipo definito dallo schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'. | string |
ResponseContract
| Nome | Descrizione | Valore |
|---|---|---|
| description | Descrizione della risposta dell'operazione. | string |
| headers | Raccolta di intestazioni di risposta dell'operazione. | ParameterContract[] |
| representations | Raccolta di rappresentazioni della risposta dell'operazione. | RepresentationContract[] |
| statusCode | Codice di stato HTTP della risposta dell'operazione. | int (obbligatorio) |