Compartir a través de

Servicio Microsoft.ApiManagement/apis/operations 2019-12-01-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/apis/operations se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apis/operations, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2019-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    method: 'string'
    policies: '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'
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              name: 'string'
              required: bool
              type: 'string'
              values: [
                'string'
              ]
            }
          ]
          sample: 'string'
          schemaId: 'string'
          typeName: 'string'
        }
      ]
    }
    responses: [
      {
        description: 'string'
        headers: [
          {
            defaultValue: 'string'
            description: 'string'
            name: 'string'
            required: bool
            type: 'string'
            values: [
              'string'
            ]
          }
        ]
        representations: [
          {
            contentType: 'string'
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                name: 'string'
                required: bool
                type: 'string'
                values: [
                  'string'
                ]
              }
            ]
            sample: 'string'
            schemaId: 'string'
            typeName: 'string'
          }
        ]
        statusCode: int
      }
    ]
    templateParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Valores de propiedad

Microsoft.ApiManagement/service/apis/operations

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: service/apis
Propiedades Propiedades del contrato de operación. OperationContractProperties

OperationContractProperties

Nombre Descripción Valor
descripción Descripción de la operación. Puede incluir etiquetas de formato HTML. cuerda

Restricciones:
Longitud máxima =
displayName Nombre de la operación. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
método Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitados solo por ellos. string (obligatorio)
políticas Directivas de operación cuerda
pedir Entidad que contiene los detalles de la solicitud. requestContract
Respuestas Matriz de respuestas de operación. ResponseContract[]
templateParameters Colección de parámetros de plantilla de dirección URL. ParameterContract[]
urlTemplate Plantilla de dirección URL relativa que identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date} cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)

ParameterContract

Nombre Descripción Valor
defaultValue Valor de parámetro predeterminado. cuerda
descripción Descripción del parámetro. cuerda
nombre Nombre del parámetro. string (obligatorio)
Obligatorio Especifica si el parámetro es necesario o no. Bool
tipo Tipo de parámetro. string (obligatorio)
valores Valores de parámetro. string[]

RepresentaciónContract

Nombre Descripción Valor
contentType Especifica un tipo de contenido registrado o personalizado para esta representación, por ejemplo, application/xml. string (obligatorio)
formParameters Colección de parámetros de formulario. Se requiere si el valor "contentType" es "application/x-www-form-urlencoded" o "multipart/form-data". ParameterContract[]
muestra Ejemplo de la representación. cuerda
schemaId Identificador de esquema. Solo se aplica si el valor "contentType" no es "application/x-www-form-urlencoded" ni "multipart/form-data". cuerda
typeName Nombre de tipo definido por el esquema. Solo se aplica si el valor "contentType" no es "application/x-www-form-urlencoded" ni "multipart/form-data". cuerda

RequestContract

Nombre Descripción Valor
descripción Descripción de la solicitud de operación. cuerda
Encabezados Colección de encabezados de solicitud de operación. ParameterContract[]
queryParameters Colección de parámetros de consulta de solicitud de operación. ParameterContract[]
Representaciones Colección de representaciones de solicitud de operación. representaciónContract[]

ResponseContract

Nombre Descripción Valor
descripción Descripción de la respuesta de la operación. cuerda
Encabezados Colección de encabezados de respuesta de la operación. ParameterContract[]
Representaciones Colección de representaciones de respuesta de operación. representaciónContract[]
statusCode Código de estado HTTP de respuesta de la operación. int (obligatorio)

Definición de recursos de plantilla de ARM

El tipo de recurso service/apis/operations se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apis/operations, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2019-12-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "method": "string",
    "policies": "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",
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "name": "string",
              "required": "bool",
              "type": "string",
              "values": [ "string" ]
            }
          ],
          "sample": "string",
          "schemaId": "string",
          "typeName": "string"
        }
      ]
    },
    "responses": [
      {
        "description": "string",
        "headers": [
          {
            "defaultValue": "string",
            "description": "string",
            "name": "string",
            "required": "bool",
            "type": "string",
            "values": [ "string" ]
          }
        ],
        "representations": [
          {
            "contentType": "string",
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "name": "string",
                "required": "bool",
                "type": "string",
                "values": [ "string" ]
              }
            ],
            "sample": "string",
            "schemaId": "string",
            "typeName": "string"
          }
        ],
        "statusCode": "int"
      }
    ],
    "templateParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

Valores de propiedad

Microsoft.ApiManagement/service/apis/operations

Nombre Descripción Valor
apiVersion La versión de api '2019-12-01-preview'
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
Propiedades Propiedades del contrato de operación. OperationContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/apis/operations"

OperationContractProperties

Nombre Descripción Valor
descripción Descripción de la operación. Puede incluir etiquetas de formato HTML. cuerda

Restricciones:
Longitud máxima =
displayName Nombre de la operación. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
método Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitados solo por ellos. string (obligatorio)
políticas Directivas de operación cuerda
pedir Entidad que contiene los detalles de la solicitud. requestContract
Respuestas Matriz de respuestas de operación. ResponseContract[]
templateParameters Colección de parámetros de plantilla de dirección URL. ParameterContract[]
urlTemplate Plantilla de dirección URL relativa que identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date} cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)

ParameterContract

Nombre Descripción Valor
defaultValue Valor de parámetro predeterminado. cuerda
descripción Descripción del parámetro. cuerda
nombre Nombre del parámetro. string (obligatorio)
Obligatorio Especifica si el parámetro es necesario o no. Bool
tipo Tipo de parámetro. string (obligatorio)
valores Valores de parámetro. string[]

RepresentaciónContract

Nombre Descripción Valor
contentType Especifica un tipo de contenido registrado o personalizado para esta representación, por ejemplo, application/xml. string (obligatorio)
formParameters Colección de parámetros de formulario. Se requiere si el valor "contentType" es "application/x-www-form-urlencoded" o "multipart/form-data". ParameterContract[]
muestra Ejemplo de la representación. cuerda
schemaId Identificador de esquema. Solo se aplica si el valor "contentType" no es "application/x-www-form-urlencoded" ni "multipart/form-data". cuerda
typeName Nombre de tipo definido por el esquema. Solo se aplica si el valor "contentType" no es "application/x-www-form-urlencoded" ni "multipart/form-data". cuerda

RequestContract

Nombre Descripción Valor
descripción Descripción de la solicitud de operación. cuerda
Encabezados Colección de encabezados de solicitud de operación. ParameterContract[]
queryParameters Colección de parámetros de consulta de solicitud de operación. ParameterContract[]
Representaciones Colección de representaciones de solicitud de operación. representaciónContract[]

ResponseContract

Nombre Descripción Valor
descripción Descripción de la respuesta de la operación. cuerda
Encabezados Colección de encabezados de respuesta de la operación. ParameterContract[]
Representaciones Colección de representaciones de respuesta de operación. representaciónContract[]
statusCode Código de estado HTTP de respuesta de la operación. int (obligatorio)

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/apis/operations se puede implementar con operaciones que tienen como destino:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apis/operations, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2019-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      method = "string"
      policies = "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"
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                name = "string"
                required = bool
                type = "string"
                values = [
                  "string"
                ]
              }
            ]
            sample = "string"
            schemaId = "string"
            typeName = "string"
          }
        ]
      }
      responses = [
        {
          description = "string"
          headers = [
            {
              defaultValue = "string"
              description = "string"
              name = "string"
              required = bool
              type = "string"
              values = [
                "string"
              ]
            }
          ]
          representations = [
            {
              contentType = "string"
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  name = "string"
                  required = bool
                  type = "string"
                  values = [
                    "string"
                  ]
                }
              ]
              sample = "string"
              schemaId = "string"
              typeName = "string"
            }
          ]
          statusCode = int
        }
      ]
      templateParameters = [
        {
          defaultValue = "string"
          description = "string"
          name = "string"
          required = bool
          type = "string"
          values = [
            "string"
          ]
        }
      ]
      urlTemplate = "string"
    }
  })
}

Valores de propiedad

Microsoft.ApiManagement/service/apis/operations

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: service/apis
Propiedades Propiedades del contrato de operación. OperationContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/apis/operations@2019-12-01-preview"

OperationContractProperties

Nombre Descripción Valor
descripción Descripción de la operación. Puede incluir etiquetas de formato HTML. cuerda

Restricciones:
Longitud máxima =
displayName Nombre de la operación. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
método Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitados solo por ellos. string (obligatorio)
políticas Directivas de operación cuerda
pedir Entidad que contiene los detalles de la solicitud. requestContract
Respuestas Matriz de respuestas de operación. ResponseContract[]
templateParameters Colección de parámetros de plantilla de dirección URL. ParameterContract[]
urlTemplate Plantilla de dirección URL relativa que identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date} cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)

ParameterContract

Nombre Descripción Valor
defaultValue Valor de parámetro predeterminado. cuerda
descripción Descripción del parámetro. cuerda
nombre Nombre del parámetro. string (obligatorio)
Obligatorio Especifica si el parámetro es necesario o no. Bool
tipo Tipo de parámetro. string (obligatorio)
valores Valores de parámetro. string[]

RepresentaciónContract

Nombre Descripción Valor
contentType Especifica un tipo de contenido registrado o personalizado para esta representación, por ejemplo, application/xml. string (obligatorio)
formParameters Colección de parámetros de formulario. Se requiere si el valor "contentType" es "application/x-www-form-urlencoded" o "multipart/form-data". ParameterContract[]
muestra Ejemplo de la representación. cuerda
schemaId Identificador de esquema. Solo se aplica si el valor "contentType" no es "application/x-www-form-urlencoded" ni "multipart/form-data". cuerda
typeName Nombre de tipo definido por el esquema. Solo se aplica si el valor "contentType" no es "application/x-www-form-urlencoded" ni "multipart/form-data". cuerda

RequestContract

Nombre Descripción Valor
descripción Descripción de la solicitud de operación. cuerda
Encabezados Colección de encabezados de solicitud de operación. ParameterContract[]
queryParameters Colección de parámetros de consulta de solicitud de operación. ParameterContract[]
Representaciones Colección de representaciones de solicitud de operación. representaciónContract[]

ResponseContract

Nombre Descripción Valor
descripción Descripción de la respuesta de la operación. cuerda
Encabezados Colección de encabezados de respuesta de la operación. ParameterContract[]
Representaciones Colección de representaciones de respuesta de operación. representaciónContract[]
statusCode Código de estado HTTP de respuesta de la operación. int (obligatorio)