Enrollment Accounts - List By Department

Szolgáltatás:

Billing

API-verzió:

2024-04-01

Egy részleg regisztrációs fiókjait sorolja fel. A művelet csak nagyvállalati szerződés típusú számlázási fiókok esetében támogatott.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts?api-version=2024-04-01

Opcionális paraméterekkel:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/enrollmentAccounts?api-version=2024-04-01&filter={filter}&orderBy={orderBy}&top={top}&skip={skip}&count={count}&search={search}

URI-paraméterek

Name	In	Kötelező	Típus	Description
billingAccountName	path	True	string pattern: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	A számlázási fiókot egyedileg azonosító azonosító.
departmentName	path	True	string pattern: ^[a-zA-Z\d-_]{1,128}$	A részleg neve.
api-version	query	True	string	Az ügyfélkéréshez használni kívánt API verziója. A jelenlegi verzió: 2024-04-01.
count	query		boolean	A számláló lekérdezési lehetőség lehetővé teszi az ügyfelek számára, hogy a válaszban szereplő erőforrásokhoz tartozó egyező erőforrások számát kérvényezik.
filter	query		string	A szűrő lekérdezési lehetőség lehetővé teszi, hogy az ügyfelek szűrjenek egy kérelem URL-címével kezelt erőforrások gyűjteményét.
orderBy	query		string	Az orderby lekérdezési lehetőség lehetővé teszi, hogy az ügyfelek egy adott sorrendben igényeljenek erőforrásokat.
search	query		string	A keresési lekérdezési lehetőség lehetővé teszi, hogy az ügyfelek egy szabad szöveges keresési kifejezésnek megfelelő gyűjteményben lévő elemeket kérjenek le. a keresés csak sztringmezők esetén támogatott.
skip	query		integer (int64)	A kihagyó lekérdezési beállítás a lekérdezett gyűjtemény azon elemeinek számát kéri, amelyeket ki kell hagyni, és nem kell belefoglalni az eredménybe.
top	query		integer (int64)	A legfelső lekérdezési beállítás kéri, hogy a lekérdezett gyűjtemény elemeinek száma szerepeljen az eredményben. A felső érték maximális támogatott értéke 50.

Válaszok

Name	Típus	Description
200 OK	EnrollmentAccountListResult	OKÉ. A kérés sikeres volt.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Példák

EnrollmentAccountsListByDepartment

Mintakérelem

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts?api-version=2024-04-01

Java

/**
 * Samples for EnrollmentAccounts ListByDepartment.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * enrollmentAccountsListByDepartment.json
     */
    /**
     * Sample code: EnrollmentAccountsListByDepartment.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void enrollmentAccountsListByDepartment(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.enrollmentAccounts().listByDepartment("6564892", "164821", null, null, null, null, null, null,
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python enrollment_accounts_list_by_department.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 = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.enrollment_accounts.list_by_department(
        billing_account_name="6564892",
        department_name="164821",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.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

Go

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json
func ExampleEnrollmentAccountsClient_NewListByDepartmentPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewEnrollmentAccountsClient().NewListByDepartmentPager("6564892", "164821", &armbilling.EnrollmentAccountsClientListByDepartmentOptions{Filter: nil,
		OrderBy: nil,
		Top:     nil,
		Skip:    nil,
		Count:   nil,
		Search:  nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.EnrollmentAccountListResult = armbilling.EnrollmentAccountListResult{
		// 	Value: []*armbilling.EnrollmentAccount{
		// 		{
		// 			Name: to.Ptr("257698"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/departments/enrollmentAccounts"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698"),
		// 			Properties: &armbilling.EnrollmentAccountProperties{
		// 				AccountOwner: to.Ptr("account0@contoso.com"),
		// 				AuthType: to.Ptr("MicrosoftAccount"),
		// 				CostCenter: to.Ptr("C0"),
		// 				DepartmentDisplayName: to.Ptr("TestDept"),
		// 				DepartmentID: to.Ptr("164821"),
		// 				DisplayName: to.Ptr("AccountName0"),
		// 				EndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-05-31T17:32:28.000Z"); return t}()),
		// 				IsDevTestEnabled: to.Ptr(true),
		// 				StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T17:32:28.000Z"); return t}()),
		// 				Status: to.Ptr("Active"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("264698"),
		// 			Type: to.Ptr("Microsoft.Billing/billingAccounts/departments/enrollmentAccounts"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/264698"),
		// 			Properties: &armbilling.EnrollmentAccountProperties{
		// 				AccountOwner: to.Ptr("account1@contoso.com"),
		// 				AuthType: to.Ptr("Organization"),
		// 				CostCenter: to.Ptr("C1"),
		// 				DepartmentDisplayName: to.Ptr("TestDept"),
		// 				DepartmentID: to.Ptr("164821"),
		// 				DisplayName: to.Ptr("AccountName1"),
		// 				EndDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-05-31T17:32:28.000Z"); return t}()),
		// 				IsDevTestEnabled: to.Ptr(false),
		// 				StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-05-01T17:32:28.000Z"); return t}()),
		// 				Status: to.Ptr("Active"),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
 *
 * @summary Lists the enrollment accounts for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json
 */
async function enrollmentAccountsListByDepartment() {
  const billingAccountName = "6564892";
  const departmentName = "164821";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.enrollmentAccounts.listByDepartment(
    billingAccountName,
    departmentName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

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

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/enrollmentAccountsListByDepartment.json
// this example is just showing the usage of "EnrollmentAccounts_ListByDepartment" 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 BillingDepartmentResource created on azure
// for more information of creating BillingDepartmentResource, please refer to the document of BillingDepartmentResource
string billingAccountName = "6564892";
string departmentName = "164821";
ResourceIdentifier billingDepartmentResourceId = BillingDepartmentResource.CreateResourceIdentifier(billingAccountName, departmentName);
BillingDepartmentResource billingDepartment = client.GetBillingDepartmentResource(billingDepartmentResourceId);

// get the collection of this BillingDepartmentEnrollmentAccountResource
BillingDepartmentEnrollmentAccountCollection collection = billingDepartment.GetBillingDepartmentEnrollmentAccounts();

// invoke the operation and iterate over the result
BillingDepartmentEnrollmentAccountCollectionGetAllOptions options = new BillingDepartmentEnrollmentAccountCollectionGetAllOptions();
await foreach (BillingDepartmentEnrollmentAccountResource item in collection.GetAllAsync(options))
{
    // 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
    BillingEnrollmentAccountData 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

Mintaválasz

Állapotkód:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/257698",
      "name": "257698",
      "properties": {
        "costCenter": "C0",
        "displayName": "AccountName0",
        "departmentDisplayName": "TestDept",
        "departmentId": "164821",
        "isDevTestEnabled": true,
        "accountOwner": "account0@contoso.com",
        "authType": "MicrosoftAccount",
        "status": "Active",
        "startDate": "2018-05-01T17:32:28Z",
        "endDate": "2019-05-31T17:32:28Z"
      },
      "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts"
    },
    {
      "id": "/providers/Microsoft.Billing/billingAccounts/6564892/departments/164821/enrollmentAccounts/264698",
      "name": "264698",
      "properties": {
        "costCenter": "C1",
        "displayName": "AccountName1",
        "departmentDisplayName": "TestDept",
        "departmentId": "164821",
        "isDevTestEnabled": false,
        "accountOwner": "account1@contoso.com",
        "authType": "Organization",
        "status": "Active",
        "startDate": "2018-05-01T17:32:28Z",
        "endDate": "2019-05-31T17:32:28Z"
      },
      "type": "Microsoft.Billing/billingAccounts/departments/enrollmentAccounts"
    }
  ]
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
EnrollmentAccount	Ez egy számlázási fiókon belüli szervezeti hierarchia az Azure-költségek felügyeletéhez és kezeléséhez.
EnrollmentAccountListResult	Tároló az erőforrások listájához
EnrollmentAccountProperties	Ez egy számlázási fiókon belüli szervezeti hierarchia az Azure-költségek felügyeletéhez és kezeléséhez.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
Application
Key
ManagedIdentity
User

EnrollmentAccount

Objektum

Ez egy számlázási fiókon belüli szervezeti hierarchia az Azure-költségek felügyeletéhez és kezeléséhez.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties	EnrollmentAccountProperties	Ez egy számlázási fiókon belüli szervezeti hierarchia az Azure-költségek felügyeletéhez és kezeléséhez.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Az erőforráshoz társított metaadatok szótára. Lehet, hogy nem minden erőforrástípushoz van feltöltve. Legfeljebb 256 karakter hosszúságú kulcs/érték. A kulcsok/értékek nem üresek és nem lehet nullak. A kulcsok nem tartalmazhatnak <> % & \ ? /
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

EnrollmentAccountListResult

Objektum

Tároló az erőforrások listájához

Name	Típus	Description
nextLink	string	Az eredmények következő oldalára mutató hivatkozás (URL- cím).
value	EnrollmentAccount[]	Az erőforrások listája.

EnrollmentAccountProperties

Objektum

Ez egy számlázási fiókon belüli szervezeti hierarchia az Azure-költségek felügyeletéhez és kezeléséhez.

Name	Típus	Description
accountOwner	string	A regisztrációs fiók tulajdonosa.
authType	string	A regisztrációs fiók engedélyezési típusa.
costCenter	string	A regisztrációs fiókhoz társított költséghely.
departmentDisplayName	string	Annak a részlegnek a neve, amelyben a regisztrációs fiók létezik.
departmentId	string	A részleget egyedileg azonosító azonosító.
displayName	string	A regisztrációs fiók neve.
endDate	string (date-time)	A regisztrációs fiók lejáratának dátuma.
isDevTestEnabled	boolean	Logikai jelző, amely lehetővé teszi az előfizetők számára a fejlesztési és tesztelési számítási feladatok futtatását az Azure-ban speciális fejlesztői/tesztelési díjszabás mellett.
startDate	string (date-time)	A regisztrációs fiók érvényességének és működésének dátuma.
status	string	A regisztrációs fiók állapota.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.