Agreements - Get

Dienst:

Billing

API-Version:

2024-04-01

Ruft eine Vereinbarung nach ID ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
agreementName	path	True	string pattern: ^[a-fA-F0-9]{1,12}$	Die ID, die eine Vereinbarung eindeutig identifiziert.
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})?)$	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01.

Antworten

Name	Typ	Beschreibung
200 OK	Agreement	Ein Abrechnungskonto.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

AgreementByName

Beispielanforderung

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123?api-version=2024-04-01

Java

/**
 * Samples for Agreements Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-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(
            "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "ABC123",
            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="10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        agreement_name="ABC123",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-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/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-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, "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", "ABC123", 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("ABC123"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/agreements"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123"),
	// 	Properties: &armbilling.AgreementProperties{
	// 		AcceptanceMode: to.Ptr(armbilling.AcceptanceModeClickToAccept),
	// 		AgreementLink: to.Ptr("https://contoso.com"),
	// 		DisplayName: to.Ptr("Microsoft Customer Agreement"),
	// 		EffectiveDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-11-01T00:00:00.000Z"); return t}()),
	// 		ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-11-01T00:00:00.000Z"); return t}()),
	// 		LeadBillingAccountName: to.Ptr("20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"),
	// 		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 Gets an agreement by ID.
 *
 * @summary Gets an agreement by ID.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementByName.json
 */
async function agreementByName() {
  const billingAccountName =
    "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const agreementName = "ABC123";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.agreements.get(billingAccountName, agreementName);
  console.log(result);
}

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;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/agreementByName.json
// this example is just showing the usage of "Agreements_Get" 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 BillingAccountResource created on azure
// for more information of creating BillingAccountResource, please refer to the document of BillingAccountResource
string billingAccountName = "10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
ResourceIdentifier billingAccountResourceId = BillingAccountResource.CreateResourceIdentifier(billingAccountName);
BillingAccountResource billingAccount = client.GetBillingAccountResource(billingAccountResourceId);

// get the collection of this BillingAgreementResource
BillingAgreementCollection collection = billingAccount.GetBillingAgreements();

// invoke the operation
string agreementName = "ABC123";
NullableResponse<BillingAgreementResource> response = await collection.GetIfExistsAsync(agreementName);
BillingAgreementResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result 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
    BillingAgreementData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/agreements/ABC123",
  "name": "ABC123",
  "properties": {
    "acceptanceMode": "ClickToAccept",
    "agreementLink": "https://contoso.com",
    "displayName": "Microsoft Customer Agreement",
    "effectiveDate": "2018-11-01T00:00:00Z",
    "expirationDate": "2019-11-01T00:00:00Z",
    "status": "Active",
    "leadBillingAccountName": "20000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31"
  },
  "type": "Microsoft.Billing/billingAccounts/agreements"
}

Definitionen

Name	Beschreibung
AcceptanceMode	Die Art der Annahme für eine Vereinbarung.
Agreement	Eine Vereinbarung.
AgreementProperties	Eine Vereinbarung.
BillingProfileInfo	Details zum Abrechnungsprofil, das mit vereinbarungsbezogenem Vertrag verknüpft ist und nur für bestimmte Vereinbarungen verfügbar ist.
Category	Die Kategorie der Vereinbarung.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
Participant	Name des Abrechnungskontos. Für eine bestimmte Art von Vereinbarung verfügbar.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

AcceptanceMode

Enumeration

Die Art der Annahme für eine Vereinbarung.

Wert	Beschreibung
ClickToAccept
ESignEmbedded
ESignOffline
Implicit
Offline
Other
PhysicalSign

Agreement

Objekt

Eine Vereinbarung.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	AgreementProperties	Eine Vereinbarung.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Wörterbuch der Metadaten, die der Ressource zugeordnet sind. Möglicherweise wird sie nicht für alle Ressourcentypen aufgefüllt. Maximale Schlüssel-/Wertlänge unterstützt von 256 Zeichen. Schlüssel/Wert dürfen keinen leeren Wert oder null sein. Schlüssel können nicht <> % & \ enthalten? /
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AgreementProperties

Objekt

Eine Vereinbarung.

Name	Typ	Beschreibung
acceptanceMode	AcceptanceMode	Die Art der Annahme für eine Vereinbarung.
agreementLink	string	Die URL zum Herunterladen der Vereinbarung.
billingProfileInfo	BillingProfileInfo[]	Die Liste der Abrechnungsprofile, die mit vereinbarungsbezogenem Vertrag verknüpft sind und nur für bestimmte Vereinbarungen vorhanden sind.
category	Category	Die Kategorie der Vereinbarung.
displayName	string	Der Name der Vereinbarung, die von einem Kunden unterzeichnet wurde.
effectiveDate	string (date-time)	Das Datum, ab dem die Vereinbarung wirksam ist.
expirationDate	string (date-time)	Das Datum, an dem die Vereinbarung abläuft.
leadBillingAccountName	string	Die ID des Leadabrechnungskontos, wenn dieser Vertrag Teil der Kunden-Partnerkaufbedingungen ist.
participants	Participant[]	Die Teilnehmerliste, die an der Annahme einer Vereinbarung teilnimmt.
status	string	Der aktuelle Status der Vereinbarung.

BillingProfileInfo

Objekt

Details zum Abrechnungsprofil, das mit vereinbarungsbezogenem Vertrag verknüpft ist und nur für bestimmte Vereinbarungen verfügbar ist.

Name	Typ	Beschreibung
billingAccountId	string	Die vollqualifizierte ID, die ein Abrechnungskonto eindeutig identifiziert.
billingProfileDisplayName	string	Der Name des Abrechnungsprofils.
billingProfileId	string	Die benutzerfreundliche ID, die ein Abrechnungsprofil eindeutig identifiziert.
billingProfileSystemId	string	Die vollqualifizierte ID, die ein Abrechnungsprofil eindeutig identifiziert.
indirectRelationshipOrganizationName	string	Name des Abrechnungskontos. Für eine bestimmte Art von Vereinbarung verfügbar.

Category

Enumeration

Die Kategorie der Vereinbarung.

Wert	Beschreibung
AffiliatePurchaseTerms
IndirectForGovernmentAgreement
MicrosoftCustomerAgreement
MicrosoftPartnerAgreement
Other
UKCloudComputeFramework

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Participant

Objekt

Name des Abrechnungskontos. Für eine bestimmte Art von Vereinbarung verfügbar.

Name	Typ	Beschreibung
email	string	Die E-Mail-Adresse des Teilnehmers.
status	string	Der Annahmestatus des Teilnehmers.
statusDate	string (date-time)	Das Datum, an dem der Status geändert wurde.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.