Alias - Get

Referência

Serviço:: Subscription

Versão da API:: 2021-10-01

Obter Subscrição de Alias.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
aliasName	path	True	string	AliasName é o nome do pedido de criação da subscrição. Tenha em atenção que não é o mesmo que o nome da subscrição e que não tem qualquer outra necessidade de ciclo de vida para além do pedido de criação da subscrição.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente. A versão atual é 2021-10-01

Respostas

Name	Tipo	Description
200 OK	SubscriptionAliasResponse	Detalhes da subscrição.
Other Status Codes	ErrorResponseBody	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

GetAlias

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
    }
  }
}

Definições

Name	Description
AcceptOwnership	O estado de aceitação da propriedade do recurso.
createdByType	O tipo de identidade que criou o recurso.
ErrorResponse	Descreve o formato de Resposta a erros.
ErrorResponseBody	A resposta a erros indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.
ProvisioningState	O estado de aprovisionamento do recurso.
SubscriptionAliasResponse	Informações da Subscrição com o alias.
SubscriptionAliasResponseProperties	Coloque as propriedades do resultado da criação da subscrição.
systemData	Metadados relativos à criação e última modificação do recurso.
workload	O tipo de carga de trabalho da subscrição. Pode ser Produção ou DevTest.

AcceptOwnership

O estado de aceitação da propriedade do recurso.

Name	Tipo	Description
Completed	string
Expired	string
Pending	string

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

Descreve o formato de Resposta a erros.

Name	Tipo	Description
code	string	Código de erro
message	string	Mensagem de erro a indicar por que motivo a operação falhou.

ErrorResponseBody

A resposta a erros indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Name	Tipo	Description
code	string	Código de erro
error	ErrorResponse	Os detalhes do erro.
message	string	Mensagem de erro a indicar por que motivo a operação falhou.

ProvisioningState

O estado de aprovisionamento do recurso.

Name	Tipo	Description
Accepted	string
Pending	string
Succeeded	string

SubscriptionAliasResponse

Informações da Subscrição com o alias.

Name	Tipo	Description
id	string	ID completamente qualificado para o recurso de alias.
name	string	ID do Alias.
properties	SubscriptionAliasResponseProperties	Propriedades de resposta do Alias da Subscrição.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
type	string	Tipo de recurso, Microsoft.Subscription/aliases.

SubscriptionAliasResponseProperties

Coloque as propriedades do resultado da criação da subscrição.

Name	Tipo	Description
acceptOwnershipState	AcceptOwnership	O estado de aceitação da propriedade do recurso.
acceptOwnershipUrl	string	Url para aceitar a propriedade da subscrição.
billingScope	string	Âmbito de faturação da subscrição. Para CustomerLed e FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	Hora de Criação
displayName	string	O nome a apresentar da subscrição.
managementGroupId	string	O ID do Grupo de Gestão.
provisioningState	ProvisioningState	O estado de aprovisionamento do recurso.
resellerId	string	ID do Revendedor
subscriptionId	string	ID de subscrição recentemente criado.
subscriptionOwnerId	string	ID do Proprietário da subscrição
tags	object	Etiquetas para a subscrição
workload	workload	O tipo de carga de trabalho da subscrição. Pode ser Produção ou DevTest.

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

workload

O tipo de carga de trabalho da subscrição. Pode ser Produção ou DevTest.

Name	Tipo	Description
DevTest	string
Production	string

Partilhar via

Alias - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

GetAlias

Pedido de amostra

Resposta da amostra

Definições

AcceptOwnership

createdByType

ErrorResponse

ErrorResponseBody

ProvisioningState

SubscriptionAliasResponse

SubscriptionAliasResponseProperties

systemData

workload

Recursos adicionais