Billing Requests - List By User

Service:

Billing

API Version:

2024-04-01

The list of billing requests submitted by a user.

GET https://management.azure.com/providers/Microsoft.Billing/billingRequests?api-version=2024-04-01

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2024-04-01.
count	query		boolean	The count query option allows clients to request a count of the matching resources included with the resources in the response.
filter	query		string	The filter query option allows clients to filter a collection of resources that are addressed by a request URL.
orderBy	query		string	The orderby query option allows clients to request resources in a particular order.
search	query		string	The search query option allows clients to request items within a collection matching a free-text search expression. search is only supported for string fields.
skip	query		integer (int64)	The skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.
top	query		integer (int64)	The top query option requests the number of items in the queried collection to be included in the result. The maximum supported value for top is 50.

Responses

Name	Type	Description
200 OK	BillingRequestListResult	The list of billing requests.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

BillingRequestsListByUser

BillingRequestsListByUserWithFilter

BillingRequestsListByUser

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingRequests?api-version=2024-04-01

Java

/**
 * Samples for BillingRequests ListByUser.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUser.
     * json
     */
    /**
     * Sample code: BillingRequestsListByUser.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void billingRequestsListByUser(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRequests().listByUser(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 billing_requests_list_by_user.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.billing_requests.list_by_user()
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUser.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/billingRequestsListByUser.json
func ExampleRequestsClient_NewListByUserPager_billingRequestsListByUser() {
	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.NewRequestsClient().NewListByUserPager(&armbilling.RequestsClientListByUserOptions{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.RequestListResult = armbilling.RequestListResult{
		// 	Value: []*armbilling.Request{
		// 		{
		// 			Name: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 			Type: to.Ptr("Microsoft.Billing/billingRequests"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000"),
		// 			Properties: &armbilling.RequestProperties{
		// 				Type: to.Ptr(armbilling.BillingRequestTypeRoleAssignment),
		// 				AdditionalInformation: map[string]*string{
		// 					"RoleId": to.Ptr("40000000-aaaa-bbbb-cccc-200000000006"),
		// 				},
		// 				BillingAccountDisplayName: to.Ptr("Contoso"),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingAccountName: to.Ptr("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingProfileDisplayName: to.Ptr("Contoso Operations Billing"),
		// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 				BillingProfileName: to.Ptr("xxxx-xxxx-xxx-xxx"),
		// 				CreatedBy: &armbilling.RequestPropertiesCreatedBy{
		// 					Upn: to.Ptr("foo@contoso.com"),
		// 				},
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-01T17:32:28.000Z"); return t}()),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-04-15T17:32:28.000Z"); return t}()),
		// 				LastUpdatedBy: &armbilling.RequestPropertiesLastUpdatedBy{
		// 					Upn: to.Ptr("foo@contoso.com"),
		// 				},
		// 				LastUpdatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-01T17:32:28.000Z"); return t}()),
		// 				RequestScope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
		// 				Status: to.Ptr(armbilling.BillingRequestStatusPending),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("11111111-1111-1111-1111-111111111111"),
		// 			Type: to.Ptr("Microsoft.Billing/billingRequests"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111"),
		// 			Properties: &armbilling.RequestProperties{
		// 				Type: to.Ptr(armbilling.BillingRequestTypeProvisioningAccess),
		// 				BillingAccountDisplayName: to.Ptr("Contoso"),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingAccountName: to.Ptr("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				CreatedBy: &armbilling.RequestPropertiesCreatedBy{
		// 					Upn: to.Ptr("foo@contoso.com"),
		// 				},
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-01T17:32:28.000Z"); return t}()),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-15T17:32:28.000Z"); return t}()),
		// 				LastUpdatedBy: &armbilling.RequestPropertiesLastUpdatedBy{
		// 					Upn: to.Ptr("admin@contosofinance.com"),
		// 				},
		// 				LastUpdatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-02T17:32:28.000Z"); return t}()),
		// 				RequestScope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000"),
		// 				ReviewalDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-02T17:32:28.000Z"); return t}()),
		// 				ReviewedBy: &armbilling.RequestPropertiesReviewedBy{
		// 					Upn: to.Ptr("admin@contosofinance.com"),
		// 				},
		// 				Status: to.Ptr(armbilling.BillingRequestStatusApproved),
		// 			},
		// 	}},
		// }
	}
}

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 The list of billing requests submitted by a user.
 *
 * @summary The list of billing requests submitted by a user.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUser.json
 */
async function billingRequestsListByUser() {
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.billingRequests.listByUser()) {
    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.Resources;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUser.json
// this example is just showing the usage of "BillingRequests_ListByUser" 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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this BillingRequestResource
BillingRequestCollection collection = tenantResource.GetBillingRequests();

// invoke the operation and iterate over the result
BillingRequestCollectionGetAllOptions options = new BillingRequestCollectionGetAllOptions();
await foreach (BillingRequestResource 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
    BillingRequestData 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": "/providers/Microsoft.Billing/billingRequests/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "properties": {
        "additionalInformation": {
          "RoleId": "40000000-aaaa-bbbb-cccc-200000000006"
        },
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingAccountDisplayName": "Contoso",
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "billingProfileName": "xxxx-xxxx-xxx-xxx",
        "billingProfileDisplayName": "Contoso Operations Billing",
        "createdBy": {
          "upn": "foo@contoso.com"
        },
        "creationDate": "2024-04-01T17:32:28Z",
        "expirationDate": "2023-04-15T17:32:28Z",
        "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "status": "Pending",
        "type": "RoleAssignment",
        "lastUpdatedBy": {
          "upn": "foo@contoso.com"
        },
        "lastUpdatedDate": "2024-04-01T17:32:28Z"
      },
      "type": "Microsoft.Billing/billingRequests"
    },
    {
      "id": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111",
      "name": "11111111-1111-1111-1111-111111111111",
      "properties": {
        "reviewedBy": {
          "upn": "admin@contosofinance.com"
        },
        "reviewalDate": "2023-03-02T17:32:28Z",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingAccountDisplayName": "Contoso",
        "createdBy": {
          "upn": "foo@contoso.com"
        },
        "creationDate": "2023-03-01T17:32:28Z",
        "expirationDate": "2023-03-15T17:32:28Z",
        "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000",
        "status": "Approved",
        "type": "ProvisioningAccess",
        "lastUpdatedBy": {
          "upn": "admin@contosofinance.com"
        },
        "lastUpdatedDate": "2023-03-02T17:32:28Z"
      },
      "type": "Microsoft.Billing/billingRequests"
    }
  ]
}

BillingRequestsListByUserWithFilter

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingRequests?api-version=2024-04-01&filter=properties/status eq 'Approved'

Java

/**
 * Samples for BillingRequests ListByUser.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * billingRequestsListByUserWithFilter.json
     */
    /**
     * Sample code: BillingRequestsListByUserWithFilter.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void billingRequestsListByUserWithFilter(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingRequests().listByUser("properties/status eq 'Approved'", 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 billing_requests_list_by_user_with_filter.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.billing_requests.list_by_user()
    for item in response:
        print(item)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.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/azcore/to"
	"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/billingRequestsListByUserWithFilter.json
func ExampleRequestsClient_NewListByUserPager_billingRequestsListByUserWithFilter() {
	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.NewRequestsClient().NewListByUserPager(&armbilling.RequestsClientListByUserOptions{Filter: to.Ptr("properties/status eq 'Approved'"),
		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.RequestListResult = armbilling.RequestListResult{
		// 	Value: []*armbilling.Request{
		// 		{
		// 			Name: to.Ptr("11111111-1111-1111-1111-111111111111"),
		// 			Type: to.Ptr("Microsoft.Billing/billingRequests"),
		// 			ID: to.Ptr("/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111"),
		// 			Properties: &armbilling.RequestProperties{
		// 				Type: to.Ptr(armbilling.BillingRequestTypeProvisioningAccess),
		// 				BillingAccountDisplayName: to.Ptr("Contoso"),
		// 				BillingAccountID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				BillingAccountName: to.Ptr("00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
		// 				CreatedBy: &armbilling.RequestPropertiesCreatedBy{
		// 					Upn: to.Ptr("foo@contoso.com"),
		// 				},
		// 				CreationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-01T17:32:28.000Z"); return t}()),
		// 				ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-15T17:32:28.000Z"); return t}()),
		// 				LastUpdatedBy: &armbilling.RequestPropertiesLastUpdatedBy{
		// 					Upn: to.Ptr("admin@contosofinance.com"),
		// 				},
		// 				LastUpdatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-02T17:32:28.000Z"); return t}()),
		// 				RequestScope: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000"),
		// 				ReviewalDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-03-02T17:32:28.000Z"); return t}()),
		// 				ReviewedBy: &armbilling.RequestPropertiesReviewedBy{
		// 					Upn: to.Ptr("admin@contosofinance.com"),
		// 				},
		// 				Status: to.Ptr(armbilling.BillingRequestStatusApproved),
		// 			},
		// 	}},
		// }
	}
}

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 The list of billing requests submitted by a user.
 *
 * @summary The list of billing requests submitted by a user.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json
 */
async function billingRequestsListByUserWithFilter() {
  const filter = "properties/status eq 'Approved'";
  const options = { filter };
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const resArray = new Array();
  for await (let item of client.billingRequests.listByUser(options)) {
    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.Resources;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingRequestsListByUserWithFilter.json
// this example is just showing the usage of "BillingRequests_ListByUser" 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);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this BillingRequestResource
BillingRequestCollection collection = tenantResource.GetBillingRequests();

// invoke the operation and iterate over the result
BillingRequestCollectionGetAllOptions options = new BillingRequestCollectionGetAllOptions { Filter = "properties/status eq 'Approved'" };
await foreach (BillingRequestResource 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
    BillingRequestData 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": "/providers/Microsoft.Billing/billingRequests/11111111-1111-1111-1111-111111111111",
      "name": "11111111-1111-1111-1111-111111111111",
      "properties": {
        "reviewedBy": {
          "upn": "admin@contosofinance.com"
        },
        "reviewalDate": "2023-03-02T17:32:28Z",
        "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingAccountName": "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        "billingAccountDisplayName": "Contoso",
        "createdBy": {
          "upn": "foo@contoso.com"
        },
        "creationDate": "2023-03-01T17:32:28Z",
        "expirationDate": "2023-03-15T17:32:28Z",
        "requestScope": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/associatedTenants/100000000-0000-0000-0000-00000000",
        "status": "Approved",
        "type": "ProvisioningAccess",
        "lastUpdatedBy": {
          "upn": "admin@contosofinance.com"
        },
        "lastUpdatedDate": "2023-03-02T17:32:28Z"
      },
      "type": "Microsoft.Billing/billingRequests"
    }
  ]
}

Definitions

Name	Description
BillingRequest	A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.
BillingRequestListResult	A container for a list of resources
BillingRequestProperties	A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.
BillingRequestStatus	Status of billing request.
BillingRequestType	Type of billing request.
CreatedBy	The principal of the entity who created the request.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
LastUpdatedBy	The principal of the entity who last updated the request.
Principal	A principal who has interacted with a billing entity.
ProvisioningState	The provisioning state of the resource during a long-running operation.
ReviewedBy	The principal of the request reviewer. Will only be set if request is approved.
systemData	Metadata pertaining to creation and last modification of the resource.

BillingRequest

Object

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.

Name	Type	Description
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	BillingRequestProperties	A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

BillingRequestListResult

Object

A container for a list of resources

Name	Type	Description
nextLink	string	The link (url) to the next page of results.
value	BillingRequest[]	The list of resources.

BillingRequestProperties

Object

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.

Name	Type	Description
additionalInformation	object	Additional information for the billing request.
billingAccountDisplayName	string	The name of the billing account.
billingAccountId	string	The fully qualified ID that uniquely identifies a billing account.
billingAccountName	string	The ID that uniquely identifies a billing account.
billingAccountPrimaryBillingTenantId	string	The primary tenant ID of the billing account for which the billing request was submitted.
billingProfileDisplayName	string	The name of the billing profile.
billingProfileId	string	The fully qualified ID that uniquely identifies a billing profile.
billingProfileName	string	The ID that uniquely identifies a billing profile.
billingScope	string	The billing scope for which the request will be applied. This is a read only property derived by the service.
createdBy	CreatedBy	The principal of the entity who created the request.
creationDate	string (date-time)	The date and time when the request was created.
customerDisplayName	string	The name of the customer.
customerId	string	The fully qualified ID that uniquely identifies a customer.
customerName	string	The ID that uniquely identifies a customer.
decisionReason	string	The reason to approve or decline the request.
expirationDate	string (date-time)	The date and time when the request expires.
invoiceSectionDisplayName	string	The name of the invoice section.
invoiceSectionId	string	The fully qualified ID that uniquely identifies an invoice section.
invoiceSectionName	string	The ID that uniquely identifies an invoice section.
justification	string	Justification for submitting request.
lastUpdatedBy	LastUpdatedBy	The principal of the entity who last updated the request.
lastUpdatedDate	string (date-time)	Date and time of last update.
provisioningState	ProvisioningState	The provisioning state of the resource during a long-running operation.
recipients	Principal[]	The recipients of the billing request.
requestScope	string	The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}').
reviewalDate	string (date-time)	The date and time when the request was reviewed.
reviewedBy	ReviewedBy	The principal of the request reviewer. Will only be set if request is approved.
status	BillingRequestStatus	Status of billing request.
subscriptionDisplayName	string	The name of the billing subscription.
subscriptionId	string	The fully qualified ID that uniquely identifies a billing subscription.
subscriptionName	string	The ID that uniquely identifies a billing subscription.
type	BillingRequestType	Type of billing request.

BillingRequestStatus

Enumeration

Status of billing request.

Value	Description
Other
Pending
Approved
Declined
Cancelled
Completed
Expired

BillingRequestType

Enumeration

Type of billing request.

Value	Description
Other
InvoiceAccess
ProvisioningAccess
RoleAssignment
UpdateBillingPolicy

CreatedBy

Object

The principal of the entity who created the request.

Name	Type	Description
objectId	string	The object id of the principal who has interacted with a billing entity.
tenantId	string	The tenant id of the principal who has interacted with a billing entity.
upn	string	The user principal name of the principal who has interacted with a billing entity.

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.

LastUpdatedBy

Object

The principal of the entity who last updated the request.

Name	Type	Description
objectId	string	The object id of the principal who has interacted with a billing entity.
tenantId	string	The tenant id of the principal who has interacted with a billing entity.
upn	string	The user principal name of the principal who has interacted with a billing entity.

Principal

Object

A principal who has interacted with a billing entity.

Name	Type	Description
objectId	string	The object id of the principal who has interacted with a billing entity.
tenantId	string	The tenant id of the principal who has interacted with a billing entity.
upn	string	The user principal name of the principal who has interacted with a billing entity.

ProvisioningState

Enumeration

The provisioning state of the resource during a long-running operation.

Value	Description
Succeeded
Canceled
Failed
New
Pending
Provisioning

ReviewedBy

Object

The principal of the request reviewer. Will only be set if request is approved.

Name	Type	Description
objectId	string	The object id of the principal who has interacted with a billing entity.
tenantId	string	The tenant id of the principal who has interacted with a billing entity.
upn	string	The user principal name of the principal who has interacted with a billing entity.

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.