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

Agreements - Get

按 ID 获取协议。

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

URI 参数

Name In Required Type Description
agreementName
path True
  • string

唯一标识协议的 ID。

billingAccountName
path True
  • string

唯一标识计费帐户的 ID。

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。 当前版本为 2019-10-01-preview。

$expand
query
  • string

可用于扩展参与者。

响应

Name Type Description
200 OK

没问题。 请求已成功。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

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 模拟用户帐户

示例

AgreementByName

Sample Request

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

Sample Response

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

协议。

category

客户签署的协议类别。

ErrorDetails

错误的详细信息。

ErrorResponse

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

ErrorSubDetails
Participants

有关参与者的详细信息。

acceptanceMode

协议接受模式。

Name Type Description
ClickToAccept
  • string
ESignEmbedded
  • string
ESignOffline
  • string

Agreement

协议。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.acceptanceMode

协议接受模式。

properties.agreementLink
  • string

要下载协议的 URL。

properties.category

客户签署的协议类别。

properties.effectiveDate
  • string

协议生效的日期。

properties.expirationDate
  • string

协议到期的日期。

properties.participants

参与接受协议的参与者列表。

properties.status
  • string

协议的当前状态。

type
  • string

资源类型。

category

客户签署的协议类别。

Name Type Description
AffiliatePurchaseTerms
  • string
MicrosoftCustomerAgreement
  • string
Other
  • string

ErrorDetails

错误的详细信息。

Name Type Description
code
  • string

错误代码。

details

错误的子详细信息。

message
  • string

指示操作失败的原因的错误消息。

target
  • string

特定错误的目标。

ErrorResponse

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

Name Type Description
error

错误的详细信息。

ErrorSubDetails

Name Type Description
code
  • string

错误代码。

message
  • string

指示操作失败的原因的错误消息。

target
  • string

特定错误的目标。

Participants

有关参与者的详细信息。

Name Type Description
email
  • string

参与者的电子邮件地址。

status
  • string

参与者的接受状态。

statusDate
  • string

状态更改的日期。