Api Release - List By Service

サービス:

API Management

API バージョン:

2024-05-01

API のすべてのリリースを一覧表示します。 API リビジョンを最新の状態にすると、API リリースが作成されます。 リリースは、以前のリビジョンにロールバックするためにも使用されます。 結果はページングされ、$topおよび$skipパラメーターによって制限できます。

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

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

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

URI パラメーター

名前	/	必須	型	説明
apiId	path	True	string minLength: 1 maxLength: 80	API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。
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	|フィールド |使用法 |サポートされる演算子 |サポートされている関数 | |-------------|-------------|-------------|-------------| |notes |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
$skip	query		integer (int32) minimum: 0	スキップするレコードの数。
$top	query		integer (int32) minimum: 1	返されるレコードの数。

応答

名前	型	説明
200 OK	ApiReleaseCollection	この操作は、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	ユーザー アカウントを偽装する

例

ApiManagementListApiReleases

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/5a7cb545298324c53224a799",
      "type": "Microsoft.ApiManagement/service/apis/releases",
      "name": "5a7cb545298324c53224a799",
      "properties": {
        "createdDateTime": "2018-02-08T20:38:29.173Z",
        "updatedDateTime": "2018-02-08T20:38:29.173Z",
        "notes": "yahoo"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定義

名前	説明
ApiReleaseCollection	Paged ApiRelease リスト表現。
ApiReleaseContract	ApiRelease の詳細。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

ApiReleaseCollection

Object

Paged ApiRelease リスト表現。

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

ApiReleaseContract

Object

ApiRelease の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.apiId	string	リリースが属する API の識別子。
properties.createdDateTime	string (date-time)	API がリリースされた時刻。 日付は、ISO 8601 標準で指定されている yyyy-MM-ddTHH:mm:ssZ の形式に準拠しています。
properties.notes	string	リリース ノート
properties.updatedDateTime	string (date-time)	API リリースが更新された時刻。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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