Agreements - Get

Gets an agreement by 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 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 2019-10-01-preview.

$expand
query
  • string

May be used to expand the participants.

Responses

Name Type Description
200 OK

OK. The request has succeeded.

Other Status Codes

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

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

Definitions

acceptanceMode

The mode of acceptance for an agreement.

Agreement

An agreement.

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

Agreement

An agreement.

Name Type Description
id
  • string

Resource Id.

name
  • string

Resource name.

properties.acceptanceMode

The mode of acceptance for an agreement.

properties.agreementLink
  • string

The URL to download the agreement.

properties.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

The list of participants that participates in acceptance of an agreement.

properties.status
  • string

The current status of the agreement.

type
  • string

Resource type.

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

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

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.