Agreements - Get

Služba:

Billing

Verze rozhraní API:

2024-04-01

Získá smlouvu podle ID.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
agreementName	path	True	string pattern: ^[a-fA-F0-9]{1,12}$	ID, které jednoznačně identifikuje smlouvu.
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})?)$	ID, které jednoznačně identifikuje fakturační účet.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 2024-04-01.

Odpovědi

Name	Typ	Description
200 OK	Agreement	Fakturační účet.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Příklady

AgreementByName

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
AcceptanceMode	Režim přijetí smlouvy.
Agreement	Smlouva.
AgreementProperties	Smlouva.
BillingProfileInfo	Podrobnosti o fakturačním profilu přidruženém ke smlouvě a dostupné pouze pro konkrétní smlouvy.
Category	Kategorie smlouvy.
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
Participant	Název fakturačního účtu. K dispozici pro konkrétní typ smlouvy.
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AcceptanceMode

Výčet

Režim přijetí smlouvy.

Hodnota	Description
Other
ClickToAccept
ESignEmbedded
ESignOffline
Implicit
Offline
PhysicalSign

Agreement

Objekt

Smlouva.

Name	Typ	Description
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Název prostředku
properties	AgreementProperties	Smlouva.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
tags	object	Slovník metadat přidružených k prostředku Nemusí být vyplněna pro všechny typy prostředků. Maximální podporovaná délka klíče a hodnoty 256 znaků. Klíče nebo hodnota by neměly být prázdné ani null. Klíče nemohou obsahovat <> % & \ ? /
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

AgreementProperties

Objekt

Smlouva.

Name	Typ	Description
acceptanceMode	AcceptanceMode	Režim přijetí smlouvy.
agreementLink	string	Adresa URL pro stažení smlouvy.
billingProfileInfo	BillingProfileInfo[]	Seznam fakturačních profilů přidružených ke smlouvě a je k dispozici pouze pro konkrétní smlouvy.
category	Category	Kategorie smlouvy.
displayName	string	Název smlouvy podepsané zákazníkem.
effectiveDate	string (date-time)	Datum, od kterého je smlouva platná.
expirationDate	string (date-time)	Datum, kdy platnost smlouvy vyprší.
leadBillingAccountName	string	ID fakturačního účtu potenciálního zákazníka, pokud je tato smlouva součástí nákupních podmínek přidruženého zákazníka.
participants	Participant[]	Seznam účastníků, kteří se účastní přijetí smlouvy.
status	string	Aktuální stav smlouvy.

BillingProfileInfo

Objekt

Podrobnosti o fakturačním profilu přidruženém ke smlouvě a dostupné pouze pro konkrétní smlouvy.

Name	Typ	Description
billingAccountId	string	Plně kvalifikované ID, které jednoznačně identifikuje fakturační účet.
billingProfileDisplayName	string	Název fakturačního profilu.
billingProfileId	string	Popisné ID, které jednoznačně identifikuje fakturační profil.
billingProfileSystemId	string	Plně kvalifikované ID, které jednoznačně identifikuje fakturační profil.
indirectRelationshipOrganizationName	string	Název fakturačního účtu. K dispozici pro konkrétní typ smlouvy.

Category

Výčet

Kategorie smlouvy.

Hodnota	Description
Other
AffiliatePurchaseTerms
IndirectForGovernmentAgreement
MicrosoftCustomerAgreement
MicrosoftPartnerAgreement
UKCloudComputeFramework

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Participant

Objekt

Název fakturačního účtu. K dispozici pro konkrétní typ smlouvy.

Name	Typ	Description
email	string	E-mailová adresa účastníka.
status	string	Stav přijetí účastníka.
statusDate	string (date-time)	Datum, kdy se stav změnil.

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.