Share via

Microsoft.ApiManagement service/apis/operations

  • Artikel

Definisi sumber daya Bicep

Jenis sumber daya layanan/api/operasi dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/apis/operations, tambahkan Bicep berikut ke templat Anda.

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'
  }
}

Nilai properti

layanan/api/operasi

Nama Deskripsi Nilai
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di Bicep.		 string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
induk Di Bicep, Anda dapat menentukan sumber daya induk untuk sumber daya anak. Anda hanya perlu menambahkan properti ini ketika sumber daya anak dideklarasikan di luar sumber daya induk.

Untuk informasi selengkapnya, lihat Sumber daya anak di luar sumber daya induk.		 Nama simbolis untuk sumber daya jenis: api
properti Properti Kontrak Operasi. OperationContractProperties

OperationContractProperties

Nama Deskripsi Nilai
deskripsi Deskripsi operasi. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama Operasi. string (diperlukan)
metode Metode Operasi HTTP yang valid. Metode Http khas seperti GET, PUT, POST tetapi tidak hanya dibatasi oleh mereka. string (diperlukan)
kebijakan Kebijakan Operasi string
permintaan Entitas yang berisi detail permintaan. RequestContract
Responses to Array respons Operasi. ResponseContract[]
templateParameters Kumpulan parameter templat URL. ParameterContract[]
urlTemplate Templat URL relatif mengidentifikasi sumber daya target untuk operasi ini. Dapat mencakup parameter. Contoh: /customers/{cid}/orders/{oid}/?date={date} string (diperlukan)

RequestContract

Nama Deskripsi Nilai
deskripsi Deskripsi permintaan operasi. string
headers Kumpulan header permintaan operasi. ParameterContract[]
queryParameters Kumpulan parameter kueri permintaan operasi. ParameterContract[]
Pernyataan Kumpulan representasi permintaan operasi. RepresentationContract[]

ParameterContract

Nama Deskripsi Nilai
defaultValue Nilai parameter default. string
deskripsi Deskripsi parameter. string
Contoh Contoh yang ditentukan untuk parameter . ParameterExamplesContract
nama Nama parameter. string (diperlukan)
diperlukan Menentukan apakah parameter diperlukan atau tidak. bool
schemaId Pengidentifikasi skema. string
jenis Jenis parameter. string (diperlukan)
typeName Nama jenis yang ditentukan oleh skema. string
values Nilai parameter. string[]

ParameterExamplesContract

Nama Deskripsi Nilai
{customized property} ParameterExampleContract
{customized property} ParameterExampleContract

ParameterExampleContract

Nama Deskripsi Nilai
deskripsi Deskripsi panjang untuk contoh string
externalValue URL yang menunjuk ke contoh harfiah string
ringkasan Deskripsi singkat untuk contoh string
nilai Contoh nilai. Mungkin nilai primitif, atau objek. Untuk Bicep, Anda dapat menggunakan fungsi any().

RepresentationContract

Nama Deskripsi Nilai
contentType Menentukan tipe isi terdaftar atau kustom untuk representasi ini, misalnya aplikasi/xml. string (diperlukan)
Contoh Contoh yang ditentukan untuk representasi. ParameterExamplesContract
formParameters Kumpulan parameter formulir. Diperlukan jika nilai 'contentType' adalah 'application/x-www-form-urlencoded' atau 'multipart/form-data'.. ParameterContract[]
schemaId Pengidentifikasi skema. Hanya berlaku jika nilai 'contentType' bukan 'application/x-www-form-urlencoded' atau 'multipart/form-data'. string
typeName Nama jenis yang ditentukan oleh skema. Hanya berlaku jika nilai 'contentType' bukan 'application/x-www-form-urlencoded' atau 'multipart/form-data'. string

ResponseContract

Nama Deskripsi Nilai
deskripsi Deskripsi respons operasi. string
headers Kumpulan header respons operasi. ParameterContract[]
Pernyataan Kumpulan representasi permintaan operasi. RepresentationContract[]
statusCode Kode status HTTP respons operasi. int (diperlukan)

Definisi sumber daya templat ARM

Jenis sumber daya layanan/api/operasi dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/apis/operations, tambahkan JSON berikut ke templat Anda.

{
  "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"
  }
}

Nilai properti

service/apis/operations

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.ApiManagement/service/apis/operations'
apiVersion Versi api sumber daya '2023-05-01-preview'
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di templat JSON ARM.		 string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
properti Properti Kontrak Operasi. OperationContractProperties

OperationContractProperties

Nama Deskripsi Nilai
deskripsi Deskripsi operasi. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama Operasi. string (diperlukan)
metode Metode Operasi HTTP yang valid. Metode Http khas seperti GET, PUT, POST tetapi tidak hanya dibatasi oleh mereka. string (diperlukan)
kebijakan Kebijakan Operasi string
permintaan Entitas yang berisi detail permintaan. RequestContract
Responses to Array respons Operasi. ResponseContract[]
templateParameters Kumpulan parameter templat URL. ParameterContract[]
urlTemplate Templat URL relatif mengidentifikasi sumber daya target untuk operasi ini. Dapat mencakup parameter. Contoh: /customers/{cid}/orders/{oid}/?date={date} string (diperlukan)

RequestContract

Nama Deskripsi Nilai
deskripsi Deskripsi permintaan operasi. string
headers Kumpulan header permintaan operasi. ParameterContract[]
queryParameters Kumpulan parameter kueri permintaan operasi. ParameterContract[]
Pernyataan Kumpulan representasi permintaan operasi. RepresentationContract[]

ParameterContract

Nama Deskripsi Nilai
defaultValue Nilai parameter default. string
deskripsi Deskripsi parameter. string
Contoh Contoh yang ditentukan untuk parameter . ParameterExamplesContract
nama Nama parameter. string (diperlukan)
diperlukan Menentukan apakah parameter diperlukan atau tidak. bool
schemaId Pengidentifikasi skema. string
jenis Jenis parameter. string (diperlukan)
typeName Nama jenis yang ditentukan oleh skema. string
values Nilai parameter. string[]

ParameterExamplesContract

Nama Deskripsi Nilai
{properti yang disesuaikan} ParameterExampleContract
{properti yang disesuaikan} ParameterExampleContract

ParameterExampleContract

Nama Deskripsi Nilai
deskripsi Deskripsi panjang untuk contoh string
externalValue URL yang menunjuk ke contoh harfiah string
ringkasan Deskripsi singkat untuk contoh string
nilai Contoh nilai. Mungkin nilai primitif, atau objek.

RepresentationContract

Nama Deskripsi Nilai
contentType Menentukan tipe isi terdaftar atau kustom untuk representasi ini, misalnya aplikasi/xml. string (diperlukan)
Contoh Contoh yang ditentukan untuk representasi. ParameterExamplesContract
formParameters Kumpulan parameter formulir. Diperlukan jika nilai 'contentType' adalah 'application/x-www-form-urlencoded' atau 'multipart/form-data'.. ParameterContract[]
schemaId Pengidentifikasi skema. Hanya berlaku jika nilai 'contentType' bukan 'application/x-www-form-urlencoded' atau 'multipart/form-data'. string
typeName Nama jenis yang ditentukan oleh skema. Hanya berlaku jika nilai 'contentType' bukan 'application/x-www-form-urlencoded' atau 'multipart/form-data'. string

ResponseContract

Nama Deskripsi Nilai
deskripsi Deskripsi respons operasi. string
headers Kumpulan header respons operasi. ParameterContract[]
Pernyataan Kumpulan representasi permintaan operasi. RepresentationContract[]
statusCode Kode status HTTP respons operasi. int (diperlukan)

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya layanan/api/operasi dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/apis/operations, tambahkan Terraform berikut ke templat Anda.

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"
    }
  })
}

Nilai properti

service/apis/operations

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview"
nama Nama sumber daya string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
parent_id ID sumber daya yang merupakan induk untuk sumber daya ini. ID untuk sumber daya jenis: api
properti Properti Kontrak Operasi. OperationContractProperties

OperationContractProperties

Nama Deskripsi Nilai
deskripsi Deskripsi operasi. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama Operasi. string (diperlukan)
metode Metode Operasi HTTP yang valid. Metode Http khas seperti GET, PUT, POST tetapi tidak dibatasi hanya oleh mereka. string (diperlukan)
kebijakan Kebijakan Operasi string
permintaan Entitas yang berisi detail permintaan. RequestContract
Responses to Array respons Operasi. ResponseContract[]
templateParameters Kumpulan parameter templat URL. ParameterContract[]
urlTemplate Templat URL relatif mengidentifikasi sumber daya target untuk operasi ini. Dapat mencakup parameter. Contoh: /customers/{cid}/orders/{oid}/?date={date} string (diperlukan)

RequestContract

Nama Deskripsi Nilai
deskripsi Deskripsi permintaan operasi. string
headers Kumpulan header permintaan operasi. ParameterContract[]
queryParameters Kumpulan parameter kueri permintaan operasi. ParameterContract[]
Pernyataan Kumpulan representasi permintaan operasi. RepresentationContract[]

ParameterContract

Nama Deskripsi Nilai
defaultValue Nilai parameter default. string
deskripsi Deskripsi parameter. string
Contoh Contoh yang ditentukan untuk parameter . ParameterExamplesContract
nama Nama parameter. string (diperlukan)
diperlukan Menentukan apakah parameter diperlukan atau tidak. bool
schemaId Pengidentifikasi skema. string
jenis Jenis parameter. string (diperlukan)
typeName Nama jenis yang ditentukan oleh skema. string
values Nilai parameter. string[]

ParameterExamplesContract

Nama Deskripsi Nilai
{customized property} ParameterExampleContract
{customized property} ParameterExampleContract

ParameterExampleContract

Nama Deskripsi Nilai
deskripsi Deskripsi panjang untuk contoh string
externalValue URL yang menunjuk ke contoh harfiah string
ringkasan Deskripsi singkat untuk contoh string
nilai Contoh nilai. Mungkin nilai primitif, atau objek.

RepresentationContract

Nama Deskripsi Nilai
contentType Menentukan tipe isi terdaftar atau kustom untuk representasi ini, misalnya aplikasi/xml. string (diperlukan)
Contoh Contoh yang ditentukan untuk representasi. ParameterExamplesContract
formParameters Kumpulan parameter formulir. Diperlukan jika nilai 'contentType' adalah 'application/x-www-form-urlencoded' atau 'multipart/form-data'.. ParameterContract[]
schemaId Pengidentifikasi skema. Hanya berlaku jika nilai 'contentType' bukan 'application/x-www-form-urlencoded' atau 'multipart/form-data'. string
typeName Nama jenis yang ditentukan oleh skema. Hanya berlaku jika nilai 'contentType' bukan 'application/x-www-form-urlencoded' atau 'multipart/form-data'. string

ResponseContract

Nama Deskripsi Nilai
deskripsi Deskripsi respons operasi. string
headers Kumpulan header respons operasi. ParameterContract[]
Pernyataan Kumpulan representasi permintaan operasi. RepresentationContract[]
statusCode Kode status HTTP respons operasi. int (diperlukan)