Enrollment Accounts - Get

Reference

Service:: Billing

API Version:: 2018-03-01-preview

Gets a enrollment account by name.

GET https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/{name}?api-version=2018-03-01-preview

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Enrollment Account name.
api-version	query	True	string	Version of the API to be used with the client request. The current version is 2018-03-01-preview.

Responses

Name	Type	Description
200 OK	EnrollmentAccountSummary	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

EnrollmentAccountsGet

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556?api-version=2018-03-01-preview

/** Samples for EnrollmentAccounts Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/EnrollmentAccountsGet.json
     */
    /**
     * Sample code: EnrollmentAccountsGet.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void enrollmentAccountsGet(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .enrollmentAccounts()
            .getWithResponse("e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", 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

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_get.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.get(
        name="e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/EnrollmentAccountsGet.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 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/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/EnrollmentAccountsGet.json
func ExampleEnrollmentAccountsClient_Get() {
	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)
	}
	res, err := clientFactory.NewEnrollmentAccountsClient().Get(ctx, "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", 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.EnrollmentAccountSummary = armbilling.EnrollmentAccountSummary{
	// 	Name: to.Ptr("e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556"),
	// 	Type: to.Ptr("Microsoft.Billing/enrollmentAccounts"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556"),
	// 	Properties: &armbilling.EnrollmentAccountSummaryProperties{
	// 		PrincipalName: to.Ptr("kathy@contoso.com"),
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Gets a enrollment account by name.
 *
 * @summary Gets a enrollment account by name.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/EnrollmentAccountsGet.json
 */
async function enrollmentAccountsGet() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const name = "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.enrollmentAccounts.get(name);
  console.log(result);
}

enrollmentAccountsGet().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

Sample Response

Status code:: 200

{
  "id": "/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556",
  "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556",
  "type": "Microsoft.Billing/enrollmentAccounts",
  "properties": {
    "principalName": "kathy@contoso.com"
  }
}

Definitions

Name	Description
EnrollmentAccountSummary	An enrollment account resource.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ErrorSubDetails

EnrollmentAccountSummary

An enrollment account resource.

Name	Type	Description
id	string	Resource Id.
name	string	Resource name.
properties.principalName	string	The account owner's principal name.
type	string	Resource type.

ErrorDetails

The details of the error.

Name	Type	Description
code	string	Error code.
details	ErrorSubDetails[]	The sub details of the error.
message	string	Error message indicating why the operation failed.
target	string	The target of the particular error.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
error	ErrorDetails	The details of the error.

ErrorSubDetails

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.
target	string	The target of the particular error.

Share via

Enrollment Accounts - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

EnrollmentAccountsGet

Sample Request

Sample Response

Definitions

EnrollmentAccountSummary

ErrorDetails

ErrorResponse

ErrorSubDetails

Additional resources