Operation - List By Tags
列出與標記相關聯的作業集合。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operationsByTags?$filter={$filter}&$top={$top}&$skip={$skip}&includeNotTaggedOperations={includeNotTaggedOperations}&api-version=2022-08-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
api
|
path | True |
string |
API 修訂標識碼。 目前 API 管理 服務實例中必須是唯一的。 非目前修訂具有 ;rev=n 作為後綴,其中 n 是修訂編號。 Regex pattern: |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
service
|
path | True |
string |
API 管理 服務的名稱。 Regex pattern: |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
$filter
|
query |
string |
|欄位 |使用量 |支持的運算子 |支援的函式 | |
|
$skip
|
query |
integer int32 |
要略過的記錄數目。 |
|
$top
|
query |
integer int32 |
要傳回的記錄數目。 |
|
include
|
query |
boolean |
包含未標記的 Operations。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
列出 TagResource 實體的集合。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
ApiManagementListApiOperationsByTags
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/operationsByTags?api-version=2022-08-01
Sample Response
{
"value": [
{
"tag": {
"id": "/tags/apitag123",
"name": "awesomeTag"
},
"operation": {
"id": "/apis/echo-api/operations/create-resource",
"apiName": "Echo API",
"apiRevision": "1",
"name": "Create resource",
"method": "POST",
"urlTemplate": "/resource",
"description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend."
}
}
],
"count": 1
}
定義
名稱 | Description |
---|---|
Api |
API 連絡資訊 |
Api |
API 授權資訊 |
Api |
標記資源的 API 合約屬性。 |
Api |
API 的類型。 |
Authentication |
API 驗證設定。 |
bearer |
如何將令牌傳送至伺服器。 |
Error |
錯誤欄位合約。 |
Error |
錯誤回應。 |
OAuth2Authentication |
API OAuth2 驗證設定詳細數據。 |
Open |
API OAuth2 驗證設定詳細數據。 |
Operation |
作業實體合約屬性。 |
Product |
是否發佈產品。 開發人員入口網站的使用者可探索已發佈的產品。 只有系統管理員可以看到未發行的產品。 Product 的默認狀態為 notPublished。 |
Product |
產品配置檔。 |
Protocol |
描述此 API 中的作業可在哪些通訊協定上叫用。 |
Subscription |
訂用帳戶金鑰參數名稱詳細數據。 |
Tag |
分頁標記清單表示法。 |
Tag |
TagResource 合約屬性。 |
Tag |
在標籤資源合約中定義 Tag 屬性的合約 |
ApiContactInformation
API 連絡資訊
名稱 | 類型 | Description |
---|---|---|
string |
連絡人/組織的電子郵件位址。 必須是電子郵件位址的格式 |
|
name |
string |
聯繫人/組織的識別名稱 |
url |
string |
指向聯繫人資訊的 URL。 必須是 URL 的格式 |
ApiLicenseInformation
API 授權資訊
名稱 | 類型 | Description |
---|---|---|
name |
string |
用於 API 的授權名稱 |
url |
string |
用於 API 之授權的 URL。 必須是 URL 的格式 |
ApiTagResourceContractProperties
標記資源的 API 合約屬性。
名稱 | 類型 | Description |
---|---|---|
apiRevision |
string |
描述 API 的修訂。 如果未提供任何值,則會建立預設修訂 1 |
apiRevisionDescription |
string |
API 修訂的描述。 |
apiVersion |
string |
指出 API 的版本識別碼,如果 API 已建立版本設定 |
apiVersionDescription |
string |
API 版本的描述。 |
apiVersionSetId |
string |
相關 ApiVersionSet 的資源標識碼。 |
authenticationSettings |
此 API 中包含的驗證設定集合。 |
|
contact |
API 的連絡資訊。 |
|
description |
string |
API 的描述。 可包含 HTML 格式標籤。 |
id |
string |
格式為 /apis/{apiId} 的 API 識別符。 |
isCurrent |
boolean |
指出 API 修訂是否為目前的 API 修訂。 |
isOnline |
boolean |
指出是否可透過閘道存取 API 修訂。 |
license |
API 的授權資訊。 |
|
name |
string |
API 名稱。 |
path |
string |
可在 API 管理服務執行個體內唯一識別此 API 及其所有資源路徑的相對 URL。 此路徑會附加至在服務執行個體建立期間所指定的 API 端點基底 URL,以形成此 API 的公用 URL。 |
protocols |
Protocol[] |
描述此 API 中的作業可在哪些通訊協定上叫用。 |
serviceUrl |
string |
實作此 API 之後端服務的絕對 URL。 |
subscriptionKeyParameterNames |
API 可供使用的通訊協定。 |
|
subscriptionRequired |
boolean |
指定存取 API 是否需要 API 或產品訂用帳戶。 |
termsOfServiceUrl |
string |
API 服務條款的 URL。 必須是 URL 的格式。 |
type |
API 的類型。 |
ApiType
API 的類型。
名稱 | 類型 | Description |
---|---|---|
graphql |
string |
|
http |
string |
|
soap |
string |
|
websocket |
string |
AuthenticationSettingsContract
API 驗證設定。
名稱 | 類型 | Description |
---|---|---|
oAuth2 |
OAuth2 驗證設定 |
|
oAuth2AuthenticationSettings |
包含在此 API 中的 OAuth2 驗證設定集合。 |
|
openid |
OpenID Connect 驗證設定 |
|
openidAuthenticationSettings |
此 API 中包含的 Open ID Connect 驗證設定集合。 |
bearerTokenSendingMethods
如何將令牌傳送至伺服器。
名稱 | 類型 | Description |
---|---|---|
authorizationHeader |
string |
存取令牌將會使用持有人架構在授權標頭中傳輸 |
query |
string |
存取令牌會以查詢參數的形式傳輸。 |
ErrorFieldContract
錯誤欄位合約。
名稱 | 類型 | Description |
---|---|---|
code |
string |
屬性層級錯誤碼。 |
message |
string |
人類可讀取的屬性層級錯誤表示法。 |
target |
string |
屬性名稱。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error.code |
string |
服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。 |
error.details |
在驗證錯誤時,要求中傳送的無效欄位清單。 |
|
error.message |
string |
人類可閱讀的錯誤表示法。 |
OAuth2AuthenticationSettingsContract
API OAuth2 驗證設定詳細數據。
名稱 | 類型 | Description |
---|---|---|
authorizationServerId |
string |
OAuth 授權伺服器識別碼。 |
scope |
string |
作業範圍。 |
OpenIdAuthenticationSettingsContract
API OAuth2 驗證設定詳細數據。
名稱 | 類型 | Description |
---|---|---|
bearerTokenSendingMethods |
如何將令牌傳送至伺服器。 |
|
openidProviderId |
string |
OAuth 授權伺服器識別碼。 |
OperationTagResourceContractProperties
作業實體合約屬性。
名稱 | 類型 | Description |
---|---|---|
apiName |
string |
API 名稱。 |
apiRevision |
string |
API 修訂。 |
apiVersion |
string |
API 版本。 |
description |
string |
作業描述。 |
id |
string |
表單 /operations/{operationId} 的作業標識符。 |
method |
string |
有效的 HTTP 作業方法。 一般 Http 方法,例如 GET、PUT、POST,但不受限制。 |
name |
string |
作業名稱。 |
urlTemplate |
string |
可識別此作業之目標資源的相對 URL 範本。 可包含參數。 範例:/customers/{cid}/orders/{oid}/?date={date} |
ProductState
是否發佈產品。 開發人員入口網站的使用者可探索已發佈的產品。 只有系統管理員可以看到未發行的產品。 Product 的默認狀態為 notPublished。
名稱 | 類型 | Description |
---|---|---|
notPublished |
string |
|
published |
string |
ProductTagResourceContractProperties
產品配置檔。
名稱 | 類型 | Description |
---|---|---|
approvalRequired |
boolean |
是否需要訂用帳戶核准。 如果為 false,新的訂用帳戶將會自動核准,讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true,系統管理員必須先手動核准訂用帳戶,開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時,才能存在。 |
description |
string |
產品描述。 可包含 HTML 格式標籤。 |
id |
string |
/products/{productId} 形式的產品標識符 |
name |
string |
產品名稱。 |
state |
產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員可以看到非已發佈的產品。 Product 的默認狀態為 notPublished。 |
|
subscriptionRequired |
boolean |
存取此產品中包含的 API 是否需要產品訂用帳戶。 如果為 true,則產品稱為「受保護」,而且需要有效的訂用帳戶密鑰,才能成功要求產品中包含的 API。 如果為 false,則產品稱為「開啟」,而且可以在沒有訂用帳戶密鑰的情況下對產品中包含的 API 提出要求。 如果在建立新產品時省略 屬性,則會假設其值為 true。 |
subscriptionsLimit |
integer |
使用者是否可以同時擁有此產品的訂閱數目。 設定為 null 或省略 ,以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 false 時,才能存在。 |
terms |
string |
產品使用規定。 嘗試訂閱產品的開發人員將會看到且必須接受這些使用規定,才能完成訂閱程序。 |
Protocol
描述此 API 中的作業可在哪些通訊協定上叫用。
名稱 | 類型 | Description |
---|---|---|
http |
string |
|
https |
string |
|
ws |
string |
|
wss |
string |
SubscriptionKeyParameterNamesContract
訂用帳戶金鑰參數名稱詳細數據。
名稱 | 類型 | Description |
---|---|---|
header |
string |
訂用帳戶金鑰標頭名稱。 |
query |
string |
訂用帳戶金鑰查詢字串參數名稱。 |
TagResourceCollection
分頁標記清單表示法。
名稱 | 類型 | Description |
---|---|---|
count |
integer |
所有頁面的總記錄計數數目。 |
nextLink |
string |
如果有的話,下一頁連結。 |
value |
頁面值。 |
TagResourceContract
TagResource 合約屬性。
名稱 | 類型 | Description |
---|---|---|
api |
與標記相關聯的 API。 |
|
operation |
與標記相關聯的作業。 |
|
product |
與標籤相關聯的產品。 |
|
tag |
與資源相關聯的標記。 |
TagTagResourceContractProperties
在標籤資源合約中定義 Tag 屬性的合約
名稱 | 類型 | Description |
---|---|---|
id |
string |
標記識別項 |
name |
string |
標記名稱 |