From 8bdeeb715b85ded3372f5846759451d7bd3001bb Mon Sep 17 00:00:00 2001 From: "REDMOND\\sakulkar" Date: Wed, 10 Oct 2018 17:01:54 -0700 Subject: [PATCH 1/4] Microsoft.Billing: Gtm ImportRequest swagger --- .../preview/2018-08-01-preview/billing.json | 1371 +++++++++++++++++ .../examples/AcceptImportRequest.json | 54 + .../examples/BillingPeriodsGet.json | 24 + .../examples/BillingPeriodsList.json | 27 + .../examples/CancelImportRequest.json | 31 + .../examples/DeclineImportRequest.json | 28 + .../examples/EnrollmentAccountsGet.json | 18 + .../examples/EnrollmentAccountsList.json | 29 + .../examples/GetImportRequest.json | 40 + .../examples/GetRecipientImportRequest.json | 40 + .../examples/InitiateImportRequest.json | 37 + .../examples/InvoicesExpand.json | 34 + .../examples/InvoicesGet.json | 28 + .../examples/InvoicesGetLatest.json | 27 + .../examples/InvoicesList.json | 27 + .../examples/ListImportRequests.json | 45 + .../examples/ListRecipientImportRequests.json | 43 + 17 files changed, 1903 insertions(+) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptImportRequest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelImportRequest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineImportRequest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientImportRequest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateImportRequest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientImportRequests.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json new file mode 100644 index 000000000000..beb61bb408f8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json @@ -0,0 +1,1371 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-08-01-preview", + "title": "BillingManagementClient", + "description": "Billing client provides access to billing resources for Azure subscriptions." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Billing/enrollmentAccounts": { + "get": { + "tags": [ + "EnrollmentAccounts" + ], + "x-ms-examples": { + "EnrollmentAccountsList": { + "$ref": "./examples/EnrollmentAccountsList.json" + } + }, + "operationId": "EnrollmentAccounts_List", + "description": "Lists the enrollment accounts the caller has access to.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{name}": { + "get": { + "tags": [ + "EnrollmentAccounts" + ], + "x-ms-examples": { + "EnrollmentAccountsGet": { + "$ref": "./examples/EnrollmentAccountsGet.json" + } + }, + "operationId": "EnrollmentAccounts_Get", + "description": "Gets a enrollment account by name.", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Enrollment Account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods": { + "get": { + "tags": [ + "BillingPeriods" + ], + "operationId": "BillingPeriods_List", + "description": "Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "externalDocs": { + "url": "https://go.microsoft.com/fwlink/?linkid=844490" + }, + "x-ms-examples": { + "BillingPeriodsList": { + "$ref": "./examples/BillingPeriodsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter billing periods by billingPeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N billing periods.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 100 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPeriodsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}": { + "get": { + "tags": [ + "BillingPeriods" + ], + "operationId": "BillingPeriods_Get", + "description": "Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "x-ms-examples": { + "BillingPeriodsGet": { + "$ref": "./examples/BillingPeriodsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "billingPeriodName", + "description": "The name of a BillingPeriod resource.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPeriod" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices": { + "get": { + "tags": [ + "Invoices" + ], + "operationId": "Invoices_List", + "description": "Lists the available invoices for a subscription in reverse chronological order beginning with the most recent invoice. In preview, invoices are available via this API only for invoice periods which end December 1, 2016 or later. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "externalDocs": { + "url": "https://go.microsoft.com/fwlink/?linkid=842057" + }, + "x-ms-examples": { + "InvoicesList": { + "$ref": "./examples/InvoicesList.json" + }, + "InvoicesExpand": { + "$ref": "./examples/InvoicesExpand.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the downloadUrl property within a list of invoices. This enables download links to be generated for multiple invoices at once. By default, downloadURLs are not included when listing invoices.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter invoices by invoicePeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N invoices.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 100 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoicesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoices" + ], + "operationId": "Invoices_Get", + "description": "Gets a named invoice resource. When getting a single invoice, the downloadUrl property is expanded automatically. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "x-ms-examples": { + "InvoicesGet": { + "$ref": "./examples/InvoicesGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "invoiceName", + "description": "The name of an invoice resource.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/latest": { + "get": { + "tags": [ + "Invoices" + ], + "operationId": "Invoices_GetLatest", + "description": "Gets the most recent invoice. When getting a single invoice, the downloadUrl property is expanded automatically. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "x-ms-examples": { + "InvoicesGetLatest": { + "$ref": "./examples/InvoicesGetLatest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available billing REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/projects/{projectId}/initiateImportRequest": { + "post": { + "description": "Initiates the request to import the GTM or legacy subscriptions or RIs to GTM.", + "operationId": "ImportRequest_Initiate", + "x-ms-examples": { + "InitiateImportRequest": { + "$ref": "./examples/InitiateImportRequest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/projectIdParameter" + }, + { + "$ref": "#/parameters/initiateImportRequestParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Initiated import request details.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/importRequestDetails" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/projects/{projectId}/importRequests/{importRequestId}": { + "get": { + "description": "Gets the import request details for given import request Id.", + "operationId": "ImportRequest_Get", + "x-ms-examples": { + "ImportRequestGet": { + "$ref": "./examples/GetImportRequest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/projectIdParameter" + }, + { + "$ref": "#/parameters/importRequestIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of import request.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/importRequestDetails" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Cancels the import request for given import request Id.", + "operationId": "ImportRequest_Cancel", + "x-ms-examples": { + "ImportRequestCancel": { + "$ref": "./examples/CancelImportRequest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/projectIdParameter" + }, + { + "$ref": "#/parameters/importRequestIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of canceled import request.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/importRequestDetails" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/projects/{projectId}/importRequests": { + "get": { + "description": "Lists all import requests' details initiated from given project.", + "operationId": "ImportRequests_List", + "x-ms-examples": { + "ImportRequestsList": { + "$ref": "./examples/ListImportRequests.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/projectIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "List of import requests initiated from this project.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/importRequestDetailsListResult" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/importRequests/{importRequestId}/acceptImportRequest": { + "post": { + "summary": "Accepts the import request with given import request Id.", + "operationId": "ImportRequest_Accept", + "x-ms-examples": { + "AcceptImportRequest": { + "$ref": "./examples/AcceptImportRequest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/importRequestIdParameter" + }, + { + "$ref": "#/parameters/acceptImportRequestParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of the accepted import request.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/recipientImportRequestDetails" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/importRequests/{importRequestId}/declineImportRequest": { + "post": { + "summary": "Declines the import request with given import request Id.", + "operationId": "ImportRequest_Decline", + "x-ms-examples": { + "DeclineImportRequest": { + "$ref": "./examples/DeclineImportRequest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/importRequestIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of the declined import request.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/recipientImportRequestDetails" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/importRequests/{importRequestId}/": { + "get": { + "summary": "Gets the import request with given import request Id.", + "operationId": "RecipientImportRequest_Get", + "x-ms-examples": { + "RecipientImportRequestGet": { + "$ref": "./examples/GetRecipientImportRequest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/importRequestIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of the import requests with given Id.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/recipientImportRequestDetails" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/importRequests": { + "get": { + "summary": "Lists the import requests received by caller.", + "operationId": "RecipientImportRequest_List", + "x-ms-examples": { + "RecipientImportRequestsList": { + "$ref": "./examples/ListRecipientImportRequests.json" + } + }, + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "List of import requests received by caller.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/recipientImportRequestDetailsListResult" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "EnrollmentAccount": { + "description": "An enrollment account resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "An enrollment account.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnrollmentAccountProperties" + } + } + }, + "EnrollmentAccountListResult": { + "description": "Result of listing enrollment accounts.", + "properties": { + "value": { + "description": "The list of enrollment accounts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EnrollmentAccount" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "EnrollmentAccountProperties": { + "description": "The properties of the enrollment account.", + "properties": { + "principalName": { + "description": "The account owner's principal name.", + "type": "string", + "readOnly": true + } + } + }, + "BillingPeriod": { + "description": "A billing period resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "A billing period.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingPeriodProperties" + } + } + }, + "BillingPeriodsListResult": { + "description": "Result of listing billing periods. It contains a list of available billing periods in reverse chronological order.", + "properties": { + "value": { + "description": "The list of billing periods.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingPeriod" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingPeriodProperties": { + "description": "The properties of the billing period.", + "properties": { + "billingPeriodStartDate": { + "description": "The start of the date range covered by the billing period.", + "type": "string", + "format": "date", + "readOnly": true + }, + "billingPeriodEndDate": { + "description": "The end of the date range covered by the billing period.", + "type": "string", + "format": "date", + "readOnly": true + }, + "invoiceIds": { + "description": "Array of invoice ids that associated with.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "DownloadUrl": { + "description": "A secure URL that can be used to download a PDF invoice until the URL expires.", + "properties": { + "expiryTime": { + "description": "The time in UTC at which this download URL will expire.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "url": { + "description": "The URL to the PDF file.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "Invoice": { + "description": "An invoice resource can be used download a PDF version of an invoice.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "An invoice.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InvoiceProperties" + } + } + }, + "InvoicesListResult": { + "description": "Result of listing invoices. It contains a list of available invoices in reverse chronological order.", + "properties": { + "value": { + "description": "The list of invoices.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Invoice" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "InvoiceProperties": { + "description": "The properties of the invoice.", + "properties": { + "downloadUrl": { + "description": "A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached.", + "$ref": "#/definitions/DownloadUrl" + }, + "invoicePeriodStartDate": { + "description": "The start of the date range covered by the invoice.", + "type": "string", + "format": "date", + "readOnly": true + }, + "invoicePeriodEndDate": { + "description": "The end of the date range covered by the invoice.", + "type": "string", + "format": "date", + "readOnly": true + }, + "billingPeriodIds": { + "description": "Array of billing perdiod ids that the invoice is attributed to.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "Operation": { + "description": "A Billing REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Billing.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: Invoice, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "OperationListResult": { + "description": "Result listing billing operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of billing operations supported by the Microsoft.Billing resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "x-ms-azure-resource": true + }, + "initiateImportRequest": { + "type": "object", + "description": "Request parameters to initiate import request.", + "properties": { + "properties": { + "description": "Request parameters to initiate import request.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/initiateImportRequestProperties" + } + } + }, + "initiateImportRequestProperties": { + "type": "object", + "description": "Request parameters to initiate import request.", + "properties": { + "devTestUsageContext": { + "type": "string", + "description": "Target Usage context for devTest subscriptions." + }, + "standardUsageContext": { + "type": "string", + "description": "Target Usage context for standard subscriptions." + }, + "recipientEmailId": { + "type": "string", + "description": "Email Id of recipient for import request." + } + } + }, + "acceptImportRequest": { + "type": "object", + "description": "Request parameters to accept import request.", + "properties": { + "properties": { + "description": "Request parameters to accept import request.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/acceptImportRequestProperties" + } + } + }, + "acceptImportRequestProperties": { + "type": "object", + "description": "Request parameters to accept import request.", + "properties": { + "productDetails": { + "description": "Request parameters to accept import request.", + "type": "array", + "items": { + "$ref": "#/definitions/productDetails" + } + } + } + }, + "productDetails": { + "type": "object", + "description": "Details of the product to be imported.", + "properties": { + "productType": { + "description": "Type of the prouct to be imported.", + "$ref": "#/definitions/productType" + }, + "productId": { + "type": "string", + "description": "Id of product to be imported." + } + } + }, + "productType": { + "type": "string", + "description": "Type of the product to be imported.", + "enum": [ + "Subscription", + "ReservedInstance" + ], + "x-ms-enum": { + "name": "productType", + "modelAsString": true + } + }, + "importRequestDetails": { + "type": "object", + "description": "Details of the import request.", + "properties": { + "properties": { + "description": "Details of the import request.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/importRequestProperties" + } + } + }, + "recipientImportRequestDetails": { + "type": "object", + "description": "Details of the import request.", + "properties": { + "properties": { + "description": "Details of the import request.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/recipientImportRequestProperties" + } + } + }, + "extendedImportRequestStatus": { + "type": "object", + "description": "Detailed import request status.", + "properties": { + "productType": { + "type": "string", + "readOnly": true, + "description": "Type of product being imported." + }, + "productId": { + "type": "string", + "readOnly": true, + "description": "Id of product being imported." + }, + "importRequestStatus": { + "type": "string", + "readOnly": true, + "description": "Import request status." + }, + "errorDetails": { + "description": "Error details for import request execution.", + "$ref": "#/definitions/error" + } + } + }, + "error": { + "description": "Error details for import request execution.", + "properties": { + "errorCode": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Error message." + } + } + }, + "subscriptionType": { + "type": "string", + "description": "Type of the subscriptions that can be imported.", + "enum": [ + "DevTest", + "Standard" + ], + "x-ms-enum": { + "name": "subscriptionType", + "modelAsString": true + } + }, + "importRequestProperties": { + "description": "Import request details", + "type": "object", + "properties": { + "creationTime": { + "type": "string", + "description": "Import request creation time.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "readOnly": true, + "description": "Import request expiration time." + }, + "projectId": { + "type": "string", + "description": "Target project Id.", + "readOnly": true + }, + "billingAccountId": { + "type": "string", + "description": "Target billing account Id.", + "readOnly": true + }, + "devTestUsageContext": { + "type": "string", + "readOnly": true, + "description": "Target usage ontext for dev-test susbcriptions." + }, + "standardUsageContext": { + "type": "string", + "description": "Target usage context for standard subscriptions.", + "readOnly": true + }, + "importRequestStatus": { + "type": "string", + "description": "Overall import request status.", + "readOnly": true + }, + "recipientEmailId": { + "type": "string", + "readOnly": true, + "description": "Email Id of recipient of import request." + }, + "initiatorEmailId": { + "type": "string", + "readOnly": true, + "description": "Email Id of initiator of import request." + }, + "canceledBy": { + "type": "string", + "readOnly": true, + "description": "Email Id who user canceled the import request." + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "description": "Import request last modification time." + }, + "extendedImportRequestStatus": { + "type": "array", + "readOnly": true, + "description": "Detailed import request status.", + "items": { + "$ref": "#/definitions/extendedImportRequestStatus" + } + } + } + }, + "recipientImportRequestProperties": { + "description": "Import request Details.", + "type": "object", + "properties": { + "creationTime": { + "type": "string", + "description": "Import request creation time.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "readOnly": true, + "description": "Import request expiration time." + }, + "allowedSubscriptionType": { + "type": "array", + "readOnly": true, + "description": "Type of subscriptions that can be imported.", + "items": { + "$ref": "#/definitions/subscriptionType" + } + }, + "importRequestStatus": { + "type": "string", + "description": "Overall import request status.", + "readOnly": true + }, + "recipientEmailId": { + "type": "string", + "readOnly": true, + "description": "Email Id of recipient of import request." + }, + "initiatorEmailId": { + "type": "string", + "readOnly": true, + "description": "Email Id of initiator of import request." + }, + "canceledBy": { + "type": "string", + "readOnly": true, + "description": "Email Id who user canceled the import request." + }, + "lastModifiedTime": { + "type": "string", + "readOnly": true, + "description": "Import request last modification time." + }, + "extendedImportRequestStatus": { + "type": "array", + "readOnly": true, + "description": "Detailed import request status.", + "items": { + "$ref": "#/definitions/extendedImportRequestStatus" + } + } + } + }, + "recipientImportRequestDetailsListResult": { + "description": "Result of listing details of the import request received by caller.", + "properties": { + "value": { + "description": "The list of import requests received by caller.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/recipientImportRequestDetails" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "importRequestDetailsListResult": { + "description": "Result of listing details of the import request initiated by caller.", + "properties": { + "value": { + "description": "The list of import requests initiated by caller.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/importRequestDetails" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2018-03-01-preview." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "billingAccountIdParameter": { + "name": "billingAccountId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Billing account Id." + }, + "projectIdParameter": { + "name": "projectId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Project Id." + }, + "importRequestIdParameter": { + "name": "importRequestId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Import request Id." + }, + "initiateImportRequestParameter": { + "name": "body", + "x-ms-parameter-location": "method", + "in": "body", + "required": true, + "description": "Initiate import request parameters.", + "schema": { + "$ref": "#/definitions/initiateImportRequest" + } + }, + "acceptImportRequestParameter": { + "name": "body", + "x-ms-parameter-location": "method", + "in": "body", + "required": true, + "description": "Accept import request parameters.", + "schema": { + "$ref": "#/definitions/acceptImportRequest" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptImportRequest.json new file mode 100644 index 000000000000..9d9da817d5ab --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptImportRequest.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "importRequestId": "importRequestId", + "body": { + "properties": { + "value": [ + { + "productType": "Subscription", + "productId": "subscriptionId" + }, + { + "productType": "ReservedInstance", + "productId": "reservedInstanceId" + } + ] + } + } + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", + "type": "Microsoft.Billing/importRequests", + "name": "importRequestId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "allowedSubscriptionType": [ + "DevTest", + "Standard" + ], + "importRequestStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "extendedImportRequestStatus": [ + { + "productType": "Subscription", + "productId": "subscriptionId", + "importRequestStatus": "InProgress" + }, + { + "productType": "ReservedInstance", + "productId": "reservedInstanceId", + "importRequestStatus": "InProgress" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json new file mode 100644 index 000000000000..7bd4d0157469 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid", + "billingPeriodName": "201702-1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "name": "201702-1", + "type": "Microsoft.Billing/billingPeriods", + "properties": { + "billingPeriodStartDate": "2017-01-01", + "billingPeriodEndDate": "2017-02-01", + "invoiceIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-01-05-987654321" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json new file mode 100644 index 000000000000..1c79897ad719 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "name": "201702-1", + "type": "Microsoft.Billing/billingPeriods", + "properties": { + "billingPeriodStartDate": "2017-01-01", + "billingPeriodEndDate": "2017-02-01", + "invoiceIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-01-05-987654321" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelImportRequest.json new file mode 100644 index 000000000000..eb79dba56eb4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelImportRequest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "billingAccountId", + "projectId": "projectId", + "importRequestId": "importRequestId" + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", + "type": "Microsoft.Billing/importRequests", + "name": "importRequestId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "projectId": "projectId", + "billingAccountId": "billingAccountId", + "devTestUsageContext": "devTestUsageContextId", + "standardUsageContext": "standardUsageContext", + "importRequestStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "canceledBy": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM" + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineImportRequest.json new file mode 100644 index 000000000000..db7e5bcaaeb6 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineImportRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "importRequestId": "importRequestId" + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", + "type": "Microsoft.Billing/importRequests", + "name": "importRequestId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "allowedSubscriptionType": [ + "DevTest", + "Standard" + ], + "importRequestStatus": "Declined", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM" + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json new file mode 100644 index 000000000000..3d7117536c2d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", + "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "principalName": "kathy@contoso.com" + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json new file mode 100644 index 000000000000..56cd2ddd35b9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", + "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "principalName": "kathy@contoso.com" + } + }, + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/edd24053-07cd-4ed4-aa5b-326160a6680d", + "name": "edd24053-07cd-4ed4-aa5b-326160a6680d", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "principalName": "dan@contoso.com" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json new file mode 100644 index 000000000000..bb6d1deacbdf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "importRequestId": "importRequestId" + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", + "type": "Microsoft.Billing/importRequests", + "name": "importRequestId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "projectId": "projectId", + "billingAccountId": "billingAccountId", + "devTestUsageContext": "devTestUsageContextId", + "standardUsageContext": "standardUsageContext", + "importRequestStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "extendedImportRequestStatus": [ + { + "productType": "Subscription", + "productId": "subscriptionId", + "importRequestStatus": "InProgress" + }, + { + "productType": "ReservedInstance", + "productId": "reservedInstanceId", + "importRequestStatus": "InProgress" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientImportRequest.json new file mode 100644 index 000000000000..65607fd7250d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientImportRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "importRequestId": "importRequestId" + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", + "type": "Microsoft.Billing/importRequests", + "name": "importRequestId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "allowedSubscriptionType": [ + "DevTest", + "Standard" + ], + "importRequestStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "extendedImportRequestStatus": [ + { + "productType": "Subscription", + "productId": "subscriptionId", + "importRequestStatus": "InProgress" + }, + { + "productType": "ReservedInstance", + "productId": "reservedInstanceId", + "importRequestStatus": "InProgress" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateImportRequest.json new file mode 100644 index 000000000000..ebd098cb5b27 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateImportRequest.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "billingAccountId", + "projectId": "projectId", + "body": { + "properties": { + "devTestUsageContext": "devTestUsageContextId", + "standardUsageContext": "standardUsageContext", + "recipientEmailId": "user@contoso.com" + + } + } + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", + "type": "Microsoft.Billing/importRequests", + "name": "importRequestId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "projectId": "projectId", + "billingAccountId": "billingAccountId", + "devTestUsageContext": "devTestUsageContextId", + "standardUsageContext": "standardUsageContext", + "importRequestStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:40:01 PM" + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json new file mode 100644 index 000000000000..03fdb36b8f91 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid", + "$top": 1, + "$filter": "invoicePeriodStartDate le 2017-02-01", + "$expand": "downloadUrl" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "name": "2017-02-05-123456789", + "type": "Microsoft.Billing/invoices", + "properties": { + "invoicePeriodStartDate": "2017-01-01", + "invoicePeriodEndDate": "2017-02-01", + "billingPeriodIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" + ], + "downloadUrl": { + "expiryTime": "2017-02-13T20:46:30Z", + "url": "https://microsoft.com" + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json new file mode 100644 index 000000000000..f8e64db95d4f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid", + "invoiceName": "2017-02-05-123456789" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "name": "2017-02-05-123456789", + "type": "Microsoft.Billing/invoices", + "properties": { + "invoicePeriodStartDate": "2017-01-01", + "invoicePeriodEndDate": "2017-02-01", + "billingPeriodIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" + ], + "downloadUrl": { + "expiryTime": "2017-02-13T20:46:30Z", + "url": "https://microsoft.com" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json new file mode 100644 index 000000000000..c6ab612cee50 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "name": "2017-02-05-123456789", + "type": "Microsoft.Billing/invoices", + "properties": { + "invoicePeriodStartDate": "2017-01-01", + "invoicePeriodEndDate": "2017-02-01", + "billingPeriodIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" + ], + "downloadUrl": { + "expiryTime": "2017-02-13T20:46:30Z", + "url": "https://microsoft.com" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json new file mode 100644 index 000000000000..0d02496eef91 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "name": "2017-02-05-123456789", + "type": "Microsoft.Billing/invoices", + "properties": { + "invoicePeriodStartDate": "2017-01-01", + "invoicePeriodEndDate": "2017-02-01", + "billingPeriodIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json new file mode 100644 index 000000000000..1babfab35cdf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", + "projectId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da" + }, + + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", + "type": "Microsoft.Billing/importRequests", + "name": "importRequestId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "projectId": "projectId", + "billingAccountId": "billingAccountId", + "devTestUsageContext": "devTestUsageContextId", + "standardUsageContext": "standardUsageContext", + "importRequestStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "extendedImportRequestStatus": [ + { + "productType": "Subscription", + "productId": "subscriptionId", + "importRequestStatus": "InProgress" + }, + { + "productType": "ReservedInstance", + "productId": "reservedInstanceId", + "importRequestStatus": "InProgress" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientImportRequests.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientImportRequests.json new file mode 100644 index 000000000000..32fd914fd9c3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientImportRequests.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview" + }, + + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", + "type": "Microsoft.Billing/importRequests", + "name": "importRequestId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "allowedSubscriptionType": [ + "DevTest", + "Standard" + ], + "importRequestStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "extendedImportRequestStatus": [ + { + "productType": "Subscription", + "productId": "subscriptionId", + "importRequestStatus": "InProgress" + }, + { + "productType": "ReservedInstance", + "productId": "reservedInstanceId", + "importRequestStatus": "InProgress" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file From cf9f5da820f412031d5b2b15ca14d12ba3849485 Mon Sep 17 00:00:00 2001 From: "REDMOND\\sakulkar" Date: Fri, 19 Oct 2018 15:17:06 -0700 Subject: [PATCH 2/4] Taking CR comments. --- .../preview/2018-08-01-preview/billing.json | 174 ++++++++---------- .../examples/GetImportRequest.json | 2 + .../examples/ListImportRequests.json | 4 +- 3 files changed, 85 insertions(+), 95 deletions(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json index beb61bb408f8..4d270f24ba0b 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json @@ -171,10 +171,10 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "billingPeriodName", @@ -220,10 +220,10 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "$expand", @@ -289,10 +289,10 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "invoiceName", @@ -332,10 +332,10 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -363,7 +363,7 @@ "description": "Lists all of the available billing REST API operations.", "parameters": [ { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -396,13 +396,13 @@ }, "parameters": [ { - "$ref": "#/parameters/billingAccountIdParameter" + "$ref": "#/parameters/BillingAccountIdParameter" }, { - "$ref": "#/parameters/projectIdParameter" + "$ref": "#/parameters/ProjectIdParameter" }, { - "$ref": "#/parameters/initiateImportRequestParameter" + "$ref": "#/parameters/InitiateImportRequestParameter" } ], "tags": [ @@ -412,10 +412,7 @@ "200": { "description": "Initiated import request details.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/importRequestDetails" - } + "$ref": "#/definitions/ImportRequestDetails" } }, "default": { @@ -438,13 +435,13 @@ }, "parameters": [ { - "$ref": "#/parameters/billingAccountIdParameter" + "$ref": "#/parameters/BillingAccountIdParameter" }, { - "$ref": "#/parameters/projectIdParameter" + "$ref": "#/parameters/ProjectIdParameter" }, { - "$ref": "#/parameters/importRequestIdParameter" + "$ref": "#/parameters/ImportRequestIdParameter" } ], "tags": [ @@ -454,10 +451,7 @@ "200": { "description": "Details of import request.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/importRequestDetails" - } + "$ref": "#/definitions/ImportRequestDetails" } }, "default": { @@ -478,13 +472,13 @@ }, "parameters": [ { - "$ref": "#/parameters/billingAccountIdParameter" + "$ref": "#/parameters/BillingAccountIdParameter" }, { - "$ref": "#/parameters/projectIdParameter" + "$ref": "#/parameters/ProjectIdParameter" }, { - "$ref": "#/parameters/importRequestIdParameter" + "$ref": "#/parameters/ImportRequestIdParameter" } ], "tags": [ @@ -494,10 +488,7 @@ "200": { "description": "Details of canceled import request.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/importRequestDetails" - } + "$ref": "#/definitions/ImportRequestDetails" } }, "default": { @@ -520,10 +511,10 @@ }, "parameters": [ { - "$ref": "#/parameters/billingAccountIdParameter" + "$ref": "#/parameters/BillingAccountIdParameter" }, { - "$ref": "#/parameters/projectIdParameter" + "$ref": "#/parameters/ProjectIdParameter" } ], "tags": [ @@ -533,10 +524,7 @@ "200": { "description": "List of import requests initiated from this project.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/importRequestDetailsListResult" - } + "$ref": "#/definitions/ImportRequestDetailsListResult" } }, "default": { @@ -545,6 +533,9 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -559,10 +550,10 @@ }, "parameters": [ { - "$ref": "#/parameters/importRequestIdParameter" + "$ref": "#/parameters/ImportRequestIdParameter" }, { - "$ref": "#/parameters/acceptImportRequestParameter" + "$ref": "#/parameters/AcceptImportRequestParameter" } ], "tags": [ @@ -572,10 +563,7 @@ "200": { "description": "Details of the accepted import request.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/recipientImportRequestDetails" - } + "$ref": "#/definitions/RecipientImportRequestDetails" } }, "default": { @@ -598,7 +586,7 @@ }, "parameters": [ { - "$ref": "#/parameters/importRequestIdParameter" + "$ref": "#/parameters/ImportRequestIdParameter" } ], "tags": [ @@ -608,10 +596,7 @@ "200": { "description": "Details of the declined import request.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/recipientImportRequestDetails" - } + "$ref": "#/definitions/RecipientImportRequestDetails" } }, "default": { @@ -634,7 +619,7 @@ }, "parameters": [ { - "$ref": "#/parameters/importRequestIdParameter" + "$ref": "#/parameters/ImportRequestIdParameter" } ], "tags": [ @@ -644,10 +629,7 @@ "200": { "description": "Details of the import requests with given Id.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/recipientImportRequestDetails" - } + "$ref": "#/definitions/RecipientImportRequestDetails" } }, "default": { @@ -675,10 +657,7 @@ "200": { "description": "List of import requests received by caller.", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/recipientImportRequestDetailsListResult" - } + "$ref": "#/definitions/RecipientImportRequestDetailsListResult" } }, "default": { @@ -687,6 +666,9 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } } @@ -974,18 +956,18 @@ }, "x-ms-azure-resource": true }, - "initiateImportRequest": { + "InitiateImportRequest": { "type": "object", "description": "Request parameters to initiate import request.", "properties": { "properties": { "description": "Request parameters to initiate import request.", "x-ms-client-flatten": true, - "$ref": "#/definitions/initiateImportRequestProperties" + "$ref": "#/definitions/InitiateImportRequestProperties" } } }, - "initiateImportRequestProperties": { + "InitiateImportRequestProperties": { "type": "object", "description": "Request parameters to initiate import request.", "properties": { @@ -1003,18 +985,18 @@ } } }, - "acceptImportRequest": { + "AcceptImportRequest": { "type": "object", "description": "Request parameters to accept import request.", "properties": { "properties": { "description": "Request parameters to accept import request.", "x-ms-client-flatten": true, - "$ref": "#/definitions/acceptImportRequestProperties" + "$ref": "#/definitions/AcceptImportRequestProperties" } } }, - "acceptImportRequestProperties": { + "AcceptImportRequestProperties": { "type": "object", "description": "Request parameters to accept import request.", "properties": { @@ -1022,18 +1004,18 @@ "description": "Request parameters to accept import request.", "type": "array", "items": { - "$ref": "#/definitions/productDetails" + "$ref": "#/definitions/ProductDetails" } } } }, - "productDetails": { + "ProductDetails": { "type": "object", "description": "Details of the product to be imported.", "properties": { "productType": { "description": "Type of the prouct to be imported.", - "$ref": "#/definitions/productType" + "$ref": "#/definitions/ProductType" }, "productId": { "type": "string", @@ -1041,7 +1023,7 @@ } } }, - "productType": { + "ProductType": { "type": "string", "description": "Type of the product to be imported.", "enum": [ @@ -1053,29 +1035,29 @@ "modelAsString": true } }, - "importRequestDetails": { + "ImportRequestDetails": { "type": "object", "description": "Details of the import request.", "properties": { "properties": { "description": "Details of the import request.", "x-ms-client-flatten": true, - "$ref": "#/definitions/importRequestProperties" + "$ref": "#/definitions/ImportRequestProperties" } } }, - "recipientImportRequestDetails": { + "RecipientImportRequestDetails": { "type": "object", "description": "Details of the import request.", "properties": { "properties": { "description": "Details of the import request.", "x-ms-client-flatten": true, - "$ref": "#/definitions/recipientImportRequestProperties" + "$ref": "#/definitions/RecipientImportRequestProperties" } } }, - "extendedImportRequestStatus": { + "ExtendedImportRequestStatus": { "type": "object", "description": "Detailed import request status.", "properties": { @@ -1096,11 +1078,11 @@ }, "errorDetails": { "description": "Error details for import request execution.", - "$ref": "#/definitions/error" + "$ref": "#/definitions/Error" } } }, - "error": { + "Error": { "description": "Error details for import request execution.", "properties": { "errorCode": { @@ -1115,7 +1097,7 @@ } } }, - "subscriptionType": { + "SubscriptionType": { "type": "string", "description": "Type of the subscriptions that can be imported.", "enum": [ @@ -1127,17 +1109,19 @@ "modelAsString": true } }, - "importRequestProperties": { + "ImportRequestProperties": { "description": "Import request details", "type": "object", "properties": { "creationTime": { "type": "string", + "format": "date-time", "description": "Import request creation time.", "readOnly": true }, "expirationTime": { "type": "string", + "format": "date-time", "readOnly": true, "description": "Import request expiration time." }, @@ -1154,7 +1138,7 @@ "devTestUsageContext": { "type": "string", "readOnly": true, - "description": "Target usage ontext for dev-test susbcriptions." + "description": "Target usage context for dev-test susbcriptions." }, "standardUsageContext": { "type": "string", @@ -1183,6 +1167,7 @@ }, "lastModifiedTime": { "type": "string", + "format": "date-time", "readOnly": true, "description": "Import request last modification time." }, @@ -1191,22 +1176,24 @@ "readOnly": true, "description": "Detailed import request status.", "items": { - "$ref": "#/definitions/extendedImportRequestStatus" + "$ref": "#/definitions/ExtendedImportRequestStatus" } } } }, - "recipientImportRequestProperties": { + "RecipientImportRequestProperties": { "description": "Import request Details.", "type": "object", "properties": { "creationTime": { "type": "string", + "format": "date-time", "description": "Import request creation time.", "readOnly": true }, "expirationTime": { "type": "string", + "format": "date-time", "readOnly": true, "description": "Import request expiration time." }, @@ -1215,7 +1202,7 @@ "readOnly": true, "description": "Type of subscriptions that can be imported.", "items": { - "$ref": "#/definitions/subscriptionType" + "$ref": "#/definitions/SubscriptionType" } }, "importRequestStatus": { @@ -1240,6 +1227,7 @@ }, "lastModifiedTime": { "type": "string", + "format": "date-time", "readOnly": true, "description": "Import request last modification time." }, @@ -1248,12 +1236,12 @@ "readOnly": true, "description": "Detailed import request status.", "items": { - "$ref": "#/definitions/extendedImportRequestStatus" + "$ref": "#/definitions/ExtendedImportRequestStatus" } } } }, - "recipientImportRequestDetailsListResult": { + "RecipientImportRequestDetailsListResult": { "description": "Result of listing details of the import request received by caller.", "properties": { "value": { @@ -1261,7 +1249,7 @@ "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/recipientImportRequestDetails" + "$ref": "#/definitions/RecipientImportRequestDetails" } }, "nextLink": { @@ -1271,7 +1259,7 @@ } } }, - "importRequestDetailsListResult": { + "ImportRequestDetailsListResult": { "description": "Result of listing details of the import request initiated by caller.", "properties": { "value": { @@ -1279,7 +1267,7 @@ "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/importRequestDetails" + "$ref": "#/definitions/ImportRequestDetails" } }, "nextLink": { @@ -1291,21 +1279,21 @@ } }, "parameters": { - "apiVersionParameter": { + "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Version of the API to be used with the client request. The current version is 2018-03-01-preview." }, - "subscriptionIdParameter": { + "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "description": "Azure Subscription ID.", "required": true, "type": "string" }, - "billingAccountIdParameter": { + "BillingAccountIdParameter": { "name": "billingAccountId", "x-ms-parameter-location": "method", "in": "path", @@ -1313,7 +1301,7 @@ "type": "string", "description": "Billing account Id." }, - "projectIdParameter": { + "ProjectIdParameter": { "name": "projectId", "x-ms-parameter-location": "method", "in": "path", @@ -1321,7 +1309,7 @@ "type": "string", "description": "Project Id." }, - "importRequestIdParameter": { + "ImportRequestIdParameter": { "name": "importRequestId", "x-ms-parameter-location": "method", "in": "path", @@ -1329,24 +1317,24 @@ "type": "string", "description": "Import request Id." }, - "initiateImportRequestParameter": { + "InitiateImportRequestParameter": { "name": "body", "x-ms-parameter-location": "method", "in": "body", "required": true, "description": "Initiate import request parameters.", "schema": { - "$ref": "#/definitions/initiateImportRequest" + "$ref": "#/definitions/InitiateImportRequest" } }, - "acceptImportRequestParameter": { + "AcceptImportRequestParameter": { "name": "body", "x-ms-parameter-location": "method", "in": "body", "required": true, "description": "Accept import request parameters.", "schema": { - "$ref": "#/definitions/acceptImportRequest" + "$ref": "#/definitions/AcceptImportRequest" } } }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json index bb6d1deacbdf..9d40f3ea9fbb 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json @@ -1,6 +1,8 @@ { "parameters": { "api-version": "2018-08-01-preview", + "billingAccountId": "billingAccountId", + "projectId": "projectId", "importRequestId": "importRequestId" }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json index 1babfab35cdf..9a9bf067c5df 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json @@ -1,8 +1,8 @@ { "parameters": { "api-version": "2018-08-01-preview", - "billingAccountId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da", - "projectId": "276e7ae4-84d0-4da6-ab4b-d6b94f3557da" + "billingAccountId": "billingAccountId", + "projectId": "projectId" }, "responses": { From a69067bea15516a979589eab798777b1c67806ba Mon Sep 17 00:00:00 2001 From: "REDMOND\\sakulkar" Date: Fri, 19 Oct 2018 15:37:21 -0700 Subject: [PATCH 3/4] Taking CR comments. --- .../preview/2018-08-01-preview/billing.json | 43 +++++++++++++++++-- 1 file changed, 39 insertions(+), 4 deletions(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json index 4d270f24ba0b..af74966f47cb 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json @@ -30,7 +30,7 @@ "description": "Lists the enrollment accounts the caller has access to.", "parameters": [ { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -73,7 +73,7 @@ "type": "string" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -109,10 +109,10 @@ }, "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/apiVersionParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { "name": "$filter", @@ -1063,6 +1063,7 @@ "properties": { "productType": { "type": "string", + "$ref": "#/definitions/ProductType", "readOnly": true, "description": "Type of product being imported." }, @@ -1073,6 +1074,7 @@ }, "importRequestStatus": { "type": "string", + "$ref": "#/definitions/ProductImportRequestStatus", "readOnly": true, "description": "Import request status." }, @@ -1147,6 +1149,7 @@ }, "importRequestStatus": { "type": "string", + "$ref": "#/definitions/ImportRequestStatus", "description": "Overall import request status.", "readOnly": true }, @@ -1207,6 +1210,7 @@ }, "importRequestStatus": { "type": "string", + "$ref": "#/definitions/ImportRequestStatus", "description": "Overall import request status.", "readOnly": true }, @@ -1241,6 +1245,37 @@ } } }, + "ImportRequestStatus": { + "type": "string", + "description": "Possible import request status.", + "enum": [ + "Pending", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed", + "Canceled", + "Declined" + ], + "x-ms-enum": { + "name": "importRequestStatus", + "modelAsString": true + } + }, + "ProductImportRequestStatus": { + "type": "string", + "description": "Possible import request status.", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "Failed", + ], + "x-ms-enum": { + "name": "productImportRequestStatus", + "modelAsString": true + } + }, "RecipientImportRequestDetailsListResult": { "description": "Result of listing details of the import request received by caller.", "properties": { From 00929e5f098aa4815bb216071aa6f22d5bc0e170 Mon Sep 17 00:00:00 2001 From: "REDMOND\\sakulkar" Date: Fri, 16 Nov 2018 14:53:35 -0800 Subject: [PATCH 4/4] [Microsoft.Billing]: Updating swagger with rename changes required. --- .../preview/2018-08-01-preview/billing.json | 353 +++++++++--------- ...ImportRequest.json => AcceptTransfer.json} | 29 +- ...ImportRequest.json => CancelTransfer.json} | 16 +- ...mportRequest.json => DeclineTransfer.json} | 15 +- ...Request.json => GetRecipientTransfer.json} | 25 +- ...GetImportRequest.json => GetTransfer.json} | 26 +- ...portRequest.json => InitiateTransfer.json} | 17 +- ...uests.json => ListRecipientTransfers.json} | 21 +- ...ImportRequests.json => ListTransfers.json} | 24 +- 9 files changed, 254 insertions(+), 272 deletions(-) rename specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/{AcceptImportRequest.json => AcceptTransfer.json} (55%) rename specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/{CancelImportRequest.json => CancelTransfer.json} (59%) rename specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/{DeclineImportRequest.json => DeclineTransfer.json} (57%) rename specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/{GetRecipientImportRequest.json => GetRecipientTransfer.json} (52%) rename specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/{GetImportRequest.json => GetTransfer.json} (53%) rename specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/{InitiateImportRequest.json => InitiateTransfer.json} (58%) rename specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/{ListRecipientImportRequests.json => ListRecipientTransfers.json} (60%) rename specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/{ListImportRequests.json => ListTransfers.json} (56%) diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json index af74966f47cb..069933f95a46 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json @@ -385,13 +385,13 @@ } } }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/projects/{projectId}/initiateImportRequest": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/initiateTransfer": { "post": { - "description": "Initiates the request to import the GTM or legacy subscriptions or RIs to GTM.", - "operationId": "ImportRequest_Initiate", + "description": "Initiates the request to transfer the GTM or legacy subscriptions or RIs to GTM.", + "operationId": "Transfer_Initiate", "x-ms-examples": { - "InitiateImportRequest": { - "$ref": "./examples/InitiateImportRequest.json" + "InitiateTransfer": { + "$ref": "./examples/InitiateTransfer.json" } }, "parameters": [ @@ -399,10 +399,10 @@ "$ref": "#/parameters/BillingAccountIdParameter" }, { - "$ref": "#/parameters/ProjectIdParameter" + "$ref": "#/parameters/InvoiceSectionIdParameter" }, { - "$ref": "#/parameters/InitiateImportRequestParameter" + "$ref": "#/parameters/InitiateTransferRequestParameter" } ], "tags": [ @@ -410,9 +410,9 @@ ], "responses": { "200": { - "description": "Initiated import request details.", + "description": "Initiated transfer details.", "schema": { - "$ref": "#/definitions/ImportRequestDetails" + "$ref": "#/definitions/TransferDetails" } }, "default": { @@ -424,13 +424,13 @@ } } }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/projects/{projectId}/importRequests/{importRequestId}": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/transfers/{transferId}": { "get": { - "description": "Gets the import request details for given import request Id.", - "operationId": "ImportRequest_Get", + "description": "Gets the transfer details for given transfer Id.", + "operationId": "Transfer_Get", "x-ms-examples": { - "ImportRequestGet": { - "$ref": "./examples/GetImportRequest.json" + "TransferGet": { + "$ref": "./examples/GetTransfer.json" } }, "parameters": [ @@ -438,10 +438,10 @@ "$ref": "#/parameters/BillingAccountIdParameter" }, { - "$ref": "#/parameters/ProjectIdParameter" + "$ref": "#/parameters/InvoiceSectionIdParameter" }, { - "$ref": "#/parameters/ImportRequestIdParameter" + "$ref": "#/parameters/TransferIdParameter" } ], "tags": [ @@ -449,9 +449,9 @@ ], "responses": { "200": { - "description": "Details of import request.", + "description": "Details of transfer.", "schema": { - "$ref": "#/definitions/ImportRequestDetails" + "$ref": "#/definitions/TransferDetails" } }, "default": { @@ -463,11 +463,11 @@ } }, "delete": { - "description": "Cancels the import request for given import request Id.", - "operationId": "ImportRequest_Cancel", + "description": "Cancels the transfer for given transfer Id.", + "operationId": "Transfer_Cancel", "x-ms-examples": { - "ImportRequestCancel": { - "$ref": "./examples/CancelImportRequest.json" + "TransferCancel": { + "$ref": "./examples/CancelTransfer.json" } }, "parameters": [ @@ -475,10 +475,10 @@ "$ref": "#/parameters/BillingAccountIdParameter" }, { - "$ref": "#/parameters/ProjectIdParameter" + "$ref": "#/parameters/InvoiceSectionIdParameter" }, { - "$ref": "#/parameters/ImportRequestIdParameter" + "$ref": "#/parameters/TransferIdParameter" } ], "tags": [ @@ -486,9 +486,9 @@ ], "responses": { "200": { - "description": "Details of canceled import request.", + "description": "Details of canceled transfer.", "schema": { - "$ref": "#/definitions/ImportRequestDetails" + "$ref": "#/definitions/TransferDetails" } }, "default": { @@ -500,13 +500,13 @@ } } }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/projects/{projectId}/importRequests": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/transfers": { "get": { - "description": "Lists all import requests' details initiated from given project.", - "operationId": "ImportRequests_List", + "description": "Lists all transfer's details initiated from given invoice section.", + "operationId": "Transfers_List", "x-ms-examples": { - "ImportRequestsList": { - "$ref": "./examples/ListImportRequests.json" + "TransfersList": { + "$ref": "./examples/ListTransfers.json" } }, "parameters": [ @@ -514,7 +514,7 @@ "$ref": "#/parameters/BillingAccountIdParameter" }, { - "$ref": "#/parameters/ProjectIdParameter" + "$ref": "#/parameters/InvoiceSectionIdParameter" } ], "tags": [ @@ -522,9 +522,9 @@ ], "responses": { "200": { - "description": "List of import requests initiated from this project.", + "description": "List of transfers initiated from this invoice section.", "schema": { - "$ref": "#/definitions/ImportRequestDetailsListResult" + "$ref": "#/definitions/TransferDetailsListResult" } }, "default": { @@ -539,21 +539,21 @@ } } }, - "/providers/Microsoft.Billing/importRequests/{importRequestId}/acceptImportRequest": { + "/providers/Microsoft.Billing/transfers/{transferId}/acceptTransfer": { "post": { - "summary": "Accepts the import request with given import request Id.", - "operationId": "ImportRequest_Accept", + "summary": "Accepts the transfer with given transfer Id.", + "operationId": "Transfer_Accept", "x-ms-examples": { - "AcceptImportRequest": { - "$ref": "./examples/AcceptImportRequest.json" + "AcceptTransfer": { + "$ref": "./examples/AcceptTransfer.json" } }, "parameters": [ { - "$ref": "#/parameters/ImportRequestIdParameter" + "$ref": "#/parameters/TransferIdParameter" }, { - "$ref": "#/parameters/AcceptImportRequestParameter" + "$ref": "#/parameters/AcceptTransferRequestParameter" } ], "tags": [ @@ -561,9 +561,9 @@ ], "responses": { "200": { - "description": "Details of the accepted import request.", + "description": "Details of the accepted transfer.", "schema": { - "$ref": "#/definitions/RecipientImportRequestDetails" + "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { @@ -575,18 +575,18 @@ } } }, - "/providers/Microsoft.Billing/importRequests/{importRequestId}/declineImportRequest": { + "/providers/Microsoft.Billing/transfers/{transferId}/declineTransfer": { "post": { - "summary": "Declines the import request with given import request Id.", - "operationId": "ImportRequest_Decline", + "summary": "Declines the transfer with given transfer Id.", + "operationId": "Transfer_Decline", "x-ms-examples": { - "DeclineImportRequest": { - "$ref": "./examples/DeclineImportRequest.json" + "DeclineTransfer": { + "$ref": "./examples/DeclineTransfer.json" } }, "parameters": [ { - "$ref": "#/parameters/ImportRequestIdParameter" + "$ref": "#/parameters/TransferIdParameter" } ], "tags": [ @@ -594,9 +594,9 @@ ], "responses": { "200": { - "description": "Details of the declined import request.", + "description": "Details of the declined transfer.", "schema": { - "$ref": "#/definitions/RecipientImportRequestDetails" + "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { @@ -608,18 +608,18 @@ } } }, - "/providers/Microsoft.Billing/importRequests/{importRequestId}/": { + "/providers/Microsoft.Billing/transfers/{transferId}/": { "get": { - "summary": "Gets the import request with given import request Id.", - "operationId": "RecipientImportRequest_Get", + "summary": "Gets the transfer with given transfer Id.", + "operationId": "RecipientTransfer_Get", "x-ms-examples": { - "RecipientImportRequestGet": { - "$ref": "./examples/GetRecipientImportRequest.json" + "RecipientTransferGet": { + "$ref": "./examples/GetRecipientTransfer.json" } }, "parameters": [ { - "$ref": "#/parameters/ImportRequestIdParameter" + "$ref": "#/parameters/TransferIdParameter" } ], "tags": [ @@ -627,9 +627,9 @@ ], "responses": { "200": { - "description": "Details of the import requests with given Id.", + "description": "Details of the transfers with given Id.", "schema": { - "$ref": "#/definitions/RecipientImportRequestDetails" + "$ref": "#/definitions/RecipientTransferDetails" } }, "default": { @@ -641,13 +641,13 @@ } } }, - "/providers/Microsoft.Billing/importRequests": { + "/providers/Microsoft.Billing/transfers": { "get": { - "summary": "Lists the import requests received by caller.", - "operationId": "RecipientImportRequest_List", + "summary": "Lists the transfers received by caller.", + "operationId": "RecipientTransfer_List", "x-ms-examples": { - "RecipientImportRequestsList": { - "$ref": "./examples/ListRecipientImportRequests.json" + "RecipientTransfersList": { + "$ref": "./examples/ListRecipientTransfers.json" } }, "tags": [ @@ -655,9 +655,9 @@ ], "responses": { "200": { - "description": "List of import requests received by caller.", + "description": "List of transfers received by caller.", "schema": { - "$ref": "#/definitions/RecipientImportRequestDetailsListResult" + "$ref": "#/definitions/RecipientTransferDetailsListResult" } }, "default": { @@ -956,52 +956,48 @@ }, "x-ms-azure-resource": true }, - "InitiateImportRequest": { + "InitiateTransferRequest": { "type": "object", - "description": "Request parameters to initiate import request.", + "description": "Request parameters to initiate transfer.", "properties": { "properties": { - "description": "Request parameters to initiate import request.", + "description": "Request parameters to initiate transfer.", "x-ms-client-flatten": true, - "$ref": "#/definitions/InitiateImportRequestProperties" + "$ref": "#/definitions/InitiateTransferProperties" } } }, - "InitiateImportRequestProperties": { + "InitiateTransferProperties": { "type": "object", - "description": "Request parameters to initiate import request.", + "description": "Request parameters to initiate transfer.", "properties": { - "devTestUsageContext": { + "billingProfileId": { "type": "string", "description": "Target Usage context for devTest subscriptions." }, - "standardUsageContext": { - "type": "string", - "description": "Target Usage context for standard subscriptions." - }, "recipientEmailId": { "type": "string", - "description": "Email Id of recipient for import request." + "description": "Email Id of recipient for transfer." } } }, - "AcceptImportRequest": { + "AcceptTransferRequest": { "type": "object", - "description": "Request parameters to accept import request.", + "description": "Request parameters to accept transfer.", "properties": { "properties": { - "description": "Request parameters to accept import request.", + "description": "Request parameters to accept transfer.", "x-ms-client-flatten": true, - "$ref": "#/definitions/AcceptImportRequestProperties" + "$ref": "#/definitions/AcceptTransferProperties" } } }, - "AcceptImportRequestProperties": { + "AcceptTransferProperties": { "type": "object", - "description": "Request parameters to accept import request.", + "description": "Request parameters to accept transfer.", "properties": { "productDetails": { - "description": "Request parameters to accept import request.", + "description": "Request parameters to accept transfer.", "type": "array", "items": { "$ref": "#/definitions/ProductDetails" @@ -1011,81 +1007,81 @@ }, "ProductDetails": { "type": "object", - "description": "Details of the product to be imported.", + "description": "Details of the product to be transferred.", "properties": { "productType": { - "description": "Type of the prouct to be imported.", + "description": "Type of the prouct to be transferred.", "$ref": "#/definitions/ProductType" }, "productId": { "type": "string", - "description": "Id of product to be imported." + "description": "Id of product to be transferred." } } }, "ProductType": { "type": "string", - "description": "Type of the product to be imported.", + "description": "Type of the product to be transferred.", "enum": [ - "Subscription", - "ReservedInstance" + "AzureSubscription", + "AzureReservation" ], "x-ms-enum": { "name": "productType", "modelAsString": true } }, - "ImportRequestDetails": { + "TransferDetails": { "type": "object", - "description": "Details of the import request.", + "description": "Details of the transfer.", "properties": { "properties": { - "description": "Details of the import request.", + "description": "Details of the transfer.", "x-ms-client-flatten": true, - "$ref": "#/definitions/ImportRequestProperties" + "$ref": "#/definitions/TransferProperties" } } }, - "RecipientImportRequestDetails": { + "RecipientTransferDetails": { "type": "object", - "description": "Details of the import request.", + "description": "Details of the transfer.", "properties": { "properties": { - "description": "Details of the import request.", + "description": "Details of the transfer.", "x-ms-client-flatten": true, - "$ref": "#/definitions/RecipientImportRequestProperties" + "$ref": "#/definitions/RecipientTransferProperties" } } }, - "ExtendedImportRequestStatus": { + "DetailedTransferStatus": { "type": "object", - "description": "Detailed import request status.", + "description": "Detailed transfer status.", "properties": { "productType": { "type": "string", "$ref": "#/definitions/ProductType", "readOnly": true, - "description": "Type of product being imported." + "description": "Type of product being transferred." }, "productId": { "type": "string", "readOnly": true, - "description": "Id of product being imported." + "description": "Id of product being transferred." }, - "importRequestStatus": { + "transferStatus": { "type": "string", - "$ref": "#/definitions/ProductImportRequestStatus", + "$ref": "#/definitions/ProductTransferStatus", "readOnly": true, - "description": "Import request status." + "description": "Transfer status." }, "errorDetails": { - "description": "Error details for import request execution.", + "description": "Error details for transfer execution.", "$ref": "#/definitions/Error" } } }, "Error": { - "description": "Error details for import request execution.", + "description": "Error details for transfer execution.", "properties": { "errorCode": { "type": "string", @@ -1099,37 +1095,38 @@ } } }, - "SubscriptionType": { + "EligibleProductType": { "type": "string", - "description": "Type of the subscriptions that can be imported.", + "description": "Type of the products that can be transferred.", "enum": [ - "DevTest", - "Standard" + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" ], "x-ms-enum": { - "name": "subscriptionType", + "name": "eligibleProductType", "modelAsString": true } }, - "ImportRequestProperties": { - "description": "Import request details", + "TransferProperties": { + "description": "Transfer details", "type": "object", "properties": { "creationTime": { "type": "string", "format": "date-time", - "description": "Import request creation time.", + "description": "Transfer creation time.", "readOnly": true }, "expirationTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Import request expiration time." + "description": "Transfer expiration time." }, - "projectId": { + "invoiceSectionId": { "type": "string", - "description": "Target project Id.", + "description": "Target invoice setion Id.", "readOnly": true }, "billingAccountId": { @@ -1137,117 +1134,107 @@ "description": "Target billing account Id.", "readOnly": true }, - "devTestUsageContext": { - "type": "string", - "readOnly": true, - "description": "Target usage context for dev-test susbcriptions." - }, - "standardUsageContext": { + "transferStatus": { "type": "string", - "description": "Target usage context for standard subscriptions.", - "readOnly": true - }, - "importRequestStatus": { - "type": "string", - "$ref": "#/definitions/ImportRequestStatus", - "description": "Overall import request status.", + "$ref": "#/definitions/TransferStatus", + "description": "Overall transfer status.", "readOnly": true }, "recipientEmailId": { "type": "string", "readOnly": true, - "description": "Email Id of recipient of import request." + "description": "Email Id of recipient of transfer." }, "initiatorEmailId": { "type": "string", "readOnly": true, - "description": "Email Id of initiator of import request." + "description": "Email Id of initiator of transfer." }, "canceledBy": { "type": "string", "readOnly": true, - "description": "Email Id who user canceled the import request." + "description": "Email Id who user canceled the transfer." }, "lastModifiedTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Import request last modification time." + "description": "Transfer last modification time." }, - "extendedImportRequestStatus": { + "detailedTransferStatus": { "type": "array", "readOnly": true, - "description": "Detailed import request status.", + "description": "Detailed transfer status.", "items": { - "$ref": "#/definitions/ExtendedImportRequestStatus" + "$ref": "#/definitions/DetailedTransferStatus" } } } }, - "RecipientImportRequestProperties": { - "description": "Import request Details.", + "RecipientTransferProperties": { + "description": "Transfer Details.", "type": "object", "properties": { "creationTime": { "type": "string", "format": "date-time", - "description": "Import request creation time.", + "description": "Transfer creation time.", "readOnly": true }, "expirationTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Import request expiration time." + "description": "Transfer expiration time." }, - "allowedSubscriptionType": { + "allowedProductType": { "type": "array", "readOnly": true, - "description": "Type of subscriptions that can be imported.", + "description": "Type of subscriptions that can be transferred.", "items": { - "$ref": "#/definitions/SubscriptionType" + "$ref": "#/definitions/EligibleProductType" } }, - "importRequestStatus": { + "transferStatus": { "type": "string", - "$ref": "#/definitions/ImportRequestStatus", - "description": "Overall import request status.", + "$ref": "#/definitions/TransferStatus", + "description": "Overall transfer status.", "readOnly": true }, "recipientEmailId": { "type": "string", "readOnly": true, - "description": "Email Id of recipient of import request." + "description": "Email Id of recipient of transfer." }, "initiatorEmailId": { "type": "string", "readOnly": true, - "description": "Email Id of initiator of import request." + "description": "Email Id of initiator of transfer." }, "canceledBy": { "type": "string", "readOnly": true, - "description": "Email Id who user canceled the import request." + "description": "Email Id who user canceled the transfer." }, "lastModifiedTime": { "type": "string", "format": "date-time", "readOnly": true, - "description": "Import request last modification time." + "description": "Transfer last modification time." }, - "extendedImportRequestStatus": { + "detailedTransferStatus": { "type": "array", "readOnly": true, - "description": "Detailed import request status.", + "description": "Detailed transfer status.", "items": { - "$ref": "#/definitions/ExtendedImportRequestStatus" + "$ref": "#/definitions/DetailedTransferStatus" } } } }, - "ImportRequestStatus": { + "TransferStatus": { "type": "string", - "description": "Possible import request status.", + "description": "Possible transfer status.", "enum": [ "Pending", "InProgress", @@ -1258,33 +1245,33 @@ "Declined" ], "x-ms-enum": { - "name": "importRequestStatus", + "name": "transferStatus", "modelAsString": true } }, - "ProductImportRequestStatus": { + "ProductTransferStatus": { "type": "string", - "description": "Possible import request status.", + "description": "Possible transfer status.", "enum": [ "NotStarted", "InProgress", "Completed", - "Failed", + "Failed" ], "x-ms-enum": { - "name": "productImportRequestStatus", + "name": "productTransferStatus", "modelAsString": true } }, - "RecipientImportRequestDetailsListResult": { - "description": "Result of listing details of the import request received by caller.", + "RecipientTransferDetailsListResult": { + "description": "Result of listing details of the transfer received by caller.", "properties": { "value": { - "description": "The list of import requests received by caller.", + "description": "The list of transfers received by caller.", "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/RecipientImportRequestDetails" + "$ref": "#/definitions/RecipientTransferDetails" } }, "nextLink": { @@ -1294,15 +1281,15 @@ } } }, - "ImportRequestDetailsListResult": { - "description": "Result of listing details of the import request initiated by caller.", + "TransferDetailsListResult": { + "description": "Result of listing details of the transfer initiated by caller.", "properties": { "value": { - "description": "The list of import requests initiated by caller.", + "description": "The list of transfers initiated by caller.", "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/ImportRequestDetails" + "$ref": "#/definitions/TransferDetails" } }, "nextLink": { @@ -1336,40 +1323,40 @@ "type": "string", "description": "Billing account Id." }, - "ProjectIdParameter": { - "name": "projectId", + "InvoiceSectionIdParameter": { + "name": "invoiceSectionId", "x-ms-parameter-location": "method", "in": "path", "required": true, "type": "string", - "description": "Project Id." + "description": "Invoice section Id." }, - "ImportRequestIdParameter": { - "name": "importRequestId", + "TransferIdParameter": { + "name": "transferId", "x-ms-parameter-location": "method", "in": "path", "required": true, "type": "string", - "description": "Import request Id." + "description": "Transfer Id." }, - "InitiateImportRequestParameter": { + "InitiateTransferRequestParameter": { "name": "body", "x-ms-parameter-location": "method", "in": "body", "required": true, - "description": "Initiate import request parameters.", + "description": "Initiate transfer parameters.", "schema": { - "$ref": "#/definitions/InitiateImportRequest" + "$ref": "#/definitions/InitiateTransferRequest" } }, - "AcceptImportRequestParameter": { + "AcceptTransferRequestParameter": { "name": "body", "x-ms-parameter-location": "method", "in": "body", "required": true, - "description": "Accept import request parameters.", + "description": "Accept transfer parameters.", "schema": { - "$ref": "#/definitions/AcceptImportRequest" + "$ref": "#/definitions/AcceptTransferRequest" } } }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json similarity index 55% rename from specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptImportRequest.json rename to specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json index 9d9da817d5ab..c7de2db09d4e 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptImportRequest.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json @@ -1,16 +1,16 @@ { "parameters": { "api-version": "2018-08-01-preview", - "importRequestId": "importRequestId", + "transferId": "transferId", "body": { "properties": { "value": [ { - "productType": "Subscription", + "productType": "AzureSubscription", "productId": "subscriptionId" }, { - "productType": "ReservedInstance", + "productType": "AzureReservation", "productId": "reservedInstanceId" } ] @@ -21,30 +21,31 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", - "type": "Microsoft.Billing/importRequests", - "name": "importRequestId", + "id": "/providers/Microsoft.Billing/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", "properties": { "creationTime": "10/10/2018 9:40:01 PM", "expirationTime": "11/5/2018 4:47:08 AM", "allowedSubscriptionType": [ - "DevTest", - "Standard" + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" ], - "importRequestStatus": "InProgress", + "transferStatus": "InProgress", "recipientEmailId": "user@contoso.com", "initiatorEmailId": "user@contoso.com", "lastModifiedTime": "10/10/2018 9:45:01 PM", - "extendedImportRequestStatus": [ + "detailedTransferStatus": [ { - "productType": "Subscription", + "productType": "AzureSubscription", "productId": "subscriptionId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" }, { - "productType": "ReservedInstance", + "productType": "AzureReservation", "productId": "reservedInstanceId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" } ] } diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json similarity index 59% rename from specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelImportRequest.json rename to specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json index eb79dba56eb4..35e4c74bc9d2 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelImportRequest.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json @@ -2,24 +2,22 @@ "parameters": { "api-version": "2018-08-01-preview", "billingAccountId": "billingAccountId", - "projectId": "projectId", - "importRequestId": "importRequestId" + "invoiceSectionId": "invoiceSectionId", + "transferId": "transferId" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", - "type": "Microsoft.Billing/importRequests", - "name": "importRequestId", + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", "properties": { "creationTime": "10/10/2018 9:40:01 PM", "expirationTime": "11/5/2018 4:47:08 AM", - "projectId": "projectId", + "invoiceSectionId": "invoiceSectionId", "billingAccountId": "billingAccountId", - "devTestUsageContext": "devTestUsageContextId", - "standardUsageContext": "standardUsageContext", - "importRequestStatus": "Pending", + "transferStatus": "Pending", "recipientEmailId": "user@contoso.com", "initiatorEmailId": "user@contoso.com", "canceledBy": "user@contoso.com", diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json similarity index 57% rename from specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineImportRequest.json rename to specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json index db7e5bcaaeb6..664f9e7aec38 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineImportRequest.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json @@ -1,23 +1,24 @@ { "parameters": { "api-version": "2018-08-01-preview", - "importRequestId": "importRequestId" + "transferId": "transferId" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", - "type": "Microsoft.Billing/importRequests", - "name": "importRequestId", + "id": "/providers/Microsoft.Billing/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", "properties": { "creationTime": "10/10/2018 9:40:01 PM", "expirationTime": "11/5/2018 4:47:08 AM", "allowedSubscriptionType": [ - "DevTest", - "Standard" + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" ], - "importRequestStatus": "Declined", + "transferStatus": "Declined", "recipientEmailId": "user@contoso.com", "initiatorEmailId": "user@contoso.com", "lastModifiedTime": "10/10/2018 9:45:01 PM" diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json similarity index 52% rename from specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientImportRequest.json rename to specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json index 65607fd7250d..26c89a52c1e1 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientImportRequest.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json @@ -1,36 +1,37 @@ { "parameters": { "api-version": "2018-08-01-preview", - "importRequestId": "importRequestId" + "transferId": "transferId" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", - "type": "Microsoft.Billing/importRequests", - "name": "importRequestId", + "id": "/providers/Microsoft.Billing/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", "properties": { "creationTime": "10/10/2018 9:40:01 PM", "expirationTime": "11/5/2018 4:47:08 AM", "allowedSubscriptionType": [ - "DevTest", - "Standard" + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" ], - "importRequestStatus": "InProgress", + "transferStatus": "InProgress", "recipientEmailId": "user@contoso.com", "initiatorEmailId": "user@contoso.com", "lastModifiedTime": "10/10/2018 9:45:01 PM", - "extendedImportRequestStatus": [ + "detailedTransferStatus": [ { - "productType": "Subscription", + "productType": "AzureSubscription", "productId": "subscriptionId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" }, { - "productType": "ReservedInstance", + "productType": "AzureReservation", "productId": "reservedInstanceId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" } ] } diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json similarity index 53% rename from specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json rename to specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json index 9d40f3ea9fbb..c31bc82a761a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetImportRequest.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json @@ -2,37 +2,35 @@ "parameters": { "api-version": "2018-08-01-preview", "billingAccountId": "billingAccountId", - "projectId": "projectId", - "importRequestId": "importRequestId" + "invoiceSectionId": "invoiceSectionId", + "transferId": "transferId" }, "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", - "type": "Microsoft.Billing/importRequests", - "name": "importRequestId", + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", "properties": { "creationTime": "10/10/2018 9:40:01 PM", "expirationTime": "11/5/2018 4:47:08 AM", - "projectId": "projectId", + "invoiceSectionId": "invoiceSectionId", "billingAccountId": "billingAccountId", - "devTestUsageContext": "devTestUsageContextId", - "standardUsageContext": "standardUsageContext", - "importRequestStatus": "InProgress", + "transferStatus": "InProgress", "recipientEmailId": "user@contoso.com", "initiatorEmailId": "user@contoso.com", "lastModifiedTime": "10/10/2018 9:45:01 PM", - "extendedImportRequestStatus": [ + "detailedTransferStatus": [ { - "productType": "Subscription", + "productType": "AzureSubscription", "productId": "subscriptionId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" }, { - "productType": "ReservedInstance", + "productType": "AzureReservation", "productId": "reservedInstanceId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" } ] } diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateImportRequest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json similarity index 58% rename from specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateImportRequest.json rename to specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json index ebd098cb5b27..f8e0699f82d1 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateImportRequest.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json @@ -2,11 +2,10 @@ "parameters": { "api-version": "2018-08-01-preview", "billingAccountId": "billingAccountId", - "projectId": "projectId", + "invoiceSectionId": "invoiceSectionId", "body": { "properties": { - "devTestUsageContext": "devTestUsageContextId", - "standardUsageContext": "standardUsageContext", + "billingProfileId": "billingProfileId", "recipientEmailId": "user@contoso.com" } @@ -16,17 +15,15 @@ "responses": { "200": { "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", - "type": "Microsoft.Billing/importRequests", - "name": "importRequestId", + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", "properties": { "creationTime": "10/10/2018 9:40:01 PM", "expirationTime": "11/5/2018 4:47:08 AM", - "projectId": "projectId", + "invoiceSectionId": "invoiceSectionId", "billingAccountId": "billingAccountId", - "devTestUsageContext": "devTestUsageContextId", - "standardUsageContext": "standardUsageContext", - "importRequestStatus": "Pending", + "transferStatus": "Pending", "recipientEmailId": "user@contoso.com", "initiatorEmailId": "user@contoso.com", "lastModifiedTime": "10/10/2018 9:40:01 PM" diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientImportRequests.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json similarity index 60% rename from specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientImportRequests.json rename to specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json index 32fd914fd9c3..b0f3ab3baba4 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientImportRequests.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json @@ -8,30 +8,31 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", - "type": "Microsoft.Billing/importRequests", - "name": "importRequestId", + "id": "/providers/Microsoft.Billing/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", "properties": { "creationTime": "10/10/2018 9:40:01 PM", "expirationTime": "11/5/2018 4:47:08 AM", "allowedSubscriptionType": [ - "DevTest", - "Standard" + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" ], - "importRequestStatus": "InProgress", + "transferStatus": "InProgress", "recipientEmailId": "user@contoso.com", "initiatorEmailId": "user@contoso.com", "lastModifiedTime": "10/10/2018 9:45:01 PM", - "extendedImportRequestStatus": [ + "detailedTransferStatus": [ { - "productType": "Subscription", + "productType": "AzureSubscription", "productId": "subscriptionId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" }, { "productType": "ReservedInstance", "productId": "reservedInstanceId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" } ] } diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json similarity index 56% rename from specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json rename to specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json index 9a9bf067c5df..7fa4f88a1dc1 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListImportRequests.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json @@ -2,7 +2,7 @@ "parameters": { "api-version": "2018-08-01-preview", "billingAccountId": "billingAccountId", - "projectId": "projectId" + "invoiceSectionId": "invoiceSectionId" }, "responses": { @@ -10,30 +10,28 @@ "body": { "value": [ { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/projects/projectId/importRequests/importRequestId", - "type": "Microsoft.Billing/importRequests", - "name": "importRequestId", + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", "properties": { "creationTime": "10/10/2018 9:40:01 PM", "expirationTime": "11/5/2018 4:47:08 AM", - "projectId": "projectId", + "invoiceSectionId": "invoiceSectionId", "billingAccountId": "billingAccountId", - "devTestUsageContext": "devTestUsageContextId", - "standardUsageContext": "standardUsageContext", - "importRequestStatus": "InProgress", + "transferStatus": "InProgress", "recipientEmailId": "user@contoso.com", "initiatorEmailId": "user@contoso.com", "lastModifiedTime": "10/10/2018 9:45:01 PM", - "extendedImportRequestStatus": [ + "detailedTransferStatus": [ { - "productType": "Subscription", + "productType": "AzureSubscription", "productId": "subscriptionId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" }, { - "productType": "ReservedInstance", + "productType": "AzureReservation", "productId": "reservedInstanceId", - "importRequestStatus": "InProgress" + "transferStatus": "InProgress" } ] }