Documentation - List By Service

服務:

API Management

API 版本:

2024-05-01

列出 API 管理服務實例的所有檔。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
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 管理服務的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。
$filter	query		string	|欄位 |使用量 |支持的運算子 |支援的函式 | |-------------|-------------|-------------|-------------| |name |filter |eq |contains |
$skip	query		integer (int32) minimum: 0	要略過的記錄數目。
$top	query		integer (int32) minimum: 1	要傳回的記錄數目。

回應

名稱	類型	Description
200 OK	DocumentationCollection	檔分頁的結果回應。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ApiManagementListApis

範例要求

HTTP

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

範例回覆

狀態碼:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test",
      "type": "Microsoft.ApiManagement/service/documentations",
      "name": "test",
      "properties": {
        "title": "test",
        "content": "Test content "
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test2",
      "type": "Microsoft.ApiManagement/service/documentations",
      "name": "test2",
      "properties": {
        "title": "test",
        "content": "Test content "
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/documentations/test3",
      "type": "Microsoft.ApiManagement/service/documentations",
      "name": "test3",
      "properties": {
        "title": "test",
        "content": "Test content "
      }
    }
  ],
  "nextLink": ""
}

定義

名稱	Description
DocumentationCollection	分頁檔案清單表示。
DocumentationContract	Markdown 文件詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

DocumentationCollection

Object

分頁檔案清單表示。

名稱	類型	Description
nextLink	string	如果有的話，下一頁連結。
value	DocumentationContract[]	頁面值。

DocumentationContract

Object

Markdown 文件詳細數據。

名稱	類型	Description
id	string	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.content	string	Markdown 文件內容。
properties.title	string	檔標題。
type	string	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。