Microsoft.ApiManagement service/apis/operations 2022-08-01
- 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@2022-08-01' = {
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'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
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'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
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'
}
}
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 |
| Ejemplos | Se ha definido un ejemplo para el parámetro . | ParameterExamplesContract |
| nombre | Nombre del parámetro. | string (obligatorio) |
| Obligatorio | Especifica si el parámetro es necesario o no. | Bool |
| schemaId | Identificador de esquema. | cuerda |
| tipo | Tipo de parámetro. | string (obligatorio) |
| typeName | Nombre de tipo definido por el esquema. | cuerda |
| valores | Valores de parámetro. | string[] |
ParameterExampleContract
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción larga del ejemplo | cuerda |
| externalValue | Dirección URL que apunta al ejemplo literal | cuerda |
| resumen | Descripción breve del ejemplo | cuerda |
| valor | Valor de ejemplo. Puede ser un valor primitivo o un objeto . | cualquier |
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|
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) |
| Ejemplos | Se ha definido un ejemplo para la representación. | ParameterExamplesContract |
| 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[] |
| 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:
- 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": "2022-08-01",
"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",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"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",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"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"
}
}
Valores de propiedad
Microsoft.ApiManagement/service/apis/operations
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2022-08-01' |
| 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 |
| Ejemplos | Se ha definido un ejemplo para el parámetro . | ParameterExamplesContract |
| nombre | Nombre del parámetro. | string (obligatorio) |
| Obligatorio | Especifica si el parámetro es necesario o no. | Bool |
| schemaId | Identificador de esquema. | cuerda |
| tipo | Tipo de parámetro. | string (obligatorio) |
| typeName | Nombre de tipo definido por el esquema. | cuerda |
| valores | Valores de parámetro. | string[] |
ParameterExampleContract
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción larga del ejemplo | cuerda |
| externalValue | Dirección URL que apunta al ejemplo literal | cuerda |
| resumen | Descripción breve del ejemplo | cuerda |
| valor | Valor de ejemplo. Puede ser un valor primitivo o un objeto . | cualquier |
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|
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) |
| Ejemplos | Se ha definido un ejemplo para la representación. | ParameterExamplesContract |
| 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[] |
| 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@2022-08-01"
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"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
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"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
value = ?
}
}
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"
}
})
}
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: |
| Propiedades | Propiedades del contrato de operación. | OperationContractProperties |
| tipo | El tipo de recurso | "Microsoft.ApiManagement/service/apis/operations@2022-08-01" |
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 |
| Ejemplos | Se ha definido un ejemplo para el parámetro . | ParameterExamplesContract |
| nombre | Nombre del parámetro. | string (obligatorio) |
| Obligatorio | Especifica si el parámetro es necesario o no. | Bool |
| schemaId | Identificador de esquema. | cuerda |
| tipo | Tipo de parámetro. | string (obligatorio) |
| typeName | Nombre de tipo definido por el esquema. | cuerda |
| valores | Valores de parámetro. | string[] |
ParameterExampleContract
| Nombre | Descripción | Valor |
|---|---|---|
| descripción | Descripción larga del ejemplo | cuerda |
| externalValue | Dirección URL que apunta al ejemplo literal | cuerda |
| resumen | Descripción breve del ejemplo | cuerda |
| valor | Valor de ejemplo. Puede ser un valor primitivo o un objeto . | cualquier |
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|
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) |
| Ejemplos | Se ha definido un ejemplo para la representación. | ParameterExamplesContract |
| 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[] |
| 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) |