你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Agreements - List By Billing Account
列出计费帐户的协议。
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements?api-version=2020-05-01
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements?api-version=2020-05-01&$expand={$expand}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
billing
|
path | True |
string |
唯一标识计费帐户的 ID。 |
api-version
|
query | True |
string |
要与客户端请求一起使用的 API 的版本。 当前版本为 2020-05-01。 |
$expand
|
query |
string |
可用于扩展参与者。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
没问题。 请求已成功。 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
AgreementsListByBillingAccount
Sample Request
GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements?api-version=2020-05-01
Sample Response
{
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/Agreement1",
"name": "Agreement1",
"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": "xtz@contoso.com"
}
],
"status": "Published"
}
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/Agreement2",
"name": "Agreement2",
"type": "Microsoft.Billing/billingAccounts/agreements",
"properties": {
"agreementLink": "https://agreementuri2.com",
"category": "MicrosoftCustomerAgreement",
"acceptanceMode": "ESignEmbedded",
"effectiveDate": "2018-12-05T00:00:00Z",
"expirationDate": "2018-12-05T00:00:00Z",
"participants": [
{
"status": "Unknown",
"statusDate": "2018-11-01T00:00:00Z",
"email": "abc@contoso.com"
}
],
"status": "PendingSignature"
}
}
]
}
定义
名称 | 说明 |
---|---|
acceptance |
协议的接受模式。 |
Agreement |
协议。 |
Agreement |
列出协议的结果。 |
Billing |
有关与协议关联的计费配置文件的详细信息,仅适用于特定协议。 |
category |
客户签署的协议的类别。 |
Error |
错误的详细信息。 |
Error |
错误响应指示服务无法处理传入请求。 错误消息中提供了原因。 |
Error |
|
Participants |
有关参与者的详细信息。 |
acceptanceMode
协议的接受模式。
名称 | 类型 | 说明 |
---|---|---|
ClickToAccept |
string |
|
ESignEmbedded |
string |
|
ESignOffline |
string |
|
Implicit |
string |
|
Offline |
string |
|
Other |
string |
|
PhysicalSign |
string |
Agreement
协议。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
name |
string |
资源名称。 |
properties.acceptanceMode |
协议的接受模式。 |
|
properties.agreementLink |
string |
用于下载协议的 URL。 |
properties.billingProfileInfo |
与协议关联的计费配置文件列表,仅针对特定协议提供。 |
|
properties.category |
客户签署的协议的类别。 |
|
properties.effectiveDate |
string |
协议的生效日期。 |
properties.expirationDate |
string |
协议到期的日期。 |
properties.participants |
参与接受协议的参与者列表。 |
|
properties.status |
string |
协议的当前状态。 |
type |
string |
资源类型。 |
AgreementListResult
列出协议的结果。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
指向下一页结果的链接 (url) 。 |
value |
协议列表。 |
BillingProfileInfo
有关与协议关联的计费配置文件的详细信息,仅适用于特定协议。
名称 | 类型 | 说明 |
---|---|---|
billingProfileDisplayName |
string |
计费对象信息的名称 |
billingProfileId |
string |
计费对象信息的唯一标识符。 |
indirectRelationshipOrganizationName |
string |
计费帐户名称。 此属性可用于特定类型的协议。 |
category
客户签署的协议的类别。
名称 | 类型 | 说明 |
---|---|---|
AffiliatePurchaseTerms |
string |
|
MicrosoftCustomerAgreement |
string |
|
Other |
string |
ErrorDetails
错误的详细信息。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
details |
错误的子详细信息。 |
|
message |
string |
指示操作失败原因的错误消息。 |
target |
string |
特定错误的目标。 |
ErrorResponse
错误响应指示服务无法处理传入请求。 错误消息中提供了原因。
名称 | 类型 | 说明 |
---|---|---|
error |
错误的详细信息。 |
ErrorSubDetails
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码。 |
message |
string |
指示操作失败原因的错误消息。 |
target |
string |
特定错误的目标。 |
Participants
有关参与者的详细信息。
名称 | 类型 | 说明 |
---|---|---|
string |
参与者的电子邮件地址。 |
|
status |
string |
参与者的接受状态。 |
statusDate |
string |
状态更改的日期。 |