Alias - List

Referência

Serviço:: Subscription

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

Listar Assinatura do Alias.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente. A versão atual é 2021-10-01

Respostas

Nome	Tipo	Description
200 OK	SubscriptionAliasListResult	Detalhes da assinatura.
Other Status Codes	ErrorResponseBody	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ListAlias

Solicitação de exemplo

GET https://management.azure.com/providers/Microsoft.Subscription/aliases?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 list_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.list()
    print(response)


# x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/listAlias.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/listAlias.json
func ExampleAliasClient_List() {
	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().List(ctx, 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.AliasListResult = armsubscription.AliasListResult{
	// 	Value: []*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),
	// 			},
	// 		},
	// 		{
	// 			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/091c6e56-a835-4422-a082-0427308ca9ee/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 2"),
	// 				ProvisioningState: to.Ptr(armsubscription.ProvisioningStateSucceeded),
	// 				SubscriptionID: to.Ptr("091c6e56-a835-4422-a082-0427308ca9ee"),
	// 				SubscriptionOwnerID: to.Ptr("f09b39eb-c496-482c-9ab9-afd799572f4c"),
	// 				Tags: map[string]*string{
	// 					"tag1": to.Ptr("Messi2"),
	// 					"tag2": to.Ptr("Ronaldo2"),
	// 					"tag3": to.Ptr("Lebron2"),
	// 				},
	// 				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 List Alias Subscription.
 *
 * @summary List Alias Subscription.
 * x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2021-10-01/examples/listAlias.json
 */
async function listAlias() {
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const result = await client.alias.list();
  console.log(result);
}

listAlias().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/listAlias.json
// this example is just showing the usage of "Alias_List" 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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this SubscriptionAliasResource
SubscriptionAliasCollection collection = tenantResource.GetSubscriptionAliases();

// invoke the operation and iterate over the result
await foreach (SubscriptionAliasResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "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"
        }
      }
    },
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "properties": {
        "subscriptionId": "091c6e56-a835-4422-a082-0427308ca9ee",
        "displayName": "Test Subscription 2",
        "provisioningState": "Accepted",
        "acceptOwnershipUrl": "/providers/Microsoft.Subscription/091c6e56-a835-4422-a082-0427308ca9ee/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": "Messi2",
          "tag2": "Ronaldo2",
          "tag3": "Lebron2"
        }
      }
    }
  ],
  "nextLink": null
}

Definições

Nome	Description
AcceptOwnership	O estado de aceitação de propriedade do recurso.
createdByType	O tipo de identidade que criou o recurso.
ErrorResponse	Descreve o formato da resposta de erro.
ErrorResponseBody	A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
ProvisioningState	O estado de provisionamento do recurso.
SubscriptionAliasListResult	A lista de aliases.
SubscriptionAliasResponse	Informações de assinatura com o alias.
SubscriptionAliasResponseProperties	Coloque as propriedades de resultado da criação da assinatura.
systemData	Metadados relativos à criação e à última modificação do recurso.
workload	O tipo de carga de trabalho da assinatura. Pode ser Produção ou DevTest.

AcceptOwnership

Enumeration

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

Valor	Description
Completed
Expired
Pending

createdByType

Enumeration

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorResponse

Object

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponseBody

Object

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

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

ProvisioningState

Enumeration

O estado de provisionamento do recurso.

Valor	Description
Accepted
Pending
Succeeded

SubscriptionAliasListResult

Object

A lista de aliases.

Nome	Tipo	Description
nextLink	string	O link (url) para a próxima página de resultados.
value	SubscriptionAliasResponse[]	A lista de alias.

SubscriptionAliasResponse

Object

Informações de assinatura com o alias.

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

SubscriptionAliasResponseProperties

Object

Coloque as propriedades de resultado da criação da assinatura.

Nome	Tipo	Description
acceptOwnershipState	AcceptOwnership	O estado de aceitação de propriedade do recurso.
acceptOwnershipUrl	string	Url para aceitar a propriedade da assinatura.
billingScope	string	Escopo de cobrança da assinatura. 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 de exibição da assinatura.
managementGroupId	string	A ID do Grupo de Gerenciamento.
provisioningState	ProvisioningState	O estado de provisionamento do recurso.
resellerId	string	ID do revendedor
subscriptionId	string	ID de assinatura recém-criada.
subscriptionOwnerId	string	ID do proprietário da assinatura
tags	object	Marcas para a assinatura
workload	workload	O tipo de carga de trabalho da assinatura. Pode ser Produção ou DevTest.

systemData

Object

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

Nome	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

Enumeration

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

Valor	Description
DevTest
Production

Compartilhar via

Alias - List

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ListAlias

Solicitação de exemplo

Resposta de exemplo

Definições

AcceptOwnership

createdByType

ErrorResponse

ErrorResponseBody

ProvisioningState

SubscriptionAliasListResult

SubscriptionAliasResponse

SubscriptionAliasResponseProperties

systemData

workload

Recursos adicionais