你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Agreements - Get

Service:

Billing

API Version:

2020-05-01

按 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 参数

名称	在	必需	类型	说明
agreementName	path	True	string	唯一标识协议的 ID。
billingAccountName	path	True	string	唯一标识计费帐户的 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。 当前版本为 2020-05-01。
$expand	query		string	可用于扩展参与者。

响应

名称	类型	说明
200 OK	Agreement	没问题。 请求已成功。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

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"
  }
}

定义

名称	说明
acceptanceMode	协议的接受模式。
Agreement	协议。
BillingProfileInfo	有关与协议关联的计费配置文件的详细信息，仅适用于特定协议。
category	客户签署的协议的类别。
ErrorDetails	错误的详细信息。
ErrorResponse	错误响应指示服务无法处理传入请求。 错误消息中提供了原因。
ErrorSubDetails
Participants	有关参与者的详细信息。

acceptanceMode

协议的接受模式。

名称	类型	说明
ClickToAccept	string
ESignEmbedded	string
ESignOffline	string
Implicit	string
Offline	string
Other	string
PhysicalSign	string

Agreement

协议。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.acceptanceMode	acceptanceMode	协议的接受模式。
properties.agreementLink	string	用于下载协议的 URL。
properties.billingProfileInfo	BillingProfileInfo	与协议关联的计费配置文件列表，仅针对特定协议提供。
properties.category	category	客户签署的协议的类别。
properties.effectiveDate	string	协议的生效日期。
properties.expirationDate	string	协议到期的日期。
properties.participants	Participants[]	参与接受协议的参与者列表。
properties.status	string	协议的当前状态。
type	string	资源类型。

BillingProfileInfo

有关与协议关联的计费配置文件的详细信息，仅适用于特定协议。

名称	类型	说明
billingProfileDisplayName	string	计费对象信息的名称
billingProfileId	string	计费对象信息的唯一标识符。
indirectRelationshipOrganizationName	string	计费帐户名称。 此属性可用于特定类型的协议。

category

客户签署的协议的类别。

名称	类型	说明
AffiliatePurchaseTerms	string
MicrosoftCustomerAgreement	string
Other	string

ErrorDetails

错误的详细信息。

名称	类型	说明
code	string	错误代码。
details	ErrorSubDetails[]	错误的子详细信息。
message	string	指示操作失败原因的错误消息。
target	string	特定错误的目标。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

名称	类型	说明
error	ErrorDetails	错误的详细信息。

ErrorSubDetails

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败原因的错误消息。
target	string	特定错误的目标。

Participants

有关参与者的详细信息。

名称	类型	说明
email	string	参与者的电子邮件地址。
status	string	参与者的接受状态。
statusDate	string	状态更改的日期。