Billing Containers - List By Subscription

Service:

Device Registry

API Version:

2024-11-01

List BillingContainer resources by subscription ID

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/billingContainers?api-version=2024-11-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	BillingContainerListResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List_BillingContainers_Subscription

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DeviceRegistry/billingContainers?api-version=2024-11-01

Java

/**
 * Samples for BillingContainers List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2024-11-01/List_BillingContainers_Subscription.json
     */
    /**
     * Sample code: List_BillingContainers_Subscription.
     * 
     * @param manager Entry point to DeviceRegistryManager.
     */
    public static void
        listBillingContainersSubscription(com.azure.resourcemanager.deviceregistry.DeviceRegistryManager manager) {
        manager.billingContainers().list(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.deviceregistry import DeviceRegistryMgmtClient

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

    response = client.billing_containers.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: 2024-11-01/List_BillingContainers_Subscription.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 armdeviceregistry_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/deviceregistry/armdeviceregistry"
)

// Generated from example definition: 2024-11-01/List_BillingContainers_Subscription.json
func ExampleBillingContainersClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdeviceregistry.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewBillingContainersClient().NewListBySubscriptionPager(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 = armdeviceregistry.BillingContainersClientListBySubscriptionResponse{
		// 	BillingContainerListResult: armdeviceregistry.BillingContainerListResult{
		// 		Value: []*armdeviceregistry.BillingContainer{
		// 			{
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DeviceRegistry/billingContainers/my-billingContainer1"),
		// 				Name: to.Ptr("my-billingContainer1"),
		// 				Type: to.Ptr("Microsoft.DeviceRegistry/billingcontainers"),
		// 				Etag: to.Ptr("\"4b036688-0000-0100-0000-6632c7bf0000\""),
		// 				SystemData: &armdeviceregistry.SystemData{
		// 					CreatedBy: to.Ptr("0e1b4448-67b9-46a1-8158-e3dade4c008e"),
		// 					CreatedByType: to.Ptr(armdeviceregistry.CreatedByTypeApplication),
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-05-01T22:52:46.0165055Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("0e1b4448-67b9-46a1-8158-e3dade4c008e"),
		// 					LastModifiedByType: to.Ptr(armdeviceregistry.CreatedByTypeApplication),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-05-01T22:52:46.0165055Z"); return t}()),
		// 				},
		// 				Properties: &armdeviceregistry.BillingContainerProperties{
		// 					ProvisioningState: to.Ptr(armdeviceregistry.ProvisioningStateSucceeded),
		// 				},
		// 			},
		// 			{
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DeviceRegistry/billingContainers/my-billingContainer2"),
		// 				Name: to.Ptr("my-billingContainer2"),
		// 				Type: to.Ptr("Microsoft.DeviceRegistry/billingcontainers"),
		// 				Etag: to.Ptr("\"4e03ed61-0000-0100-0000-6632d7200000\""),
		// 				SystemData: &armdeviceregistry.SystemData{
		// 					CreatedBy: to.Ptr("0e1b4448-67b9-46a1-8158-e3dade4c008e"),
		// 					CreatedByType: to.Ptr(armdeviceregistry.CreatedByTypeApplication),
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-05-01T23:58:23.3213061Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("0e1b4448-67b9-46a1-8158-e3dade4c008e"),
		// 					LastModifiedByType: to.Ptr(armdeviceregistry.CreatedByTypeApplication),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-05-01T23:58:23.3213061Z"); return t}()),
		// 				},
		// 				Properties: &armdeviceregistry.BillingContainerProperties{
		// 					ProvisioningState: to.Ptr(armdeviceregistry.ProvisioningStateSucceeded),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

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 { DeviceRegistryManagementClient } = require("@azure/arm-deviceregistry");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list BillingContainer resources by subscription ID
 *
 * @summary list BillingContainer resources by subscription ID
 * x-ms-original-file: 2024-11-01/List_BillingContainers_Subscription.json
 */
async function listBillingContainersSubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new DeviceRegistryManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.billingContainers.listBySubscription()) {
    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.Resources;
using Azure.ResourceManager.DeviceRegistry;

// Generated from example definition: 2024-11-01/List_BillingContainers_Subscription.json
// this example is just showing the usage of "BillingContainer_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this DeviceRegistryBillingContainerResource
DeviceRegistryBillingContainerCollection collection = subscriptionResource.GetDeviceRegistryBillingContainers();

// invoke the operation and iterate over the result
await foreach (DeviceRegistryBillingContainerResource 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
    DeviceRegistryBillingContainerData 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

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DeviceRegistry/billingContainers/my-billingContainer1",
      "name": "my-billingContainer1",
      "type": "Microsoft.DeviceRegistry/billingcontainers",
      "etag": "\"4b036688-0000-0100-0000-6632c7bf0000\"",
      "systemData": {
        "createdBy": "0e1b4448-67b9-46a1-8158-e3dade4c008e",
        "createdByType": "Application",
        "createdAt": "2024-05-01T22:52:46.0165055Z",
        "lastModifiedBy": "0e1b4448-67b9-46a1-8158-e3dade4c008e",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2024-05-01T22:52:46.0165055Z"
      },
      "properties": {
        "provisioningState": "Succeeded"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DeviceRegistry/billingContainers/my-billingContainer2",
      "name": "my-billingContainer2",
      "type": "Microsoft.DeviceRegistry/billingcontainers",
      "etag": "\"4e03ed61-0000-0100-0000-6632d7200000\"",
      "systemData": {
        "createdBy": "0e1b4448-67b9-46a1-8158-e3dade4c008e",
        "createdByType": "Application",
        "createdAt": "2024-05-01T23:58:23.3213061Z",
        "lastModifiedBy": "0e1b4448-67b9-46a1-8158-e3dade4c008e",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2024-05-01T23:58:23.3213061Z"
      },
      "properties": {
        "provisioningState": "Succeeded"
      }
    }
  ]
}

Definitions

Name	Description
BillingContainer	billingContainer Model as Azure resource whose sole purpose is to keep track of billables resources under a subscription.
BillingContainerListResult	The response of a BillingContainer list operation.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ProvisioningState	The provisioning status of the resource.
systemData	Metadata pertaining to creation and last modification of the resource.

BillingContainer

Object

billingContainer Model as Azure resource whose sole purpose is to keep track of billables resources under a subscription.

Name	Type	Description
etag	string	Resource ETag
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BillingContainerListResult

Object

The response of a BillingContainer list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	BillingContainer[]	The BillingContainer items on this page

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ProvisioningState

Enumeration

The provisioning status of the resource.

Value	Description
Succeeded	Resource has been created.
Failed	Resource creation failed.
Canceled	Resource creation was canceled.
Accepted	Resource has been accepted by the server.
Deleting	Resource is deleting.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.