Subscription - Get

서비스:

API Management

API 버전:

2022-08-01

지정된 구독 엔터티를 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2022-08-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
serviceName	path	True	string	API Management 서비스의 이름입니다. regex 패턴: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
sid	path	True	string	구독 엔터티 식별자입니다. 엔터티는 API Management 사용자와 제품 간의 연결을 나타냅니다. regex 패턴: ^[^*#&+:<>?]+$
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementGetSubscription

샘플 요청

HTTP

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

Java

/** Samples for Subscription Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-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="subid",
    )

    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/2022-08-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-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/subid/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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b"),
	// 		Scope: to.Ptr("/subscriptions/subid/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");

/**
 * 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/2022-08-01/examples/ApiManagementGetSubscription.json
 */
async function apiManagementGetSubscription() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  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/2022-08-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 ApiManagementSubscriptionResource created on azure
// for more information of creating ApiManagementSubscriptionResource, please refer to the document of ApiManagementSubscriptionResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string sid = "5931a769d8d14f0ad8ce13b8";
ResourceIdentifier apiManagementSubscriptionResourceId = ApiManagementSubscriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, sid);
ApiManagementSubscriptionResource apiManagementSubscription = client.GetApiManagementSubscriptionResource(apiManagementSubscriptionResourceId);

// invoke the operation
ApiManagementSubscriptionResource result = await apiManagementSubscription.GetAsync();

// 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/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"
  }
}

정의

Name	Description
ErrorFieldContract	오류 필드 계약입니다.
ErrorResponse	오류 응답.
SubscriptionContract	구독 세부 정보.
SubscriptionState	구독 상태입니다. 가능한 상태는 * 활성 상태이며, 구독이 활성 상태이며, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청은 개발자가 수행했지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 – 구독이 만료 날짜에 도달하여 비활성화되었습니다.

ErrorFieldContract

오류 필드 계약입니다.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.

SubscriptionContract

구독 세부 정보.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름입니다.
properties.allowTracing	boolean	추적을 사용할 수 있는지 여부를 결정합니다.
properties.createdDate	string	구독 만들기 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.displayName	string	구독의 이름 또는 구독에 이름이 없는 경우 null입니다.
properties.endDate	string	구독이 취소되거나 만료된 날짜입니다. 이 설정은 감사 목적으로만 사용되며 구독이 자동으로 취소되지 않습니다. 속성을 사용하여 구독 수명 주기를 state 관리할 수 있습니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.expirationDate	string	구독 만료 날짜입니다. 설정은 감사 목적으로만 사용되며 구독이 자동으로 만료되지 않습니다. 속성을 사용하여 구독 수명 주기를 state 관리할 수 있습니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.notificationDate	string	예정된 구독 만료 알림 날짜입니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.ownerId	string	구독 소유자의 사용자 리소스 식별자입니다. 값은 /users/{userId} 형식의 유효한 상대 URL입니다. 여기서 {userId}는 사용자 식별자입니다.
properties.primaryKey	string	구독 기본 키입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.
properties.scope	string	/products/{productId} 또는 /api 또는 /apiId}와 같은 범위입니다.
properties.secondaryKey	string	구독 보조 키입니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.
properties.startDate	string	구독 활성화 날짜입니다. 설정은 감사 목적으로만 사용되며 구독이 자동으로 활성화되지 않습니다. 속성을 사용하여 구독 수명 주기를 state 관리할 수 있습니다. 날짜는 ISO 8601 표준에 지정된 형식 yyyy-MM-ddTHH:mm:ssZ 을 따릅니다.
properties.state	SubscriptionState	구독 상태입니다. 가능한 상태는 * 활성 상태이며, 구독이 활성 상태이며, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청은 개발자가 수행했지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 – 구독이 만료 날짜에 도달하여 비활성화되었습니다.
properties.stateComment	string	상태가 '거부됨'으로 변경되면 관리자가 추가한 선택적 구독 주석입니다.
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

SubscriptionState

구독 상태입니다. 가능한 상태는 * 활성 상태이며, 구독이 활성 상태이며, * 일시 중단됨 – 구독이 차단되고 구독자가 제품의 API를 호출할 수 없습니다. * 제출됨 – 구독 요청은 개발자가 수행했지만 아직 승인되거나 거부되지 않았습니다. * 거부됨 - 관리자가 구독 요청을 거부했습니다. * 취소됨 - 개발자 또는 관리자가 구독을 취소했습니다. * 만료됨 – 구독이 만료 날짜에 도달하여 비활성화되었습니다.

Name	형식	Description
active	string
cancelled	string
expired	string
rejected	string
submitted	string
suspended	string