Alias - Get

Referens

Tjänst:: Subscription

API-version:: 2021-10-01

Hämta aliasprenumeration.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
aliasName	path	True	string	AliasName är namnet på begäran om att skapa prenumerationen. Observera att detta inte är samma som prenumerationsnamnet och att detta inte har något annat livscykelbehov utöver begäran om att skapa prenumerationen.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Aktuell version är 2021-10-01

Svar

Name	Typ	Description
200 OK	SubscriptionAliasResponse	Prenumerationsinformation.
Other Status Codes	ErrorResponseBody	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

GetAlias

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
    }
  }
}

Definitioner

Name	Description
AcceptOwnership	Tillståndet acceptera ägarskap för resursen.
createdByType	Den typ av identitet som skapade resursen.
ErrorResponse	Beskriver formatet för felsvar.
ErrorResponseBody	Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
ProvisioningState	Resursens etableringsstatus.
SubscriptionAliasResponse	Prenumerationsinformation med aliaset .
SubscriptionAliasResponseProperties	Ange resultategenskaper för att skapa prenumerationer.
systemData	Metadata som rör skapande och senaste ändring av resursen.
workload	Prenumerationens arbetsbelastningstyp. Det kan vara antingen Produktion eller DevTest.

AcceptOwnership

Tillståndet acceptera ägarskap för resursen.

Name	Typ	Description
Completed	string
Expired	string
Pending	string

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

Beskriver formatet för felsvar.

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponseBody

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name	Typ	Description
code	string	Felkod
error	ErrorResponse	Information om felet.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ProvisioningState

Resursens etableringsstatus.

Name	Typ	Description
Accepted	string
Pending	string
Succeeded	string

SubscriptionAliasResponse

Prenumerationsinformation med aliaset .

Name	Typ	Description
id	string	Fullständigt kvalificerat ID för aliasresursen.
name	string	Alias-ID.
properties	SubscriptionAliasResponseProperties	Svarsegenskaper för prenumerationsalias.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
type	string	Resurstyp, Microsoft.Subscription/alias.

SubscriptionAliasResponseProperties

Ange resultategenskaper för att skapa prenumerationer.

Name	Typ	Description
acceptOwnershipState	AcceptOwnership	Tillståndet acceptera ägarskap för resursen.
acceptOwnershipUrl	string	URL för att acceptera ägarskapet för prenumerationen.
billingScope	string	Prenumerationens faktureringsomfång. För CustomerLed och FieldLed – /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	Genereringstid
displayName	string	Prenumerationens visningsnamn.
managementGroupId	string	Hanteringsgrupps-ID: t.
provisioningState	ProvisioningState	Resursens etableringsstatus.
resellerId	string	Reseller Id
subscriptionId	string	Nyligen skapat prenumerations-ID.
subscriptionOwnerId	string	Ägar-ID för prenumerationen
tags	object	Taggar för prenumerationen
workload	workload	Prenumerationens arbetsbelastningstyp. Det kan vara antingen Produktion eller DevTest.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

workload

Prenumerationens arbetsbelastningstyp. Det kan vara antingen Produktion eller DevTest.

Name	Typ	Description
DevTest	string
Production	string

Dela via

Alias - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

GetAlias

Exempelbegäran

Exempelsvar

Definitioner

AcceptOwnership

createdByType

ErrorResponse

ErrorResponseBody

ProvisioningState

SubscriptionAliasResponse

SubscriptionAliasResponseProperties

systemData

workload

Ytterligare resurser