Microsoft.ApiManagement サービス/apis/operations

  • [アーティクル]

Bicep リソース定義

service/apis/operations リソースの種類は、次を対象とする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/apis/operations リソースを作成するには、次の Bicep をテンプレートに追加します。

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

プロパティ値

service/apis/operations

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 型のリソースのシンボル名: apis
properties 操作コントラクトのプロパティ。 OperationContractProperties

OperationContractProperties

名前 説明 値
description 操作の説明。 HTML 書式設定タグを含めることができます。 string
displayName 操作名。 string (必須)
method 有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。 string (必須)
policies 操作ポリシー string
request 要求の詳細を含むエンティティ。 RequestContract
responses 操作応答の配列。 ResponseContract[]
templateParameters URL テンプレート パラメーターのコレクション。 ParameterContract[]
urlTemplate この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date} string (必須)

RequestContract

名前 説明 値
description 操作要求の説明。 string
headers 操作要求のヘッダーのコレクション。 ParameterContract[]
queryParameters 操作要求クエリ パラメーターのコレクション。 ParameterContract[]
representations 操作要求表現のコレクション。 RepresentationContract[]

ParameterContract

名前 説明 値
defaultValue パラメーターの既定値。 string
description パラメーターの説明。 string
使用例 パラメーターに対して定義された例。 ParameterExamplesContract
name パラメーター名です。 string (必須)
必須 パラメーターが必要かどうかを指定します。 [bool]
schemaId スキーマ識別子。 string
type パラメーターの型。 string (必須)
typeName スキーマで定義された型名。 string
値 パラメーター値。 string[]

ParameterExamplesContract

名前 説明 値
{カスタマイズされたプロパティ} ParameterExampleContract
{カスタマイズされたプロパティ} ParameterExampleContract

ParameterExampleContract

名前 説明 値
description 例の長い説明 string
externalValue リテラルの例を指す URL string
まとめ 例の簡単な説明 string
value 値の例。 プリミティブ値またはオブジェクトを指定できます。 Bicep の場合は、 any() 関数を使用できます。

RepresentationContract

名前 説明 値
contentType この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。 string (必須)
使用例 表現に対して定義された例。 ParameterExamplesContract
formParameters フォーム パラメーターのコレクション。 'contentType' 値が 'application/x-www-form-urlencoded' または 'multipart/form-data' の場合は必須です。 ParameterContract[]
schemaId スキーマ識別子。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。 string
typeName スキーマで定義された型名。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。 string

ResponseContract

名前 説明 値
description 操作応答の説明。 string
headers 操作応答ヘッダーのコレクション。 ParameterContract[]
representations 操作応答表現のコレクション。 RepresentationContract[]
StatusCode 操作応答 HTTP 状態コード。 int (必須)

ARM テンプレート リソース定義

service/apis/operations リソースの種類は、次をターゲットとする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/apis/operations リソースを作成するには、次の JSON をテンプレートに追加します。

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

プロパティ値

service/apis/operations

名前 説明 値
type リソースの種類 'Microsoft.ApiManagement/service/apis/operations'
apiVersion リソース API のバージョン '2023-05-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
properties 操作コントラクトのプロパティ。 OperationContractProperties

OperationContractProperties

名前 説明 値
description 操作の説明。 HTML 書式設定タグを含めることができます。 string
displayName 操作名。 string (必須)
method 有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。 string (必須)
policies 操作ポリシー string
request 要求の詳細を含むエンティティ。 RequestContract
responses 操作応答の配列。 ResponseContract[]
templateParameters URL テンプレート パラメーターのコレクション。 ParameterContract[]
urlTemplate この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date} string (必須)

RequestContract

名前 説明 値
description 操作要求の説明。 string
headers 操作要求のヘッダーのコレクション。 ParameterContract[]
queryParameters 操作要求クエリ パラメーターのコレクション。 ParameterContract[]
representations 操作要求表現のコレクション。 RepresentationContract[]

ParameterContract

名前 説明 値
defaultValue パラメーターの既定値。 string
description パラメーターの説明。 string
使用例 パラメーターに対して定義された例。 ParameterExamplesContract
name パラメーター名です。 string (必須)
必須 パラメーターが必要かどうかを指定します。 [bool]
schemaId スキーマ識別子。 string
type パラメーターの型。 string (必須)
typeName スキーマによって定義された型名。 string
値 パラメーター値。 string[]

ParameterExamplesContract

名前 説明 値
{カスタマイズされたプロパティ} ParameterExampleContract
{カスタマイズされたプロパティ} ParameterExampleContract

ParameterExampleContract

名前 説明 値
description 例の長い説明 string
externalValue リテラルの例を指す URL string
まとめ 例の簡単な説明 string
value 値の例。 プリミティブ値またはオブジェクトを指定できます。

RepresentationContract

名前 説明 値
contentType この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。 string (必須)
使用例 表現に対して定義された例。 ParameterExamplesContract
formParameters フォーム パラメーターのコレクション。 'contentType' 値が 'application/x-www-form-urlencoded' または 'multipart/form-data' の場合は必須です。 ParameterContract[]
schemaId スキーマ識別子。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。 string
typeName スキーマで定義された型名。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。 string

ResponseContract

名前 説明 値
description 操作応答の説明。 string
headers 操作応答ヘッダーのコレクション。 ParameterContract[]
representations 操作応答表現のコレクション。 RepresentationContract[]
StatusCode 操作応答 HTTP 状態コード。 int (必須)

Terraform (AzAPI プロバイダー) リソース定義

service/apis/operations リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/apis/operations リソースを作成するには、次の Terraform をテンプレートに追加します。

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

プロパティ値

service/apis/operations

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview"
name リソース名 string (必須)

文字制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: apis
properties 操作コントラクトのプロパティ。 OperationContractProperties

OperationContractProperties

名前 説明 値
description 操作の説明。 HTML 書式設定タグを含めることができます。 string
displayName 操作名。 string (必須)
method 有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、それらに限定されません。 string (必須)
policies 操作ポリシー string
request 要求の詳細を含むエンティティ。 RequestContract
responses 操作応答の配列。 ResponseContract[]
templateParameters URL テンプレート パラメーターのコレクション。 ParameterContract[]
urlTemplate この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date} string (必須)

RequestContract

名前 説明 値
description 操作要求の説明。 string
headers 操作要求のヘッダーのコレクション。 ParameterContract[]
queryParameters 操作要求クエリ パラメーターのコレクション。 ParameterContract[]
representations 操作要求表現のコレクション。 RepresentationContract[]

ParameterContract

名前 説明 値
defaultValue パラメーターの既定値。 string
description パラメーターの説明。 string
使用例 パラメーターに対して定義された例。 ParameterExamplesContract
name パラメーター名です。 string (必須)
必須 パラメーターが必要かどうかを指定します。 [bool]
schemaId スキーマ識別子。 string
type パラメーターの型。 string (必須)
typeName スキーマによって定義された型名。 string
値 パラメーター値。 string[]

ParameterExamplesContract

名前 説明 値
{カスタマイズされたプロパティ} ParameterExampleContract
{カスタマイズされたプロパティ} ParameterExampleContract

ParameterExampleContract

名前 説明 値
description 例の長い説明 string
externalValue リテラルの例を指す URL string
まとめ 例の簡単な説明 string
value 値の例。 プリミティブ値またはオブジェクトを指定できます。

RepresentationContract

名前 説明 値
contentType この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。 string (必須)
使用例 表現に対して定義された例。 ParameterExamplesContract
formParameters フォーム パラメーターのコレクション。 'contentType' 値が 'application/x-www-form-urlencoded' または 'multipart/form-data' の場合は必須です。 ParameterContract[]
schemaId スキーマ識別子。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。 string
typeName スキーマで定義された型名。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。 string

ResponseContract

名前 説明 値
description 操作応答の説明。 string
headers 操作応答ヘッダーのコレクション。 ParameterContract[]
representations 操作応答表現のコレクション。 RepresentationContract[]
StatusCode 操作応答 HTTP 状態コード。 int (必須)