Condividi tramite

Servizio Microsoft.ApiManagement/apis/operations

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/apis/operations 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/apis/operations, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2024-06-01-preview' = {
  parent: resourceSymbolicName
  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: any(Azure.Bicep.Types.Concrete.AnyType)
            }
          }
          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(Azure.Bicep.Types.Concrete.AnyType)
            }
          }
          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(Azure.Bicep.Types.Concrete.AnyType)
            }
          }
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              examples: {
                {customized property}: {
                  description: 'string'
                  externalValue: 'string'
                  summary: 'string'
                  value: any(Azure.Bicep.Types.Concrete.AnyType)
                }
              }
              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(Azure.Bicep.Types.Concrete.AnyType)
              }
            }
            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(Azure.Bicep.Types.Concrete.AnyType)
              }
            }
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                examples: {
                  {customized property}: {
                    description: 'string'
                    externalValue: 'string'
                    summary: 'string'
                    value: any(Azure.Bicep.Types.Concrete.AnyType)
                  }
                }
                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(Azure.Bicep.Types.Concrete.AnyType)
          }
        }
        name: 'string'
        required: bool
        schemaId: 'string'
        type: 'string'
        typeName: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Valori delle proprietà

Microsoft.ApiManagement/service/apis/operations

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (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/API
proprietà Proprietà del contratto dell'operazione. OperationContractProperties

OperationContractProperties

Nome Descrizione Valore
descrizione Descrizione dell'operazione. Può includere tag di formattazione HTML. corda

Vincoli:
Lunghezza massima =
displayName Nome operazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
metodo Metodo di operazione HTTP valido. Metodi Http tipici come GET, PUT, POST, ma non limitati solo da essi. stringa (obbligatorio)
politiche Criteri operativi corda
richiesta Entità contenente i dettagli della richiesta. RequestContract
Risposte Matrice di risposte dell'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} corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

ParameterContract

Nome Descrizione Valore
defaultValue Valore del parametro predefinito. corda
descrizione Descrizione del parametro. corda
Esempi Esempio definito per il parametro . ParameterExamplesContract
nome Nome parametro. stringa (obbligatorio)
Obbligatorio Specifica se il parametro è obbligatorio o meno. Bool
schemaId Identificatore dello schema. corda
digitare Tipo di parametro. stringa (obbligatorio)
typeName Nome del tipo definito dallo schema. corda
valori Valori dei parametri. string[]

ParameterExampleContract

Nome Descrizione Valore
descrizione Descrizione lunga per l'esempio corda
externalValue URL che punta all'esempio letterale corda
sommario Breve descrizione per l'esempio corda
valore Valore di esempio. Può essere un valore primitivo o un oggetto . qualunque

ParameterExamplesContract

Nome Descrizione Valore

ParameterExamplesContract

Nome Descrizione Valore

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 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' né 'multipart/form-data'. corda
typeName Nome del tipo definito dallo schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'. corda

RequestContract

Nome Descrizione Valore
descrizione Descrizione della richiesta di operazione. corda
Intestazioni Raccolta di intestazioni della richiesta di operazione. ParameterContract[]
queryParameters Raccolta di parametri di query della richiesta di operazione. ParameterContract[]
Rappresentanze Raccolta di rappresentazioni delle richieste di operazione. RepresentationContract[]

ResponseContract

Nome Descrizione Valore
descrizione Descrizione della risposta dell'operazione. corda
Intestazioni Raccolta di intestazioni di risposta dell'operazione. ParameterContract[]
Rappresentanze Raccolta di rappresentazioni di risposta dell'operazione. RepresentationContract[]
statusCode Codice di stato HTTP della risposta all'operazione. int (obbligatorio)

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/apis/operations 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/apis/operations, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2024-06-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": {}
            }
          },
          "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": {}
            }
          },
          "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": {}
            }
          },
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "examples": {
                "{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": {}
              }
            },
            "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": {}
              }
            },
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "examples": {
                  "{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": {}
          }
        },
        "name": "string",
        "required": "bool",
        "schemaId": "string",
        "type": "string",
        "typeName": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

Valori delle proprietà

Microsoft.ApiManagement/service/apis/operations

Nome Descrizione Valore
apiVersion Versione dell'API '2024-06-01-preview'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
proprietà Proprietà del contratto dell'operazione. OperationContractProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/apis/operations'

OperationContractProperties

Nome Descrizione Valore
descrizione Descrizione dell'operazione. Può includere tag di formattazione HTML. corda

Vincoli:
Lunghezza massima =
displayName Nome operazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
metodo Metodo di operazione HTTP valido. Metodi Http tipici come GET, PUT, POST, ma non limitati solo da essi. stringa (obbligatorio)
politiche Criteri operativi corda
richiesta Entità contenente i dettagli della richiesta. RequestContract
Risposte Matrice di risposte dell'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} corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

ParameterContract

Nome Descrizione Valore
defaultValue Valore del parametro predefinito. corda
descrizione Descrizione del parametro. corda
Esempi Esempio definito per il parametro . ParameterExamplesContract
nome Nome parametro. stringa (obbligatorio)
Obbligatorio Specifica se il parametro è obbligatorio o meno. Bool
schemaId Identificatore dello schema. corda
digitare Tipo di parametro. stringa (obbligatorio)
typeName Nome del tipo definito dallo schema. corda
valori Valori dei parametri. string[]

ParameterExampleContract

Nome Descrizione Valore
descrizione Descrizione lunga per l'esempio corda
externalValue URL che punta all'esempio letterale corda
sommario Breve descrizione per l'esempio corda
valore Valore di esempio. Può essere un valore primitivo o un oggetto . qualunque

ParameterExamplesContract

Nome Descrizione Valore

ParameterExamplesContract

Nome Descrizione Valore

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 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' né 'multipart/form-data'. corda
typeName Nome del tipo definito dallo schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'. corda

RequestContract

Nome Descrizione Valore
descrizione Descrizione della richiesta di operazione. corda
Intestazioni Raccolta di intestazioni della richiesta di operazione. ParameterContract[]
queryParameters Raccolta di parametri di query della richiesta di operazione. ParameterContract[]
Rappresentanze Raccolta di rappresentazioni delle richieste di operazione. RepresentationContract[]

ResponseContract

Nome Descrizione Valore
descrizione Descrizione della risposta dell'operazione. corda
Intestazioni Raccolta di intestazioni di risposta dell'operazione. ParameterContract[]
Rappresentanze Raccolta di rappresentazioni di risposta dell'operazione. RepresentationContract[]
statusCode Codice di stato HTTP della risposta all'operazione. int (obbligatorio)

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/apis/operations 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/apis/operations, aggiungere il file Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2024-06-01-preview"
  name = "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"
                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 = ?
              }
            }
            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 = ?
              }
            }
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                examples = {
                  {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 = ?
                }
              }
              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 = ?
                }
              }
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  examples = {
                    {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 = ?
            }
          }
          name = "string"
          required = bool
          schemaId = "string"
          type = "string"
          typeName = "string"
          values = [
            "string"
          ]
        }
      ]
      urlTemplate = "string"
    }
  })
}

Valori delle proprietà

Microsoft.ApiManagement/service/apis/operations

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio/API
proprietà Proprietà del contratto dell'operazione. OperationContractProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/apis/operations@2024-06-01-preview"

OperationContractProperties

Nome Descrizione Valore
descrizione Descrizione dell'operazione. Può includere tag di formattazione HTML. corda

Vincoli:
Lunghezza massima =
displayName Nome operazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
metodo Metodo di operazione HTTP valido. Metodi Http tipici come GET, PUT, POST, ma non limitati solo da essi. stringa (obbligatorio)
politiche Criteri operativi corda
richiesta Entità contenente i dettagli della richiesta. RequestContract
Risposte Matrice di risposte dell'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} corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

ParameterContract

Nome Descrizione Valore
defaultValue Valore del parametro predefinito. corda
descrizione Descrizione del parametro. corda
Esempi Esempio definito per il parametro . ParameterExamplesContract
nome Nome parametro. stringa (obbligatorio)
Obbligatorio Specifica se il parametro è obbligatorio o meno. Bool
schemaId Identificatore dello schema. corda
digitare Tipo di parametro. stringa (obbligatorio)
typeName Nome del tipo definito dallo schema. corda
valori Valori dei parametri. string[]

ParameterExampleContract

Nome Descrizione Valore
descrizione Descrizione lunga per l'esempio corda
externalValue URL che punta all'esempio letterale corda
sommario Breve descrizione per l'esempio corda
valore Valore di esempio. Può essere un valore primitivo o un oggetto . qualunque

ParameterExamplesContract

Nome Descrizione Valore

ParameterExamplesContract

Nome Descrizione Valore

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 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' né 'multipart/form-data'. corda
typeName Nome del tipo definito dallo schema. Applicabile solo se il valore 'contentType' non è 'application/x-www-form-urlencoded' né 'multipart/form-data'. corda

RequestContract

Nome Descrizione Valore
descrizione Descrizione della richiesta di operazione. corda
Intestazioni Raccolta di intestazioni della richiesta di operazione. ParameterContract[]
queryParameters Raccolta di parametri di query della richiesta di operazione. ParameterContract[]
Rappresentanze Raccolta di rappresentazioni delle richieste di operazione. RepresentationContract[]

ResponseContract

Nome Descrizione Valore
descrizione Descrizione della risposta dell'operazione. corda
Intestazioni Raccolta di intestazioni di risposta dell'operazione. ParameterContract[]
Rappresentanze Raccolta di rappresentazioni di risposta dell'operazione. RepresentationContract[]
statusCode Codice di stato HTTP della risposta all'operazione. int (obbligatorio)