Partager via

Service Microsoft.ApiManagement/apis/operations

  • Article

Définition de ressource Bicep

Le type de ressource service/apis/operations peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/apis/operations, ajoutez le Bicep suivant à votre modèle.

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

Valeurs de propriétés

service/apis/operations

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 string (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : apis
properties Propriétés du contrat d’opération. OperationContractProperties

OperationContractProperties

Nom Description Valeur
description Description de l’opération. Peut comporter des balises de mise en forme. string
displayName Nom de l’opération. string (obligatoire)
method Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas limitées par elles uniquement. string (obligatoire)
stratégies Stratégies d’opération string
request Entité qui contient les détails de la demande. RequestContract
responses Tableau de réponses d’opération. ResponseContract[]
templateParameters Collection de paramètres de modèle d’URL. ParameterContract[]
urlTemplate Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date} string (obligatoire)

RequestContract

Nom Description Valeur
description Description de la demande d’opération. string
headers Collection d'en-têtes de la demande d'opération. ParameterContract[]
queryParameters Collection de paramètres de requête de la demande d'opération ParameterContract[]
representations Collection de représentations de demande d’opération. RepresentationContract[]

ParameterContract

Nom Description Valeur
defaultValue Valeur par défaut du paramètre. string
description Description du paramètre. string
exemples Exemple défini pour le paramètre . ParameterExamplesContract
name Nom du paramètre. string (obligatoire)
obligatoire Indique si le paramètre est obligatoire ou non. bool
schemaId Identificateur de schéma. string
type Type de paramètre. string (obligatoire)
typeName Nom de type défini par le schéma. string
values Valeurs du paramètre. string[]

ParameterExamplesContract

Nom Description Valeur
{propriété personnalisée} ParameterExampleContract
{propriété personnalisée} ParameterExampleContract

ParameterExampleContract

Nom Description Valeur
description Description longue de l’exemple string
externalValue URL qui pointe vers l’exemple littéral string
Récapitulatif Brève description de l’exemple string
value Exemple de valeur. Il peut s’agir d’une valeur primitive ou d’un objet . Pour Bicep, vous pouvez utiliser la fonction any().

RepresentationContract

Nom Description Valeur
contentType Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml. string (obligatoire)
exemples Exemple défini pour la représentation. ParameterExamplesContract
formParameters Collection de paramètres de formulaire. Obligatoire si la valeur « contentType » est « application/x-www-form-urlencoded » ou « multipart/form-data ». ParameterContract[]
schemaId Identificateur de schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ». string
typeName Nom de type défini par le schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ». string

ResponseContract

Nom Description Valeur
description Description de la réponse de l’opération. string
headers Collection d’en-têtes de réponse d’opération. ParameterContract[]
representations Collection de représentations de la réponse de l’opération. RepresentationContract[]
statusCode Code http status de réponse de l’opération. int (obligatoire)

Définition de ressources de modèle ARM

Le type de ressource service/apis/operations peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/apis/operations, ajoutez le JSON suivant à votre modèle.

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

Valeurs de propriétés

service/apis/operations

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/apis/operations »
apiVersion Version de l’API de ressource '2023-05-01-preview'
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
properties Propriétés du contrat d’opération. OperationContractProperties

OperationContractProperties

Nom Description Valeur
description Description de l’opération. Peut comporter des balises de mise en forme. string
displayName Nom de l’opération. chaîne (obligatoire)
method Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas limitées par elles uniquement. chaîne (obligatoire)
stratégies Stratégies d’opération string
request Entité qui contient les détails de la demande. RequestContract
responses Tableau de réponses d’opération. ResponseContract[]
templateParameters Collection de paramètres de modèle d’URL. ParameterContract[]
urlTemplate Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date} chaîne (obligatoire)

RequestContract

Nom Description Valeur
description Description de la demande d’opération. string
headers Collection d'en-têtes de la demande d'opération. ParameterContract[]
queryParameters Collection de paramètres de requête de la demande d'opération ParameterContract[]
representations Collection de représentations de demande d’opération. RepresentationContract[]

ParameterContract

Nom Description Valeur
defaultValue Valeur par défaut du paramètre. string
description Description du paramètre. string
exemples Exemple défini pour le paramètre . ParameterExamplesContract
name Nom du paramètre. chaîne (obligatoire)
obligatoire Indique si le paramètre est obligatoire ou non. bool
schemaId Identificateur de schéma. string
type Type de paramètre. chaîne (obligatoire)
typeName Nom de type défini par le schéma. string
values Valeurs du paramètre. string[]

ParameterExamplesContract

Nom Description Valeur
{propriété personnalisée} ParameterExampleContract
{propriété personnalisée} ParameterExampleContract

ParameterExampleContract

Nom Description Valeur
description Description longue de l’exemple string
externalValue URL qui pointe vers l’exemple littéral string
Récapitulatif Brève description de l’exemple string
value Exemple de valeur. Il peut s’agir d’une valeur primitive ou d’un objet .

RepresentationContract

Nom Description Valeur
contentType Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml. string (obligatoire)
exemples Exemple défini pour la représentation. ParameterExamplesContract
formParameters Collection de paramètres de formulaire. Obligatoire si la valeur « contentType » est « application/x-www-form-urlencoded » ou « multipart/form-data ». ParameterContract[]
schemaId Identificateur de schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ». string
typeName Nom de type défini par le schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ». string

ResponseContract

Nom Description Valeur
description Description de la réponse de l’opération. string
headers Collection d’en-têtes de réponse d’opération. ParameterContract[]
representations Collection de représentations de la réponse de l’opération. RepresentationContract[]
statusCode Code http status de réponse de l’opération. int (obligatoire)

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/apis/operations peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/apis/operations, ajoutez le Terraform suivant à votre modèle.

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

Valeurs de propriétés

service/apis/operations

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview »
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : apis
properties Propriétés du contrat d’opération. OperationContractProperties

OperationContractProperties

Nom Description Valeur
description Description de l’opération. Peut comporter des balises de mise en forme. string
displayName Nom de l’opération. string (obligatoire)
method Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas limitées par elles uniquement. string (obligatoire)
stratégies Stratégies d’opération string
request Entité qui contient les détails de la demande. RequestContract
responses Tableau de réponses d’opération. ResponseContract[]
templateParameters Collection de paramètres de modèle d’URL. ParameterContract[]
urlTemplate Modèle d’URL relative identifiant la ressource cible de cette opération. Peut comporter des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date} string (obligatoire)

RequestContract

Nom Description Valeur
description Description de la demande d’opération. string
headers Collection d'en-têtes de la demande d'opération. ParameterContract[]
queryParameters Collection de paramètres de requête de la demande d'opération ParameterContract[]
representations Collection de représentations de demande d’opération. RepresentationContract[]

ParameterContract

Nom Description Valeur
defaultValue Valeur par défaut du paramètre. string
description Description du paramètre. string
exemples Exemple défini pour le paramètre . ParameterExamplesContract
name Nom du paramètre. string (obligatoire)
obligatoire Indique si le paramètre est obligatoire ou non. bool
schemaId Identificateur de schéma. string
type Type de paramètre. string (obligatoire)
typeName Nom de type défini par le schéma. string
values Valeurs du paramètre. string[]

ParameterExamplesContract

Nom Description Valeur
{propriété personnalisée} ParameterExampleContract
{propriété personnalisée} ParameterExampleContract

ParameterExampleContract

Nom Description Valeur
description Description longue de l’exemple string
externalValue URL qui pointe vers l’exemple littéral string
Récapitulatif Brève description de l’exemple string
value Exemple de valeur. Il peut s’agir d’une valeur primitive ou d’un objet .

RepresentationContract

Nom Description Valeur
contentType Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml. string (obligatoire)
exemples Exemple défini pour la représentation. ParameterExamplesContract
formParameters Collection de paramètres de formulaire. Obligatoire si la valeur « contentType » est « application/x-www-form-urlencoded » ou « multipart/form-data ». ParameterContract[]
schemaId Identificateur de schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ». string
typeName Nom de type défini par le schéma. Applicable uniquement si la valeur « contentType » n’est ni « application/x-www-form-urlencoded » ni « multipart/form-data ». string

ResponseContract

Nom Description Valeur
description Description de la réponse de l’opération. string
headers Collection d’en-têtes de réponse d’opération. ParameterContract[]
representations Collection de représentations de la réponse de l’opération. RepresentationContract[]
statusCode Code http status de réponse de l’opération. int (obligatoire)