Subscription - Get

服務:

API Management

API 版本:

2024-05-01

取得指定的訂閱實體。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?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 管理服務的名稱。
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	訂用帳戶實體標識碼。 實體代表使用者與 API 管理中產品之間的關聯。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	SubscriptionContract	回應主體包含指定的訂用帳戶實體。 標題 ETag: string
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	模擬您的用戶帳戶

範例

ApiManagementGetSubscription

範例要求

HTTP

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

Java

/**
 * Samples for Subscription Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementGetSubscription.json
     */
    /**
     * Sample code: ApiManagementGetSubscription.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementGetSubscription(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.subscriptions().getWithResponse("rg1", "apimService1", "5931a769d8d14f0ad8ce13b8",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_get_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.subscription.get(
        resource_group_name="rg1",
        service_name="apimService1",
        sid="5931a769d8d14f0ad8ce13b8",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetSubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetSubscription.json
func ExampleSubscriptionClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSubscriptionClient().Get(ctx, "rg1", "apimService1", "5931a769d8d14f0ad8ce13b8", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SubscriptionContract = armapimanagement.SubscriptionContract{
	// 	Name: to.Ptr("5931a769d8d14f0ad8ce13b8"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/subscriptions"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8"),
	// 	Properties: &armapimanagement.SubscriptionContractProperties{
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-02T17:59:06.223Z"); return t}()),
	// 		DisplayName: to.Ptr("Unlimited"),
	// 		OwnerID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b"),
	// 		Scope: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002"),
	// 		State: to.Ptr(armapimanagement.SubscriptionStateSubmitted),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Gets the specified Subscription entity.
 *
 * @summary Gets the specified Subscription entity.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetSubscription.json
 */
async function apiManagementGetSubscription() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const sid = "5931a769d8d14f0ad8ce13b8";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.subscription.get(resourceGroupName, serviceName, sid);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetSubscription.json
// this example is just showing the usage of "Subscription_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementSubscriptionResource
ApiManagementSubscriptionCollection collection = apiManagementService.GetApiManagementSubscriptions();

// invoke the operation
string sid = "5931a769d8d14f0ad8ce13b8";
NullableResponse<ApiManagementSubscriptionResource> response = await collection.GetIfExistsAsync(sid);
ApiManagementSubscriptionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SubscriptionContractData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "5931a769d8d14f0ad8ce13b8",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "Unlimited",
    "state": "submitted",
    "createdDate": "2017-06-02T17:59:06.223Z"
  }
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
SubscriptionContract	訂用帳戶詳細數據。
SubscriptionState	訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、 * 已暫停 – 已封鎖訂用帳戶，且訂閱者無法呼叫產品的任何 API* 已提交 – 已由開發人員提出訂閱要求，但尚未核准或拒絕，* 已拒絕 – 系統管理員已拒絕訂閱要求，* 已取消 – 開發人員或系統管理員已取消訂用帳戶要求， * 已過期 – 訂用帳戶已達到到期日且已停用。

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 物件。

SubscriptionContract

Object

訂用帳戶詳細數據。

名稱	類型	Description
id	string	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.allowTracing	boolean	判斷是否啟用追蹤
properties.createdDate	string (date-time)	訂用帳戶建立日期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
properties.displayName	string minLength: 0 maxLength: 100	訂閱的名稱，如果訂用帳戶沒有名稱，則為 null。
properties.endDate	string (date-time)	取消或過期訂閱的日期。 此設定僅供稽核之用，且不會自動取消訂用帳戶。 您可以使用 state 屬性來管理訂用帳戶生命週期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
properties.expirationDate	string (date-time)	訂閱到期日。 此設定僅供稽核之用，且訂用帳戶不會自動過期。 您可以使用 state 屬性來管理訂用帳戶生命週期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
properties.notificationDate	string (date-time)	即將推出的訂用帳戶到期通知日期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
properties.ownerId	string	訂用帳戶擁有者的用戶資源標識碼。 值是 /users/{userId} 格式的有效相對 URL，其中 {userId} 是使用者標識符。
properties.primaryKey	string minLength: 1 maxLength: 256	訂用帳戶主鍵。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。
properties.scope	string	範圍，例如 /products/{productId} 或 /apis 或 /apis/{apiId}。
properties.secondaryKey	string minLength: 1 maxLength: 256	訂用帳戶次要金鑰。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。
properties.startDate	string (date-time)	訂用帳戶啟用日期。 此設定僅供稽核之用，而且不會自動啟用訂用帳戶。 您可以使用 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
cancelled
expired
rejected
submitted
suspended