次の方法で共有

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

  • [アーティクル]

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 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。 string (必須)
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 1
パターン = ^[^*#&+:<>?]+$ (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: service/apis
依頼 要求の詳細を含むエンティティ。 RequestContract
応答 操作応答の配列。 ResultContract[]
templateParameters URL テンプレート パラメーターのコレクション。 ParameterContract[]
urlTemplate この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date} 糸

制約：
最小長 = 1
最大長 = 1 (必須)

ParameterContract

名前 形容 価値
defaultValue 既定のパラメーター値。 糸
形容 パラメーターの説明。 糸
名前 パラメーター名。 string (必須)
必須 パラメーターが必要かどうか。 bool
種類 パラメーターの型。 string (必須)
価値観 パラメーター値。 string[]

RepresentationContract

名前 形容 価値
contentType この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。 string (必須)
見本 表現の例。 糸

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 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。 string (必須)
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 1
パターン = ^[^*#&+:<>?]+$ (必須)
依頼 要求の詳細を含むエンティティ。 RequestContract
応答 操作応答の配列。 ResultContract[]
templateParameters URL テンプレート パラメーターのコレクション。 ParameterContract[]
種類 リソースの種類 'Microsoft.ApiManagement/service/apis/operations'
urlTemplate この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date} 糸

制約：
最小長 = 1
最大長 = 1 (必須)

ParameterContract

名前 形容 価値
defaultValue 既定のパラメーター値。 糸
形容 パラメーターの説明。 糸
名前 パラメーター名。 string (必須)
必須 パラメーターが必要かどうか。 bool
種類 パラメーターの型。 string (必須)
価値観 パラメーター値。 string[]

RepresentationContract

名前 形容 価値
contentType この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。 string (必須)
見本 表現の例。 糸

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 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。 string (必須)
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 1
パターン = ^[^*#&+:<>?]+$ (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: service/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 既定のパラメーター値。 糸
形容 パラメーターの説明。 糸
名前 パラメーター名。 string (必須)
必須 パラメーターが必要かどうか。 bool
種類 パラメーターの型。 string (必須)
価値観 パラメーター値。 string[]

RepresentationContract

名前 形容 価値
contentType この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。 string (必須)
見本 表現の例。 糸

RequestContract

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

ResultContract

名前 形容 価値
形容 操作応答の説明。 糸
表現 操作応答表現のコレクション。 RepresentationContract[]
statusCode 操作応答 HTTP 状態コード。 int

制約：
最小値 = 100
最大値 = 599 (必須)