|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "title": "BillingManagementClient", |
| 5 | + "description": "Documentation for Microsoft.Billing.", |
| 6 | + "contact": { |
| 7 | + "name": "Microsoft.Billing", |
| 8 | + "url": "https://learn.microsoft.com/en-us/rest/api/billing/", |
| 9 | + |
| 10 | + }, |
| 11 | + "version": "2024-04-01" |
| 12 | + }, |
| 13 | + "paths": { |
| 14 | + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}": { |
| 15 | + "get": { |
| 16 | + "tags": [ |
| 17 | + "Agreement" |
| 18 | + ], |
| 19 | + "description": "Gets an agreement by ID.", |
| 20 | + "externalDocs": { |
| 21 | + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" |
| 22 | + }, |
| 23 | + "operationId": "Agreements_Get", |
| 24 | + "produces": [ |
| 25 | + "application/json" |
| 26 | + ], |
| 27 | + "parameters": [ |
| 28 | + { |
| 29 | + "$ref": "./types.json#/parameters/billingAccountName" |
| 30 | + }, |
| 31 | + { |
| 32 | + "in": "path", |
| 33 | + "name": "agreementName", |
| 34 | + "description": "The ID that uniquely identifies an agreement.", |
| 35 | + "required": true, |
| 36 | + "type": "string", |
| 37 | + "pattern": "^[a-fA-F0-9]{1,12}$" |
| 38 | + }, |
| 39 | + { |
| 40 | + "$ref": "./types.json#/parameters/apiVersionParameter" |
| 41 | + } |
| 42 | + ], |
| 43 | + "responses": { |
| 44 | + "200": { |
| 45 | + "description": "A billing account.", |
| 46 | + "schema": { |
| 47 | + "$ref": "#/definitions/Agreement" |
| 48 | + } |
| 49 | + }, |
| 50 | + "default": { |
| 51 | + "description": "Error response describing why the operation failed.", |
| 52 | + "schema": { |
| 53 | + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" |
| 54 | + } |
| 55 | + } |
| 56 | + }, |
| 57 | + "x-ms-examples": { |
| 58 | + "AgreementByName": { |
| 59 | + "$ref": "./examples/agreementByName.json" |
| 60 | + } |
| 61 | + } |
| 62 | + } |
| 63 | + }, |
| 64 | + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements": { |
| 65 | + "get": { |
| 66 | + "tags": [ |
| 67 | + "Agreement" |
| 68 | + ], |
| 69 | + "description": "Lists the agreements for a billing account.", |
| 70 | + "externalDocs": { |
| 71 | + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" |
| 72 | + }, |
| 73 | + "operationId": "Agreements_ListByBillingAccount", |
| 74 | + "produces": [ |
| 75 | + "application/json" |
| 76 | + ], |
| 77 | + "parameters": [ |
| 78 | + { |
| 79 | + "$ref": "./types.json#/parameters/billingAccountName" |
| 80 | + }, |
| 81 | + { |
| 82 | + "$ref": "./types.json#/parameters/apiVersionParameter" |
| 83 | + }, |
| 84 | + { |
| 85 | + "in": "query", |
| 86 | + "name": "expand", |
| 87 | + "description": "May be used to expand the participants.", |
| 88 | + "type": "string" |
| 89 | + } |
| 90 | + ], |
| 91 | + "responses": { |
| 92 | + "200": { |
| 93 | + "description": "Result of listing agreements.", |
| 94 | + "schema": { |
| 95 | + "$ref": "#/definitions/AgreementListResult" |
| 96 | + } |
| 97 | + }, |
| 98 | + "default": { |
| 99 | + "description": "Error response describing why the operation failed.", |
| 100 | + "schema": { |
| 101 | + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" |
| 102 | + } |
| 103 | + } |
| 104 | + }, |
| 105 | + "x-ms-examples": { |
| 106 | + "AgreementsListByBillingAccount": { |
| 107 | + "$ref": "./examples/agreementsListByBillingAccount.json" |
| 108 | + } |
| 109 | + }, |
| 110 | + "x-ms-pageable": { |
| 111 | + "nextLinkName": "nextLink" |
| 112 | + } |
| 113 | + } |
| 114 | + } |
| 115 | + }, |
| 116 | + "definitions": { |
| 117 | + "Agreement": { |
| 118 | + "description": "An agreement.", |
| 119 | + "type": "object", |
| 120 | + "allOf": [ |
| 121 | + { |
| 122 | + "$ref": "./types.json#/definitions/ProxyResourceWithTags" |
| 123 | + } |
| 124 | + ], |
| 125 | + "properties": { |
| 126 | + "properties": { |
| 127 | + "$ref": "#/definitions/AgreementProperties" |
| 128 | + } |
| 129 | + }, |
| 130 | + "x-ms-azure-resource": true |
| 131 | + }, |
| 132 | + "AgreementListResult": { |
| 133 | + "description": "A container for a list of resources", |
| 134 | + "type": "object", |
| 135 | + "properties": { |
| 136 | + "nextLink": { |
| 137 | + "description": "The link (url) to the next page of results.", |
| 138 | + "type": "string", |
| 139 | + "readOnly": true |
| 140 | + }, |
| 141 | + "value": { |
| 142 | + "description": "The list of resources.", |
| 143 | + "type": "array", |
| 144 | + "items": { |
| 145 | + "$ref": "#/definitions/Agreement" |
| 146 | + }, |
| 147 | + "readOnly": true, |
| 148 | + "x-ms-identifiers": [ |
| 149 | + "id" |
| 150 | + ] |
| 151 | + } |
| 152 | + } |
| 153 | + }, |
| 154 | + "AgreementProperties": { |
| 155 | + "description": "An agreement.", |
| 156 | + "type": "object", |
| 157 | + "properties": { |
| 158 | + "acceptanceMode": { |
| 159 | + "description": "The mode of acceptance for an agreement.", |
| 160 | + "enum": [ |
| 161 | + "Other", |
| 162 | + "ClickToAccept", |
| 163 | + "ESignEmbedded", |
| 164 | + "ESignOffline", |
| 165 | + "Implicit", |
| 166 | + "Offline", |
| 167 | + "PhysicalSign" |
| 168 | + ], |
| 169 | + "type": "string", |
| 170 | + "readOnly": true, |
| 171 | + "x-ms-enum": { |
| 172 | + "name": "AcceptanceMode", |
| 173 | + "modelAsString": true |
| 174 | + } |
| 175 | + }, |
| 176 | + "agreementLink": { |
| 177 | + "description": "The URL to download the agreement.", |
| 178 | + "type": "string", |
| 179 | + "readOnly": true |
| 180 | + }, |
| 181 | + "billingProfileInfo": { |
| 182 | + "description": "The list of billing profiles associated with agreement and present only for specific agreements.", |
| 183 | + "type": "array", |
| 184 | + "items": { |
| 185 | + "$ref": "#/definitions/BillingProfileInfo" |
| 186 | + }, |
| 187 | + "readOnly": true, |
| 188 | + "x-ms-identifiers": [] |
| 189 | + }, |
| 190 | + "category": { |
| 191 | + "description": "The category of the agreement.", |
| 192 | + "enum": [ |
| 193 | + "Other", |
| 194 | + "AffiliatePurchaseTerms", |
| 195 | + "IndirectForGovernmentAgreement", |
| 196 | + "MicrosoftCustomerAgreement", |
| 197 | + "MicrosoftPartnerAgreement", |
| 198 | + "UKCloudComputeFramework" |
| 199 | + ], |
| 200 | + "type": "string", |
| 201 | + "readOnly": true, |
| 202 | + "x-ms-enum": { |
| 203 | + "name": "Category", |
| 204 | + "modelAsString": true |
| 205 | + } |
| 206 | + }, |
| 207 | + "displayName": { |
| 208 | + "description": "The name of the agreement signed by a customer.", |
| 209 | + "type": "string", |
| 210 | + "readOnly": true |
| 211 | + }, |
| 212 | + "effectiveDate": { |
| 213 | + "format": "date-time", |
| 214 | + "description": "The date from which the agreement is effective.", |
| 215 | + "type": "string", |
| 216 | + "readOnly": true |
| 217 | + }, |
| 218 | + "expirationDate": { |
| 219 | + "format": "date-time", |
| 220 | + "description": "The date when the agreement expires.", |
| 221 | + "type": "string", |
| 222 | + "readOnly": true |
| 223 | + }, |
| 224 | + "participants": { |
| 225 | + "description": "The list of participants that participates in acceptance of an agreement.", |
| 226 | + "type": "array", |
| 227 | + "items": { |
| 228 | + "$ref": "#/definitions/Participant" |
| 229 | + }, |
| 230 | + "readOnly": true, |
| 231 | + "x-ms-identifiers": [] |
| 232 | + }, |
| 233 | + "status": { |
| 234 | + "description": "The current status of the agreement.", |
| 235 | + "type": "string", |
| 236 | + "readOnly": true |
| 237 | + }, |
| 238 | + "leadBillingAccountName": { |
| 239 | + "description": "The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms.", |
| 240 | + "type": "string", |
| 241 | + "readOnly": true |
| 242 | + } |
| 243 | + } |
| 244 | + }, |
| 245 | + "BillingProfileInfo": { |
| 246 | + "description": "Details about billing profile associated with agreement and available only for specific agreements.", |
| 247 | + "type": "object", |
| 248 | + "properties": { |
| 249 | + "billingAccountId": { |
| 250 | + "description": "The fully qualified ID that uniquely identifies a billing account.", |
| 251 | + "type": "string" |
| 252 | + }, |
| 253 | + "billingProfileDisplayName": { |
| 254 | + "description": "The name of the billing profile.", |
| 255 | + "type": "string" |
| 256 | + }, |
| 257 | + "billingProfileId": { |
| 258 | + "description": "The friendly ID that uniquely identifies a billing profile.", |
| 259 | + "type": "string" |
| 260 | + }, |
| 261 | + "billingProfileSystemId": { |
| 262 | + "description": "The fully qualified ID that uniquely identifies a billing profile.", |
| 263 | + "type": "string" |
| 264 | + }, |
| 265 | + "indirectRelationshipOrganizationName": { |
| 266 | + "description": "Billing account name. Available for a specific type of agreement.", |
| 267 | + "type": "string" |
| 268 | + } |
| 269 | + } |
| 270 | + }, |
| 271 | + "Participant": { |
| 272 | + "description": "Billing account name. Available for a specific type of agreement.", |
| 273 | + "type": "object", |
| 274 | + "properties": { |
| 275 | + "email": { |
| 276 | + "description": "The email address of the participant.", |
| 277 | + "type": "string", |
| 278 | + "readOnly": true |
| 279 | + }, |
| 280 | + "status": { |
| 281 | + "description": "The acceptance status of the participant.", |
| 282 | + "type": "string", |
| 283 | + "readOnly": true |
| 284 | + }, |
| 285 | + "statusDate": { |
| 286 | + "format": "date-time", |
| 287 | + "description": "The date when the status got changed.", |
| 288 | + "type": "string", |
| 289 | + "readOnly": true |
| 290 | + } |
| 291 | + } |
| 292 | + } |
| 293 | + }, |
| 294 | + "securityDefinitions": { |
| 295 | + "azure_auth": { |
| 296 | + "type": "oauth2", |
| 297 | + "flow": "implicit", |
| 298 | + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", |
| 299 | + "scopes": { |
| 300 | + "user_impersonation": "impersonate your user account" |
| 301 | + }, |
| 302 | + "description": "Azure Active Directory OAuth2 Flow." |
| 303 | + } |
| 304 | + }, |
| 305 | + "host": "management.azure.com", |
| 306 | + "schemes": [ |
| 307 | + "https" |
| 308 | + ], |
| 309 | + "consumes": [ |
| 310 | + "application/json" |
| 311 | + ], |
| 312 | + "produces": [ |
| 313 | + "application/json" |
| 314 | + ] |
| 315 | +} |
0 commit comments