Alias - Get

참조

서비스:: Subscription

API 버전:: 2021-10-01

별칭 구독을 가져옵니다.

GET https://management.azure.com/providers/Microsoft.Subscription/aliases/{aliasName}?api-version=2021-10-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
aliasName	path	True	string	AliasName은 구독 만들기 요청의 이름입니다. 이는 구독 이름과 동일하지 않으며 구독 만들기 요청 이외의 다른 수명 주기가 필요하지 않습니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다. 현재 버전은 2021-10-01입니다.

응답

Name	형식	Description
200 OK	SubscriptionAliasResponse	구독 세부 정보.
Other Status Codes	ErrorResponseBody	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

GetAlias

샘플 요청

GET https://management.azure.com/providers/Microsoft.Subscription/aliases/aliasForNewSub?api-version=2021-10-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.subscription import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-subscription
# USAGE
    python get_alias.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 = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.alias.get(
        alias_name="aliasForNewSub",
    )
    print(response)


# x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/getAlias.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

package armsubscription_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/subscription/armsubscription"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/getAlias.json
func ExampleAliasClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscription.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAliasClient().Get(ctx, "aliasForNewSub", 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.AliasResponse = armsubscription.AliasResponse{
	// 	Name: to.Ptr("string"),
	// 	Type: to.Ptr("string"),
	// 	ID: to.Ptr("string"),
	// 	Properties: &armsubscription.AliasResponseProperties{
	// 		AcceptOwnershipState: to.Ptr(armsubscription.AcceptOwnershipPending),
	// 		AcceptOwnershipURL: to.Ptr("/providers/Microsoft.Subscription/e2283d0f-acad-4904-b803-627dd74cc072/acceptOwnership"),
	// 		BillingScope: to.Ptr("/billingAccounts/af6231a7-7f8d-4fcc-a993-dd8466108d07:c663dac6-a9a5-405a-8938-cd903e12ab5b_2019_05_31/billingProfiles/QWDQ-QWHI-AUW-SJDO-DJH/invoiceSections/FEUF-EUHE-ISJ-SKDW-DJH"),
	// 		DisplayName: to.Ptr("Test Subscription"),
	// 		ProvisioningState: to.Ptr(armsubscription.ProvisioningStateSucceeded),
	// 		SubscriptionID: to.Ptr("e2283d0f-acad-4904-b803-627dd74cc072"),
	// 		SubscriptionOwnerID: to.Ptr("f09b39eb-c496-482c-9ab9-afd799572f4c"),
	// 		Tags: map[string]*string{
	// 			"tag1": to.Ptr("Messi"),
	// 			"tag2": to.Ptr("Ronaldo"),
	// 			"tag3": to.Ptr("Lebron"),
	// 		},
	// 		Workload: to.Ptr(armsubscription.WorkloadProduction),
	// 	},
	// }
}

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

const { SubscriptionClient } = require("@azure/arm-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get Alias Subscription.
 *
 * @summary Get Alias Subscription.
 * x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/getAlias.json
 */
async function getAlias() {
  const aliasName = "aliasForNewSub";
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const result = await client.alias.get(aliasName);
  console.log(result);
}

getAlias().catch(console.error);

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

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

// Generated from example definition: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/getAlias.json
// this example is just showing the usage of "Alias_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 SubscriptionAliasResource created on azure
// for more information of creating SubscriptionAliasResource, please refer to the document of SubscriptionAliasResource
string aliasName = "aliasForNewSub";
ResourceIdentifier subscriptionAliasResourceId = SubscriptionAliasResource.CreateResourceIdentifier(aliasName);
SubscriptionAliasResource subscriptionAlias = client.GetSubscriptionAliasResource(subscriptionAliasResourceId);

// invoke the operation
SubscriptionAliasResource result = await subscriptionAlias.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
SubscriptionAliasData 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": "string",
  "name": "string",
  "type": "string",
  "properties": {
    "subscriptionId": "e2283d0f-acad-4904-b803-627dd74cc072",
    "displayName": "Test Subscription",
    "provisioningState": "Accepted",
    "acceptOwnershipUrl": "/providers/Microsoft.Subscription/e2283d0f-acad-4904-b803-627dd74cc072/acceptOwnership",
    "acceptOwnershipState": "Pending",
    "billingScope": "/billingAccounts/af6231a7-7f8d-4fcc-a993-dd8466108d07:c663dac6-a9a5-405a-8938-cd903e12ab5b_2019_05_31/billingProfiles/QWDQ-QWHI-AUW-SJDO-DJH/invoiceSections/FEUF-EUHE-ISJ-SKDW-DJH",
    "workload": "Production",
    "resellerId": null,
    "subscriptionOwnerId": "f09b39eb-c496-482c-9ab9-afd799572f4c",
    "managementGroupId": null,
    "tags": {
      "tag1": "Messi",
      "tag2": "Ronaldo",
      "tag3": "Lebron"
    }
  }
}

정의

Name	Description
AcceptOwnership	리소스의 소유권 허용 상태입니다.
createdByType	리소스를 만든 ID 유형입니다.
ErrorResponse	오류 응답의 형식을 설명합니다.
ErrorResponseBody	오류 응답은 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 이유는 오류 메시지에 제공됩니다.
ProvisioningState	리소스의 프로비전 상태입니다.
SubscriptionAliasResponse	별칭이 있는 구독 정보입니다.
SubscriptionAliasResponseProperties	구독 만들기 결과 속성을 배치합니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
workload	구독의 워크로드 유형입니다. 프로덕션 또는 DevTest일 수 있습니다.

AcceptOwnership

리소스의 소유권 허용 상태입니다.

Name	형식	Description
Completed	string
Expired	string
Pending	string

createdByType

리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

오류 응답의 형식을 설명합니다.

Name	형식	Description
code	string	오류 코드
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

ErrorResponseBody

오류 응답은 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 이유는 오류 메시지에 제공됩니다.

Name	형식	Description
code	string	오류 코드
error	ErrorResponse	오류의 세부 정보입니다.
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

ProvisioningState

리소스의 프로비전 상태입니다.

Name	형식	Description
Accepted	string
Pending	string
Succeeded	string

SubscriptionAliasResponse

별칭이 있는 구독 정보입니다.

Name	형식	Description
id	string	별칭 리소스에 대한 정규화된 ID입니다.
name	string	별칭 ID입니다.
properties	SubscriptionAliasResponseProperties	구독 별칭 응답 속성입니다.
systemData	systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
type	string	리소스 종류, Microsoft.Subscription/별칭.

SubscriptionAliasResponseProperties

구독 만들기 결과 속성을 배치합니다.

Name	형식	Description
acceptOwnershipState	AcceptOwnership	리소스의 소유권 허용 상태입니다.
acceptOwnershipUrl	string	구독 소유권을 수락하는 URL입니다.
billingScope	string	구독의 청구 scope. CustomerLed 및 FieldLed의 경우 - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	만든 시간
displayName	string	구독의 표시 이름입니다.
managementGroupId	string	관리 그룹 ID입니다.
provisioningState	ProvisioningState	리소스의 프로비전 상태입니다.
resellerId	string	재판매인 ID
subscriptionId	string	새로 만든 구독 ID입니다.
subscriptionOwnerId	string	구독의 소유자 ID
tags	object	구독에 대한 태그
workload	workload	구독의 워크로드 유형입니다. 프로덕션 또는 DevTest일 수 있습니다.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID 유형입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

workload

구독의 워크로드 유형입니다. 프로덕션 또는 DevTest일 수 있습니다.

Name	형식	Description
DevTest	string
Production	string

다음을 통해 공유

Alias - Get

URI 매개 변수

응답

보안

azure_auth

범위

예제

GetAlias

샘플 요청

샘플 응답

정의

AcceptOwnership

createdByType

ErrorResponse

ErrorResponseBody

ProvisioningState

SubscriptionAliasResponse

SubscriptionAliasResponseProperties

systemData

workload

추가 리소스