Api Operation - List By Api

サービス:: API Management

API バージョン:: 2024-05-01

指定した API の操作のコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?api-version=2024-05-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?$filter={$filter}&$top={$top}&$skip={$skip}&tags={tags}&api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API リビジョン識別子。現在の API Management サービスインスタンスで一意である必要があります。現在のリビジョン以外のリビジョンには、rev=n はサフィックスであり、n はリビジョン番号です。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$filter	query		string	\|フィールド \|使用法 \|サポートされる演算子 \|サポートされている関数 \| \|-------------\|-------------\|-------------\|-------------\| \|name \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|displayName \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|method \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|description \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|urlTemplate \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \|
$skip	query		integer (int32) minimum: 0	スキップするレコードの数。
$top	query		integer (int32) minimum: 1	返されるレコードの数。
tags	query		string	応答にタグを含めます。

応答

名前	型	説明
200 OK	OperationCollection	API レベルでの操作の概要エンティティのコレクション。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementListApiOperations

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "displayName": "CancelOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cda",
      "properties": {
        "displayName": "GetMostRecentOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd9",
      "properties": {
        "displayName": "GetOpenOrders",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdb",
      "properties": {
        "displayName": "GetOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd8",
      "properties": {
        "displayName": "submitOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder"
      }
    }
  ],
  "count": 5,
  "nextLink": ""
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
OperationCollection	ページング操作リストの表現。
OperationContract	API 操作の詳細。
ParameterContract	操作パラメーターの詳細。
ParameterExampleContract	パラメーターの例。
RepresentationContract	操作要求/応答表現の詳細。
RequestContract	操作要求の詳細。
ResponseContract	操作の応答の詳細。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

OperationCollection

Object

ページング操作リストの表現。

名前	型	説明
count	integer (int64)	すべてのページの合計レコード数。
nextLink	string	次のページリンク (ある場合)。
value	OperationContract[]	ページ値。

OperationContract

Object

API 操作の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.description	string maxLength: 1000	操作の説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string minLength: 1 maxLength: 300	操作名。
properties.method	string	有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。
properties.policies	string	操作ポリシー
properties.request	RequestContract	要求の詳細を含むエンティティ。
properties.responses	ResponseContract[]	操作応答の配列。
properties.templateParameters	ParameterContract[]	URL テンプレートパラメーターのコレクション。
properties.urlTemplate	string minLength: 1 maxLength: 1000	この操作のターゲットリソースを識別する相対 URL テンプレート。パラメーターを含めることができます。例: /customers/{cid}/orders/{oid}/?date={date}
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ParameterContract

Object

操作パラメーターの詳細。

名前	型	説明
defaultValue	string	既定のパラメーター値。
description	string	パラメーターの説明。
examples	<string, ParameterExampleContract>	パラメーターに対して定義された例。
name	string	パラメーター名。
required	boolean	パラメーターが必要かどうかを指定します。
schemaId	string	スキーマ識別子。
type	string	パラメーターの型。
typeName	string	スキーマによって定義される型名。
values	string[]	パラメーター値。

ParameterExampleContract

Object

パラメーターの例。

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

RepresentationContract

Object

操作要求/応答表現の詳細。

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

RequestContract

Object

操作要求の詳細。

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

ResponseContract

Object

操作の応答の詳細。

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