Agreements - Get

Service:

Billing

API Version:

2020-05-01

Gets an agreement by ID.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}?api-version=2020-05-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}?api-version=2020-05-01&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
agreementName	path	True	string	The ID that uniquely identifies an agreement.
billingAccountName	path	True	string	The ID that uniquely identifies a billing account.
api-version	query	True	string	The version of the API to be used with the client request. The current version is 2020-05-01.
$expand	query		string	May be used to expand the participants.

Responses

Name	Type	Description
200 OK	Agreement	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

AgreementByName

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}?api-version=2020-05-01

Java

/** Samples for Agreements Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json
     */
    /**
     * Sample code: AgreementByName.
     *
     * @param manager Entry point to BillingManager.
     */
    public static void agreementByName(com.azure.resourcemanager.billing.BillingManager manager) {
        manager
            .agreements()
            .getWithResponse("{billingAccountName}", "{agreementName}", 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 agreement_by_name.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.agreements.get(
        billing_account_name="{billingAccountName}",
        agreement_name="{agreementName}",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.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/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json
func ExampleAgreementsClient_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.NewAgreementsClient().Get(ctx, "{billingAccountName}", "{agreementName}", &armbilling.AgreementsClientGetOptions{Expand: 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.Agreement = armbilling.Agreement{
	// 	Name: to.Ptr("{agreementName}"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/agreements"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}"),
	// 	Properties: &armbilling.AgreementProperties{
	// 		AcceptanceMode: to.Ptr(armbilling.AcceptanceModeClickToAccept),
	// 		AgreementLink: to.Ptr("https://agreementuri1.com"),
	// 		Category: to.Ptr(armbilling.CategoryMicrosoftCustomerAgreement),
	// 		EffectiveDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-05T00:00:00.000Z"); return t}()),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-12-05T00:00:00.000Z"); return t}()),
	// 		Participants: []*armbilling.Participants{
	// 			{
	// 				Email: to.Ptr("abc@contoso.com"),
	// 				Status: to.Ptr("Accepted"),
	// 				StatusDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-01T00:00:00.000Z"); return t}()),
	// 			},
	// 			{
	// 				Email: to.Ptr("xyz@contoso.com"),
	// 				Status: to.Ptr("Declined"),
	// 				StatusDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-02T00:00:00.000Z"); return t}()),
	// 		}},
	// 		Status: to.Ptr("Published"),
	// 	},
	// }
}

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 Gets an agreement by ID.
 *
 * @summary Gets an agreement by ID.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json
 */
async function agreementByName() {
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const billingAccountName = "{billingAccountName}";
  const agreementName = "{agreementName}";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential, subscriptionId);
  const result = await client.agreements.get(billingAccountName, agreementName);
  console.log(result);
}

agreementByName().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/billingAccounts/{billingAccountName}/agreements/{agreementName}",
  "name": "{agreementName}",
  "type": "Microsoft.Billing/billingAccounts/agreements",
  "properties": {
    "agreementLink": "https://agreementuri1.com",
    "category": "MicrosoftCustomerAgreement",
    "acceptanceMode": "ClickToAccept",
    "effectiveDate": "2018-12-05T00:00:00Z",
    "expirationDate": "2018-12-05T00:00:00Z",
    "participants": [
      {
        "status": "Accepted",
        "statusDate": "2018-11-01T00:00:00Z",
        "email": "abc@contoso.com"
      },
      {
        "status": "Declined",
        "statusDate": "2018-11-02T00:00:00Z",
        "email": "xyz@contoso.com"
      }
    ],
    "status": "Published"
  }
}

Definitions

Name	Description
acceptanceMode	The mode of acceptance for an agreement.
Agreement	An agreement.
BillingProfileInfo	Details about billing profile associated with agreement and available only for specific agreements.
category	The category of the agreement signed by a customer.
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
Participants	The details about a participant.

acceptanceMode

The mode of acceptance for an agreement.

Name	Type	Description
ClickToAccept	string
ESignEmbedded	string
ESignOffline	string
Implicit	string
Offline	string
Other	string
PhysicalSign	string

Agreement

An agreement.

Name	Type	Description
id	string	Resource Id.
name	string	Resource name.
properties.acceptanceMode	acceptanceMode	The mode of acceptance for an agreement.
properties.agreementLink	string	The URL to download the agreement.
properties.billingProfileInfo	BillingProfileInfo	The list of billing profiles associated with agreement and present only for specific agreements.
properties.category	category	The category of the agreement signed by a customer.
properties.effectiveDate	string	The date from which the agreement is effective.
properties.expirationDate	string	The date when the agreement expires.
properties.participants	Participants[]	The list of participants that participates in acceptance of an agreement.
properties.status	string	The current status of the agreement.
type	string	Resource type.

BillingProfileInfo

Details about billing profile associated with agreement and available only for specific agreements.

Name	Type	Description
billingProfileDisplayName	string	The name of the billing profile
billingProfileId	string	The unique identifier for the billing profile.
indirectRelationshipOrganizationName	string	Billing account name. This property is available for a specific type of agreement.

category

The category of the agreement signed by a customer.

Name	Type	Description
AffiliatePurchaseTerms	string
MicrosoftCustomerAgreement	string
Other	string

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.

Participants

The details about a participant.

Name	Type	Description
email	string	The email address of the participant.
status	string	The acceptance status of the participant.
statusDate	string	The date when the status got changed.