共用方式為

直接管理API 管理 REST API

  • 發行項

Azure API 管理提供直接管理 REST API，以對選取的實體執行作業，例如使用者、群組、產品和訂用帳戶。 直接管理 API 可以略過 Azure Resource Manager型 API 的特定限制，例如要求節流。

重要

本節說明如何存取直接管理API 管理 REST API。 此 API 的驗證機制與 Azure Resource Manager不同，並使用不同的基底 URL。

啟用直接管理 REST API 的存取權

必須先授與直接管理API 管理 REST API 的存取權，才能成功進行呼叫。

  1. 流覽至Azure 入口網站中的 Azure API 管理 實例。

  2. 從左側功能表的[部署 + 基礎結構] 區段選取 [管理 API]。

    在Azure 入口網站中選取 [管理 API]

  3. 在[啟用API 管理 REST API] 中，選取 [是]。

    重要

    如果未選取[啟用API 管理 REST API，則對該服務實例的 REST API 進行呼叫將會失敗。

    在 Azure 入口網站 中啟用 API 管理 API

預設媒體類型

要求和回應的預設媒體類型為 application/json。 如果另有指定，有些作業可支援其他內容類型。 如果沒有為特定作業指定其他內容類型，則媒體類型會是 application/json。

驗證

每個對API 管理 REST API 的要求都必須隨附 Authorization 包含有效共用存取權杖的標頭，如下列範例所示。

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

此存取權杖可透過程式設計方式產生，或從 API 管理發行者入口網站產生。 如需產生和擷取存取權杖的指示，請參閱手動建立存取權杖和以程式設計方式建立存取權杖。

基底 URL

直接管理API 管理 REST API 的基底 URL 符合下列範本。

https://{servicename}.management.azure-api.net

此範本包含下列參數。

  • {serviceName} 是服務建立期間所指定的服務名稱，例如 https://contosoapi.management.azure-api.net。

API 管理 REST API 傳回的所有 URL 都相對於此基底 URL，而 REST API 的所有要求都必須使用此基底 URL 範本。

版本查詢參數

所有作業都應有值的格式為 api-version (例如 YYYY-MM-DD) 的 2021-08-01 查詢參數。

注意

在API 管理 REST API 的預覽期間， -preview 會附加至版本查詢參數，例如 2021-04-01-preview 。

如果未在要求的查詢字串中傳遞這個查詢參數，伺服器會傳回 的狀態碼 400 Bad Request 。 如需支援的版本清單，請參閱API 管理 REST API 參考。

下一步