Alias - List

Reference

Služba:: Subscription

Verze rozhraní API:: 2021-10-01

Vypište odběr aliasů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 1.10.2021

Odpovědi

Name	Typ	Description
200 OK	SubscriptionAliasListResult	Podrobnosti o předplatném.
Other Status Codes	ErrorResponseBody	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ListAlias

Ukázkový požadavek

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://video2.skills-academy.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

Ukázková odpověď

Stavový kód:: 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
}

Definice

Name	Description
AcceptOwnership	Stav přijetí vlastnictví prostředku.
createdByType	Typ identity, která vytvořila prostředek.
ErrorResponse	Popisuje formát chybové odpovědi.
ErrorResponseBody	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.
ProvisioningState	Stav zřizování prostředku.
SubscriptionAliasListResult	Seznam aliasů.
SubscriptionAliasResponse	Informace o předplatném s aliasem
SubscriptionAliasResponseProperties	Vložte vlastnosti výsledku vytvoření předplatného.
systemData	Metadata týkající se vytvoření a poslední změny prostředku
workload	Typ úlohy předplatného. Může to být buď Produkční, nebo DevTest.

AcceptOwnership

Stav přijetí vlastnictví prostředku.

Name	Typ	Description
Completed	string
Expired	string
Pending	string

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

Popisuje formát chybové odpovědi.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponseBody

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Name	Typ	Description
code	string	Kód chyby
error	ErrorResponse	Podrobnosti o chybě.
message	string	Chybová zpráva označující, proč operace selhala.

ProvisioningState

Stav zřizování prostředku.

Name	Typ	Description
Accepted	string
Pending	string
Succeeded	string

SubscriptionAliasListResult

Seznam aliasů.

Name	Typ	Description
nextLink	string	Odkaz (url) na další stránku výsledků.
value	SubscriptionAliasResponse[]	Seznam aliasů.

SubscriptionAliasResponse

Informace o předplatném s aliasem

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku aliasu
name	string	ID aliasu.
properties	SubscriptionAliasResponseProperties	Vlastnosti odpovědi aliasu předplatného
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku
type	string	Typ prostředku: Microsoft.Subscription/aliases.

SubscriptionAliasResponseProperties

Vložte vlastnosti výsledku vytvoření předplatného.

Name	Typ	Description
acceptOwnershipState	AcceptOwnership	Stav přijetí vlastnictví prostředku.
acceptOwnershipUrl	string	Adresa URL pro přijetí vlastnictví předplatného
billingScope	string	Rozsah fakturace předplatného. Pro CustomerLed a FieldLed – /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} Pro PartnerLed – /billingAccounts/{billingAccountName}/customers/{customerName} pro starší verzi EA – /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}
createdTime	string	Čas vytvoření
displayName	string	Zobrazovaný název předplatného.
managementGroupId	string	ID skupiny pro správu.
provisioningState	ProvisioningState	Stav zřizování prostředku.
resellerId	string	ID prodejce
subscriptionId	string	Id nově vytvořeného předplatného
subscriptionOwnerId	string	ID vlastníka předplatného
tags	object	Značky pro předplatné
workload	workload	Typ úlohy předplatného. Může to být buď Produkční, nebo DevTest.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

workload

Typ úlohy předplatného. Může to být buď Produkční, nebo DevTest.

Name	Typ	Description
DevTest	string
Production	string

Sdílet prostřednictvím

Alias - List

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ListAlias

Ukázkový požadavek

Ukázková odpověď

Definice

AcceptOwnership

createdByType

ErrorResponse

ErrorResponseBody

ProvisioningState

SubscriptionAliasListResult

SubscriptionAliasResponse

SubscriptionAliasResponseProperties

systemData

workload

Další materiály