Microsoft.ApiManagement service/apis/operations 2016-10-10

• 最新
• 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

Bicep 資源定義

您可以使用目標作業來部署服務/apis/operations 資源類型：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/apis/operations 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2016-10-10' = {
  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'
}

屬性值

Microsoft.ApiManagement/service/apis/operations

名字	描述	價值
描述	作業的描述。 可能包含 HTML 格式標記。	字串 約束： 最大長度 =
方法	有效的 HTTP 作業方法。 一般 Http 方法，例如 GET、PUT、POST，但不受限制。	字串 （必要）
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[^*#&+:<>?]+$ （必要）
父母	在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。	類型的資源符號名稱：service/apis
請求	包含要求詳細數據的實體。	RequestContract
反應	作業回應的陣列。	ResultContract[]
templateParameters	URL 樣本參數的集合。	ParameterContract[]
urlTemplate	識別此作業之目標資源的相對URL範本。 可能包含參數。 範例：/customers/{cid}/orders/{oid}/？date={date}	字串 約束： 最小長度 = 1 最大長度 = 1 （必要）

ParameterContract

名字	描述	價值
defaultValue	預設參數值。	字串
描述	參數描述。	字串
名字	參數名稱。	字串 （必要）
必填	參數是否為必要。	bool
類型	參數類型。	字串 （必要）
值	參數值。	string[]

RepresentationContract

名字	描述	價值
contentType	指定這個表示法的已註冊或自定義內容類型，例如 application/xml。	字串 （必要）
樣本	表示法的範例。	字串

RequestContract

名字	描述	價值
描述	作業要求描述。	字串
頭	作業要求標頭的集合。	ParameterContract[]
queryParameters	作業要求查詢參數的集合。	ParameterContract[]
交涉	作業要求表示法的集合。	RepresentationContract[]

ResultContract

名字	描述	價值
描述	作業回應描述。	字串
交涉	作業回應表示的集合。	RepresentationContract[]
statusCode	作業回應 HTTP 狀態代碼。	int 約束： 最小值 = 100 最大值 = 599 （必要）

ARM 樣本資源定義

您可以使用目標作業來部署服務/apis/operations 資源類型：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/apis/operations 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2016-10-10",
  "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"
}

屬性值

Microsoft.ApiManagement/service/apis/operations

名字	描述	價值
apiVersion	API 版本	'2016-10-10'
描述	作業的描述。 可能包含 HTML 格式標記。	字串 約束： 最大長度 =
方法	有效的 HTTP 作業方法。 一般 Http 方法，例如 GET、PUT、POST，但不受限制。	字串 （必要）
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[^*#&+:<>?]+$ （必要）
請求	包含要求詳細數據的實體。	RequestContract
反應	作業回應的陣列。	ResultContract[]
templateParameters	URL 樣本參數的集合。	ParameterContract[]
類型	資源類型	'Microsoft.ApiManagement/service/apis/operations'
urlTemplate	識別此作業之目標資源的相對URL範本。 可能包含參數。 範例：/customers/{cid}/orders/{oid}/？date={date}	字串 約束： 最小長度 = 1 最大長度 = 1 （必要）

ParameterContract

名字	描述	價值
defaultValue	預設參數值。	字串
描述	參數描述。	字串
名字	參數名稱。	字串 （必要）
必填	參數是否為必要。	bool
類型	參數類型。	字串 （必要）
值	參數值。	string[]

RepresentationContract

名字	描述	價值
contentType	指定這個表示法的已註冊或自定義內容類型，例如 application/xml。	字串 （必要）
樣本	表示法的範例。	字串

RequestContract

名字	描述	價值
描述	作業要求描述。	字串
頭	作業要求標頭的集合。	ParameterContract[]
queryParameters	作業要求查詢參數的集合。	ParameterContract[]
交涉	作業要求表示法的集合。	RepresentationContract[]

ResultContract

名字	描述	價值
描述	作業回應描述。	字串
交涉	作業回應表示的集合。	RepresentationContract[]
statusCode	作業回應 HTTP 狀態代碼。	int 約束： 最小值 = 100 最大值 = 599 （必要）

Terraform （AzAPI 提供者） 資源定義

您可以使用目標作業來部署服務/apis/operations 資源類型：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/apis/operations 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2016-10-10"
  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"
}

屬性值

Microsoft.ApiManagement/service/apis/operations

名字	描述	價值
描述	作業的描述。 可能包含 HTML 格式標記。	字串 約束： 最大長度 =
方法	有效的 HTTP 作業方法。 一般 Http 方法，例如 GET、PUT、POST，但不受限制。	字串 （必要）
名字	資源名稱	字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[^*#&+:<>?]+$ （必要）
parent_id	此資源為父系之資源的標識碼。	類型資源的標識碼：服務/apis
請求	包含要求詳細數據的實體。	RequestContract
反應	作業回應的陣列。	ResultContract[]
templateParameters	URL 樣本參數的集合。	ParameterContract[]
類型	資源類型	“Microsoft.ApiManagement/service/apis/operations@2016-10-10”
urlTemplate	識別此作業之目標資源的相對URL範本。 可能包含參數。 範例：/customers/{cid}/orders/{oid}/？date={date}	字串 約束： 最小長度 = 1 最大長度 = 1 （必要）

ParameterContract

名字	描述	價值
defaultValue	預設參數值。	字串
描述	參數描述。	字串
名字	參數名稱。	字串 （必要）
必填	參數是否為必要。	bool
類型	參數類型。	字串 （必要）
值	參數值。	string[]

RepresentationContract

名字	描述	價值
contentType	指定這個表示法的已註冊或自定義內容類型，例如 application/xml。	字串 （必要）
樣本	表示法的範例。	字串

RequestContract

名字	描述	價值
描述	作業要求描述。	字串
頭	作業要求標頭的集合。	ParameterContract[]
queryParameters	作業要求查詢參數的集合。	ParameterContract[]
交涉	作業要求表示法的集合。	RepresentationContract[]

ResultContract

名字	描述	價值
描述	作業回應描述。	字串
交涉	作業回應表示的集合。	RepresentationContract[]
statusCode	作業回應 HTTP 狀態代碼。	int 約束： 最小值 = 100 最大值 = 599 （必要）