Service Microsoft.ApiManagement/apis/operations 2016-07-07

• dernière
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Définition de ressource Bicep

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

• groupes de ressources - Consultez commandes de déploiement de 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 bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2016-07-07' = {
  parent: resourceSymbolicName
  description: 'string'
  method: 'string'
  name: 'string'
  request: {
    description: 'string'
    headers: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    queryParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    representations: [
      {
        contentType: 'string'
        sample: 'string'
      }
    ]
  }
  responses: [
    {
      description: 'string'
      representations: [
        {
          contentType: 'string'
          sample: 'string'
        }
      ]
      statusCode: int
    }
  ]
  templateParameters: [
    {
      defaultValue: 'string'
      description: 'string'
      name: 'string'
      required: bool
      type: 'string'
      values: [
        'string'
      ]
    }
  ]
  urlTemplate: 'string'
}

Valeurs de propriété

Microsoft.ApiManagement/service/apis/operations

Nom	Description	Valeur
description	Description de l’opération. Peut inclure des balises de mise en forme HTML.	corde Contraintes: Longueur maximale =
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)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (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
demander	Entité contenant les détails de la demande.	RequestContract
Réponses	Tableau de réponses d’opération.	ResultContract[]
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
nom	Nom du paramètre.	chaîne (obligatoire)
Obligatoire	indique si le paramètre est obligatoire ou non.	Bool
type	Type de paramètre.	chaîne (obligatoire)
Valeurs	Valeurs des paramètres.	string[]

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)
échantillon	Exemple de représentation.	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[]

ResultContract

Nom	Description	Valeur
description	Description de la réponse de l’opération.	corde
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 Contraintes: Valeur minimale = 100 Valeur maximale = 599 (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 :

• groupes de ressources - Consultez commandes de déploiement de 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 code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2016-07-07",
  "name": "string",
  "description": "string",
  "method": "string",
  "request": {
    "description": "string",
    "headers": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "queryParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "representations": [
      {
        "contentType": "string",
        "sample": "string"
      }
    ]
  },
  "responses": [
    {
      "description": "string",
      "representations": [
        {
          "contentType": "string",
          "sample": "string"
        }
      ],
      "statusCode": "int"
    }
  ],
  "templateParameters": [
    {
      "defaultValue": "string",
      "description": "string",
      "name": "string",
      "required": "bool",
      "type": "string",
      "values": [ "string" ]
    }
  ],
  "urlTemplate": "string"
}

Valeurs de propriété

Microsoft.ApiManagement/service/apis/operations

Nom	Description	Valeur
apiVersion	Version de l’API	'2016-07-07'
description	Description de l’opération. Peut inclure des balises de mise en forme HTML.	corde Contraintes: Longueur maximale =
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)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire)
demander	Entité contenant les détails de la demande.	RequestContract
Réponses	Tableau de réponses d’opération.	ResultContract[]
templateParameters	Collection de paramètres de modèle d’URL.	ParameterContract[]
type	Type de ressource	'Microsoft.ApiManagement/service/apis/operations'
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
nom	Nom du paramètre.	chaîne (obligatoire)
Obligatoire	indique si le paramètre est obligatoire ou non.	Bool
type	Type de paramètre.	chaîne (obligatoire)
Valeurs	Valeurs des paramètres.	string[]

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)
échantillon	Exemple de représentation.	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[]

ResultContract

Nom	Description	Valeur
description	Description de la réponse de l’opération.	corde
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 Contraintes: Valeur minimale = 100 Valeur maximale = 599 (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@2016-07-07"
  name = "string"
  description = "string"
  method = "string"
  request = {
    description = "string"
    headers = [
      {
        defaultValue = "string"
        description = "string"
        name = "string"
        required = bool
        type = "string"
        values = [
          "string"
        ]
      }
    ]
    queryParameters = [
      {
        defaultValue = "string"
        description = "string"
        name = "string"
        required = bool
        type = "string"
        values = [
          "string"
        ]
      }
    ]
    representations = [
      {
        contentType = "string"
        sample = "string"
      }
    ]
  }
  responses = [
    {
      description = "string"
      representations = [
        {
          contentType = "string"
          sample = "string"
        }
      ]
      statusCode = int
    }
  ]
  templateParameters = [
    {
      defaultValue = "string"
      description = "string"
      name = "string"
      required = bool
      type = "string"
      values = [
        "string"
      ]
    }
  ]
  urlTemplate = "string"
}

Valeurs de propriété

Microsoft.ApiManagement/service/apis/operations

Nom	Description	Valeur
description	Description de l’opération. Peut inclure des balises de mise en forme HTML.	corde Contraintes: Longueur maximale =
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)
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire)
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : service/apis
demander	Entité contenant les détails de la demande.	RequestContract
Réponses	Tableau de réponses d’opération.	ResultContract[]
templateParameters	Collection de paramètres de modèle d’URL.	ParameterContract[]
type	Type de ressource	« Microsoft.ApiManagement/service/apis/operations@2016-07-07 »
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
nom	Nom du paramètre.	chaîne (obligatoire)
Obligatoire	indique si le paramètre est obligatoire ou non.	Bool
type	Type de paramètre.	chaîne (obligatoire)
Valeurs	Valeurs des paramètres.	string[]

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)
échantillon	Exemple de représentation.	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[]

ResultContract

Nom	Description	Valeur
description	Description de la réponse de l’opération.	corde
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 Contraintes: Valeur minimale = 100 Valeur maximale = 599 (obligatoire)