共用方式為


User Subscription - List

列出指定之用戶的訂用帳戶集合。

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

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

serviceName
path True

string

API 管理 服務的名稱。

Regex 模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目標訂用帳戶的標識碼。

userId
path True

string

使用者識別碼。 目前 API 管理 服務實例中必須是唯一的。

api-version
query True

string

用於此作業的 API 版本。

$filter
query

string

|欄位 |使用量 |支持的運算子 |支援的函式 |
|-------------|------------------------|-----------------------------------|
|name |filter |ge, le, eq, ne, gt, lt |substringof, contains, startswith, endwith |
|displayName |filter |ge, le, eq, ne, gt, lt |substringof, contains, startswith, endwith |
|stateComment |filter |ge, le, eq, ne, gt, lt |substringof, contains, startswith, endwith |
|ownerId |filter |ge, le, eq, ne, gt, lt |substringof, contains, startswith, endwith |
|scope |filter |ge, le, eq, ne, gt, lt |substringof, contains, startswith, endwith |
|userId |filter |ge, le, eq, ne, gt, lt |substringof, contains, startswith, endwith |
|productId |filter |ge, le, eq, ne, gt, lt |substringof, contains, startswith, endwith |

$skip
query

integer

int32

要略過的記錄數目。

$top
query

integer

int32

要傳回的記錄數目。

回應

名稱 類型 Description
200 OK

SubscriptionCollection

列出訂用帳戶實體的集合。

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 模擬您的用戶帳戶

範例

ApiManagementListUserSubscriptions

範例要求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions?api-version=2022-08-01

範例回覆

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3",
      "type": "Microsoft.ApiManagement/service/users/subscriptions",
      "name": "57681850a40f7eb6c49f6ae3",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7",
        "displayName": "57681850a40f7eb6c49f6ae5",
        "state": "active",
        "createdDate": "2016-06-20T16:22:39.547Z",
        "startDate": "2016-06-20T00:00:00Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b",
      "type": "Microsoft.ApiManagement/service/users/subscriptions",
      "name": "57681850a40f7eb6c49f6b2b",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7",
        "displayName": "57681850a40f7eb6c49f6b2d",
        "state": "active",
        "createdDate": "2016-06-20T16:22:41.103Z",
        "startDate": "2016-06-20T00:00:00Z"
      }
    }
  ],
  "nextLink": ""
}

定義

名稱 Description
ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

SubscriptionCollection

分頁訂閱清單表示。

SubscriptionContract

訂用帳戶詳細數據。

SubscriptionState

訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、* 已暫停 – 訂閱已遭封鎖,且訂閱者無法呼叫產品的任何 API* 已提交 – 開發人員已提出訂閱要求,但尚未核准或拒絕,* 已拒絕 – 系統管理員已拒絕訂閱要求,* 已取消 – 已取消訂用帳戶, * 已過期 – 訂用帳戶已達到到期日且已停用。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

人類可讀取的屬性層級錯誤表示法。

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

ErrorFieldContract[]

要求中傳送無效欄位的清單,以防發生驗證錯誤。

error.message

string

人類可閱讀的錯誤表示法。

SubscriptionCollection

分頁訂閱清單表示。

名稱 類型 Description
count

integer

所有頁面的記錄計數總數。

nextLink

string

如果有的話,下一頁連結。

value

SubscriptionContract[]

頁面值。

SubscriptionContract

訂用帳戶詳細數據。

名稱 類型 Description
id

string

資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

資源的名稱

properties.allowTracing

boolean

判斷是否啟用追蹤

properties.createdDate

string

訂用帳戶建立日期。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

properties.displayName

string

訂用帳戶的名稱,如果訂用帳戶沒有名稱,則為 null。

properties.endDate

string

取消或過期訂閱的日期。 此設定僅供稽核之用,且不會自動取消訂用帳戶。 訂用 state 帳戶生命週期可以使用 屬性來管理。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

properties.expirationDate

string

訂閱到期日。 此設定僅供稽核之用,且訂閱不會自動過期。 訂用 state 帳戶生命週期可以使用 屬性來管理。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

properties.notificationDate

string

即將推出的訂閱到期通知日期。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

properties.ownerId

string

訂閱擁有者的使用者資源識別碼。 此值是 /users/{userId} 格式的有效相對 URL,其中 {userId} 是使用者標識符。

properties.primaryKey

string

訂用帳戶主鍵。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。

properties.scope

string

/products/{productId} 或 /apis 或 /apis/{apiId} 等範圍。

properties.secondaryKey

string

訂用帳戶次要金鑰。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。

properties.startDate

string

訂閱啟用日期。 此設定僅供稽核之用,且不會自動啟用訂用帳戶。 訂用 state 帳戶生命週期可以使用 屬性來管理。 日期符合下列格式: yyyy-MM-ddTHH:mm:ssZ 如 ISO 8601 標準所指定。

properties.state

SubscriptionState

訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、* 已暫停 – 訂閱已遭封鎖,且訂閱者無法呼叫產品的任何 API* 已提交 – 開發人員已提出訂閱要求,但尚未核准或拒絕,* 已拒絕 – 系統管理員已拒絕訂閱要求,* 已取消 – 已取消訂用帳戶, * 已過期 – 訂用帳戶已達到到期日且已停用。

properties.stateComment

string

當狀態變更為「已拒絕」時,系統管理員所新增的選擇性訂用帳戶批注。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

SubscriptionState

訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、* 已暫停 – 訂閱已遭封鎖,且訂閱者無法呼叫產品的任何 API* 已提交 – 開發人員已提出訂閱要求,但尚未核准或拒絕,* 已拒絕 – 系統管理員已拒絕訂閱要求,* 已取消 – 已取消訂用帳戶, * 已過期 – 訂用帳戶已達到到期日且已停用。

名稱 類型 Description
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string