Microsoft.ApiManagement service/apis/operations 2016-07-07
- más reciente
- 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
Definición de recursos de Bicep
El tipo de recurso service/apis/operations se puede implementar con operaciones que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
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@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'
}
Valores de propiedad
Microsoft.ApiManagement/service/apis/operations
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción de la operación. Puede incluir etiquetas de formato HTML. | cuerda Restricciones: Longitud máxima = |
| 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) |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[^*#&+:<>?]+$ (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 |
| pedir | Entidad que contiene los detalles de la solicitud. | requestContract |
| Respuestas | Matriz de respuestas de operación. | ResultContract[] |
| 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 | si el parámetro es obligatorio 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) |
| muestra | Ejemplo de la representación. | 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[] |
ResultContract
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción de la respuesta de la operación. | cuerda |
| 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 Restricciones: Valor mínimo = 100 Valor máximo = 599 (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:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
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": "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"
}
Valores de propiedad
Microsoft.ApiManagement/service/apis/operations
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2016-07-07' |
| descripción | Descripción de la operación. Puede incluir etiquetas de formato HTML. | cuerda Restricciones: Longitud máxima = |
| 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) |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[^*#&+:<>?]+$ (obligatorio) |
| pedir | Entidad que contiene los detalles de la solicitud. | requestContract |
| Respuestas | Matriz de respuestas de operación. | ResultContract[] |
| templateParameters | Colección de parámetros de plantilla de dirección URL. | ParameterContract[] |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/apis/operations" |
| 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 | si el parámetro es obligatorio 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) |
| muestra | Ejemplo de la representación. | 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[] |
ResultContract
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción de la respuesta de la operación. | cuerda |
| 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 Restricciones: Valor mínimo = 100 Valor máximo = 599 (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@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"
}
Valores de propiedad
Microsoft.ApiManagement/service/apis/operations
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción de la operación. Puede incluir etiquetas de formato HTML. | cuerda Restricciones: Longitud máxima = |
| 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) |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[^*#&+:<>?]+$ (obligatorio) |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: |
| pedir | Entidad que contiene los detalles de la solicitud. | requestContract |
| Respuestas | Matriz de respuestas de operación. | ResultContract[] |
| templateParameters | Colección de parámetros de plantilla de dirección URL. | ParameterContract[] |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/apis/operations@2016-07-07" |
| 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 | si el parámetro es obligatorio 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) |
| muestra | Ejemplo de la representación. | 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[] |
ResultContract
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción de la respuesta de la operación. | cuerda |
| 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 Restricciones: Valor mínimo = 100 Valor máximo = 599 (obligatorio) |