Microsoft.ApiManagement service/apis/operations
Definición de recursos de Bicep
El tipo de recurso service/apis/operations se puede implementar con operaciones destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/apis/operations, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
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()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
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()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
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()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
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()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
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()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
formParameters: [
{
defaultValue: 'string'
description: 'string'
examples: {
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
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()
}
{customized property}: {
description: 'string'
externalValue: 'string'
summary: 'string'
value: any()
}
}
name: 'string'
required: bool
schemaId: 'string'
type: 'string'
typeName: 'string'
values: [
'string'
]
}
]
urlTemplate: 'string'
}
}
Valores de propiedad
service/apis/operations
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| primario | 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 más información, consulte Recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: APIs |
| properties | Propiedades del contrato de operación. | OperationContractProperties |
OperationContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la operación. Puede incluir etiquetas de formato HTML. | string |
| DisplayName | Nombre de la operación. | string (obligatorio) |
| method | 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) |
| directivas | Directivas de operación | string |
| request | Una entidad que contiene los detalles de la solicitud. | RequestContract |
| responses | 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 identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date} | string (obligatorio) |
RequestContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la solicitud de operación. | string |
| headers | Colección de encabezados de la solicitud de operación. | ParameterContract[] |
| queryParameters | Colección de parámetros de consulta de la solicitud de operación. | ParameterContract[] |
| representations | Colección de representaciones de solicitud de operación. | RepresentaciónContract[] |
ParameterContract
| Nombre | Descripción | Valor |
|---|---|---|
| defaultValue | Valor de parámetro predeterminado. | string |
| description | Descripción del parámetro. | string |
| ejemplos | Se ha definido un ejemplo para el parámetro . | ParameterExamplesContract |
| name | Nombre del parámetro. | string (obligatorio) |
| requerido | Especifica si el parámetro es necesario o no. | bool |
| schemaId | Identificador de esquema. | string |
| type | Tipo de parámetro. | string (obligatorio) |
| typeName | Nombre de tipo definido por el esquema. | string |
| valores | Valores del parámetro. | string[] |
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterExampleContract | |
| {propiedad personalizada} | ParameterExampleContract |
ParameterExampleContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción larga del ejemplo | string |
| externalValue | Dirección URL que apunta al ejemplo literal | string |
| Resumen | Descripción breve del ejemplo | string |
| value | Valor de ejemplo. Puede ser un valor primitivo o un objeto . | Para Bicep, puede usar la función any(). |
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 | Ejemplo definido para la representación. | ParameterExamplesContract |
| formParameters | Colección de parámetros de formulario. Obligatorio 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". | string |
| 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". | string |
ResponseContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la respuesta de la operación. | string |
| headers | Colección de encabezados de respuesta de operación. | ParameterContract[] |
| representations | 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 destinadas a:
- Grupos de recursos: consulte los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/apis/operations, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.ApiManagement/service/apis/operations",
"apiVersion": "2023-05-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": {}
},
"{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": {}
},
"{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": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{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": {}
},
"{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": {}
},
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
}
},
"formParameters": [
{
"defaultValue": "string",
"description": "string",
"examples": {
"{customized property}": {
"description": "string",
"externalValue": "string",
"summary": "string",
"value": {}
},
"{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": {}
},
"{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
service/apis/operations
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/apis/operations" |
| apiVersion | La versión de la API de recursos | "2023-05-01-preview" |
| name | El nombre del recurso Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json. |
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| properties | Propiedades del contrato de operación. | OperationContractProperties |
OperationContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la operación. Puede incluir etiquetas de formato HTML. | string |
| DisplayName | Nombre de la operación. | string (obligatorio) |
| method | Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitado solo por ellos. | string (obligatorio) |
| directivas | Directivas de operación | string |
| request | Una entidad que contiene los detalles de la solicitud. | RequestContract |
| responses | 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 identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date} | string (obligatorio) |
RequestContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la solicitud de operación. | string |
| headers | Colección de encabezados de la solicitud de operación. | ParameterContract[] |
| queryParameters | Colección de parámetros de consulta de la solicitud de operación. | ParameterContract[] |
| representations | Colección de representaciones de solicitud de operación. | RepresentationContract[] |
ParameterContract
| Nombre | Descripción | Valor |
|---|---|---|
| defaultValue | Valor de parámetro predeterminado. | string |
| description | Descripción del parámetro. | string |
| ejemplos | Se ha definido un ejemplo para el parámetro . | ParameterExamplesContract |
| name | Nombre del parámetro. | string (obligatorio) |
| requerido | Especifica si el parámetro es necesario o no. | bool |
| schemaId | Identificador de esquema. | string |
| type | Tipo de parámetro. | string (obligatorio) |
| typeName | Nombre de tipo definido por el esquema. | string |
| valores | Valores del parámetro. | string[] |
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterExampleContract | |
| {propiedad personalizada} | ParameterExampleContract |
ParameterExampleContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción larga del ejemplo | string |
| externalValue | Dirección URL que apunta al ejemplo literal | string |
| Resumen | Descripción breve del ejemplo | string |
| value | Valor de ejemplo. Puede ser un valor primitivo o un objeto . |
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 | Ejemplo definido para la representación. | ParameterExamplesContract |
| formParameters | Colección de parámetros de formulario. Obligatorio 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". | string |
| 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". | string |
ResponseContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la respuesta de la operación. | string |
| headers | Colección de encabezados de respuesta de operación. | ParameterContract[] |
| representations | 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 destinadas a:
- Grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de los recursos
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@2023-05-01-preview"
name = "string"
parent_id = "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"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
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"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
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"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
representations = [
{
contentType = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
formParameters = [
{
defaultValue = "string"
description = "string"
examples = {
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
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"
}
{customized property} = {
description = "string"
externalValue = "string"
summary = "string"
}
}
name = "string"
required = bool
schemaId = "string"
type = "string"
typeName = "string"
values = [
"string"
]
}
]
urlTemplate = "string"
}
})
}
Valores de propiedad
service/apis/operations
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview" |
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: APIs |
| properties | Propiedades del contrato de operación. | OperationContractProperties |
OperationContractProperties
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la operación. Puede incluir etiquetas de formato HTML. | string |
| DisplayName | Nombre de la operación. | string (obligatorio) |
| method | 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) |
| directivas | Directivas de operación | string |
| request | Una entidad que contiene los detalles de la solicitud. | RequestContract |
| responses | 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 identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date} | string (obligatorio) |
RequestContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la solicitud de operación. | string |
| headers | Colección de encabezados de la solicitud de operación. | ParameterContract[] |
| queryParameters | Colección de parámetros de consulta de la solicitud de operación. | ParameterContract[] |
| representations | Colección de representaciones de solicitud de operación. | RepresentaciónContract[] |
ParameterContract
| Nombre | Descripción | Valor |
|---|---|---|
| defaultValue | Valor de parámetro predeterminado. | string |
| description | Descripción del parámetro. | string |
| ejemplos | Se ha definido un ejemplo para el parámetro . | ParameterExamplesContract |
| name | Nombre del parámetro. | string (obligatorio) |
| requerido | Especifica si el parámetro es necesario o no. | bool |
| schemaId | Identificador de esquema. | string |
| type | Tipo de parámetro. | string (obligatorio) |
| typeName | Nombre de tipo definido por el esquema. | string |
| valores | Valores del parámetro. | string[] |
ParameterExamplesContract
| Nombre | Descripción | Valor |
|---|---|---|
| {propiedad personalizada} | ParameterExampleContract | |
| {propiedad personalizada} | ParameterExampleContract |
ParameterExampleContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción larga del ejemplo | string |
| externalValue | Dirección URL que apunta al ejemplo literal | string |
| Resumen | Descripción breve del ejemplo | string |
| value | Valor de ejemplo. Puede ser un valor primitivo o un objeto . |
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 | Ejemplo definido para la representación. | ParameterExamplesContract |
| formParameters | Colección de parámetros de formulario. Obligatorio 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". | string |
| 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". | string |
ResponseContract
| Nombre | Descripción | Valor |
|---|---|---|
| description | Descripción de la respuesta de la operación. | string |
| headers | Colección de encabezados de respuesta de la operación. | ParameterContract[] |
| representations | Colección de representaciones de respuesta de operación. | RepresentationContract[] |
| statusCode | Código de estado HTTP de respuesta de la operación. | int (obligatorio) |
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de