Partager via

Service Microsoft.ApiManagement/apis/operations 2021-01-01-preview

  • Article

Définition de ressource Bicep

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

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

Format de ressource

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2021-01-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'
          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'
            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'
  }
}

Valeurs de propriété

Microsoft.ApiManagement/service/apis/operations

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’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 : service/apis
Propriétés Propriétés du contrat d’opération. OperationContractProperties

OperationContractProperties

Nom Description Valeur
description Description de l’opération. Peut inclure des balises de mise en forme HTML. corde

Contraintes:
Longueur maximale =
displayName Nom de l’opération. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
méthode Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas seulement par eux. chaîne (obligatoire)
manifeste Stratégies d’opération corde
demander Entité contenant les détails de la demande. RequestContract
Réponses 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 pour cette opération. Peut inclure des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date} corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)

ParameterContract

Nom Description Valeur
defaultValue Valeur de paramètre par défaut. corde
description Description du paramètre. corde
Exemples Exemple défini pour le paramètre. ParameterExamplesContract
nom Nom du paramètre. chaîne (obligatoire)
Obligatoire Spécifie si le paramètre est obligatoire ou non. Bool
schemaId Identificateur de schéma. corde
type Type de paramètre. chaîne (obligatoire)
typeName Nom de type défini par le schéma. corde
Valeurs Valeurs des paramètres. string[]

ParameterExampleContract

Nom Description Valeur
description Description longue de l’exemple corde
externalValue URL qui pointe vers l’exemple littéral corde
résumé Brève description de l’exemple corde
valeur Exemple de valeur. Peut être une valeur primitive ou un objet. quelconque

ParameterExamplesContract

Nom Description Valeur

RepresentationContract

Nom Description Valeur
contentType Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml. chaîne (obligatoire)
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 ». corde
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 ». corde

RequestContract

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

ResponseContract

Nom Description Valeur
description Description de la réponse de l’opération. corde
En-têtes Collection d’en-têtes de réponse d’opération. ParameterContract[]
Représentations Collection de représentations de réponse d’opération. RepresentationContract[]
statusCode Code d’état HTTP de réponse aux opérations. int (obligatoire)

Définition de ressource de modèle ARM

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

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

Format de ressource

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

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2021-01-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",
          "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",
            "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"
  }
}

Valeurs de propriété

Microsoft.ApiManagement/service/apis/operations

Nom Description Valeur
apiVersion Version de l’API '2021-01-01-preview'
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
Propriétés Propriétés du contrat d’opération. OperationContractProperties
type Type de ressource 'Microsoft.ApiManagement/service/apis/operations'

OperationContractProperties

Nom Description Valeur
description Description de l’opération. Peut inclure des balises de mise en forme HTML. corde

Contraintes:
Longueur maximale =
displayName Nom de l’opération. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
méthode Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas seulement par eux. chaîne (obligatoire)
manifeste Stratégies d’opération corde
demander Entité contenant les détails de la demande. RequestContract
Réponses 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 pour cette opération. Peut inclure des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date} corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)

ParameterContract

Nom Description Valeur
defaultValue Valeur de paramètre par défaut. corde
description Description du paramètre. corde
Exemples Exemple défini pour le paramètre. ParameterExamplesContract
nom Nom du paramètre. chaîne (obligatoire)
Obligatoire Spécifie si le paramètre est obligatoire ou non. Bool
schemaId Identificateur de schéma. corde
type Type de paramètre. chaîne (obligatoire)
typeName Nom de type défini par le schéma. corde
Valeurs Valeurs des paramètres. string[]

ParameterExampleContract

Nom Description Valeur
description Description longue de l’exemple corde
externalValue URL qui pointe vers l’exemple littéral corde
résumé Brève description de l’exemple corde
valeur Exemple de valeur. Peut être une valeur primitive ou un objet. quelconque

ParameterExamplesContract

Nom Description Valeur

RepresentationContract

Nom Description Valeur
contentType Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml. chaîne (obligatoire)
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 ». corde
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 ». corde

RequestContract

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

ResponseContract

Nom Description Valeur
description Description de la réponse de l’opération. corde
En-têtes Collection d’en-têtes de réponse d’opération. ParameterContract[]
Représentations Collection de représentations de réponse d’opération. RepresentationContract[]
statusCode Code d’état HTTP de réponse aux opérations. int (obligatoire)

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource de service/apis/opérations 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 de l’API, consultez journal des modifications.

Format de ressource

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@2021-01-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"
            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"
              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"
    }
  })
}

Valeurs de propriété

Microsoft.ApiManagement/service/apis/operations

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : service/apis
Propriétés Propriétés du contrat d’opération. OperationContractProperties
type Type de ressource « Microsoft.ApiManagement/service/apis/operations@2021-01-01-preview »

OperationContractProperties

Nom Description Valeur
description Description de l’opération. Peut inclure des balises de mise en forme HTML. corde

Contraintes:
Longueur maximale =
displayName Nom de l’opération. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
méthode Méthode d’opération HTTP valide. Méthodes Http classiques telles que GET, PUT, POST, mais pas seulement par eux. chaîne (obligatoire)
manifeste Stratégies d’opération corde
demander Entité contenant les détails de la demande. RequestContract
Réponses 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 pour cette opération. Peut inclure des paramètres. Exemple : /customers/{cid}/orders/{oid}/ ?date={date} corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)

ParameterContract

Nom Description Valeur
defaultValue Valeur de paramètre par défaut. corde
description Description du paramètre. corde
Exemples Exemple défini pour le paramètre. ParameterExamplesContract
nom Nom du paramètre. chaîne (obligatoire)
Obligatoire Spécifie si le paramètre est obligatoire ou non. Bool
schemaId Identificateur de schéma. corde
type Type de paramètre. chaîne (obligatoire)
typeName Nom de type défini par le schéma. corde
Valeurs Valeurs des paramètres. string[]

ParameterExampleContract

Nom Description Valeur
description Description longue de l’exemple corde
externalValue URL qui pointe vers l’exemple littéral corde
résumé Brève description de l’exemple corde
valeur Exemple de valeur. Peut être une valeur primitive ou un objet. quelconque

ParameterExamplesContract

Nom Description Valeur

RepresentationContract

Nom Description Valeur
contentType Spécifie un type de contenu inscrit ou personnalisé pour cette représentation, par exemple application/xml. chaîne (obligatoire)
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 ». corde
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 ». corde

RequestContract

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

ResponseContract

Nom Description Valeur
description Description de la réponse de l’opération. corde
En-têtes Collection d’en-têtes de réponse d’opération. ParameterContract[]
Représentations Collection de représentations de réponse d’opération. RepresentationContract[]
statusCode Code d’état HTTP de réponse aux opérations. int (obligatoire)