Subscription - Get
取得指定的訂用帳戶實體。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2022-08-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
service
|
path | True |
string |
API 管理 服務的名稱。 Regex pattern: |
sid
|
path | True |
string |
訂用帳戶實體標識碼。 實體代表使用者與 API 管理 產品之間的關聯。 Regex pattern: |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
回應本文包含指定的訂用帳戶實體。 Headers ETag: string |
|
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 | 模擬您的用戶帳戶 |
範例
ApiManagementGetSubscription
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8?api-version=2022-08-01
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8",
"type": "Microsoft.ApiManagement/service/subscriptions",
"name": "5931a769d8d14f0ad8ce13b8",
"properties": {
"ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
"scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
"displayName": "Unlimited",
"state": "submitted",
"createdDate": "2017-06-02T17:59:06.223Z"
}
}
定義
名稱 | Description |
---|---|
Error |
錯誤欄位合約。 |
Error |
錯誤回應。 |
Subscription |
訂用帳戶詳細數據。 |
Subscription |
訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、* 已暫停 – 訂閱已遭封鎖,且訂閱者無法呼叫產品的任何 API* 已提交 – 開發人員已提出訂閱要求,但尚未核准或拒絕,* 已拒絕 – 系統管理員已拒絕訂閱要求,* 已取消 – 已取消訂用帳戶, * 已過期 – 訂用帳戶已達到到期日且已停用。 |
ErrorFieldContract
錯誤欄位合約。
名稱 | 類型 | Description |
---|---|---|
code |
string |
屬性層級錯誤碼。 |
message |
string |
人類可讀取的屬性層級錯誤表示法。 |
target |
string |
屬性名稱。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error.code |
string |
服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。 |
error.details |
要求中傳送無效欄位的清單,以防發生驗證錯誤。 |
|
error.message |
string |
人類可閱讀的錯誤表示法。 |
SubscriptionContract
訂用帳戶詳細數據。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
資源的名稱 |
properties.allowTracing |
boolean |
判斷是否啟用追蹤 |
properties.createdDate |
string |
訂用帳戶建立日期。 日期符合下列格式: |
properties.displayName |
string |
訂用帳戶的名稱,如果訂用帳戶沒有名稱,則為 null。 |
properties.endDate |
string |
取消或過期訂閱的日期。 此設定僅供稽核之用,且不會自動取消訂用帳戶。 訂用 |
properties.expirationDate |
string |
訂閱到期日。 此設定僅供稽核之用,且訂閱不會自動過期。 訂用 |
properties.notificationDate |
string |
即將推出的訂閱到期通知日期。 日期符合下列格式: |
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 |
訂閱啟用日期。 此設定僅供稽核之用,且不會自動啟用訂用帳戶。 訂用 |
properties.state |
訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、* 已暫停 – 訂閱已遭封鎖,且訂閱者無法呼叫產品的任何 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 |