Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding swagger to Microsoft.Billing 2020-05-01 for list billing account and billing profile reservations #13735

Merged
merged 2 commits into from
Apr 2, 2021
Merged

Adding swagger to Microsoft.Billing 2020-05-01 for list billing account and billing profile reservations #13735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7b6fcb
Adding swagger to Microsoft.Billing 2020-05-01 for list billing accou…
gaoyp830 Mar 30, 2021
6ca30ee
Update style
gaoyp830 Mar 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
379 changes: 379 additions & 0 deletions specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3561,6 +3561,143 @@
}
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/reservations": {
"get": {
"tags": [
"Reservations"
],
"x-ms-examples": {
"ReservationsListByBillingAccount": {
"$ref": "./examples/ReservationsListByBillingAccount.json"
}
},
"operationId": "Reservations_ListByBillingAccount",
"description": "Lists the reservations for a billing account and the roll up counts of reservations group by provisioning states.",
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountNameParameter"
},
{
"name": "$filter",
"description": "May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$orderby",
"description": "May be used to sort order by reservation properties.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "refreshSummary",
"description": "To indicate whether to refresh the roll up counts of the reservations group by provisioning states",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "selectedState",
"description": "The selected provisioning state",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ReservationsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/reservations": {
"get": {
"tags": [
"Reservations"
],
"x-ms-examples": {
"ReservationsListByBillingProfile": {
"$ref": "./examples/ReservationsListByBillingProfile.json"
}
},
"operationId": "Reservations_ListByBillingProfile",
"description": "Lists the reservations for a billing profile and the roll up counts of reservations group by provisioning state.",
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountNameParameter"
},
{
"$ref": "#/parameters/billingProfileNameParameter"
},
{
"name": "$filter",
"description": "May be used to filter by reservation properties. The filter supports 'eq', 'or', and 'and'. It does not currently support 'ne', 'gt', 'le', 'ge', or 'not'.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "$orderby",
"description": "May be used to sort order by reservation properties.",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "refreshSummary",
"description": "To indicate whether to refresh the roll up counts of the reservations group by provisioning state",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "selectedState",
"description": "The selected provisioning state",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/ReservationsListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -6266,6 +6403,248 @@
"description": "The set of actions that the caller is not allowed to perform.",
"type": "string",
"readOnly": true
},
"ReservationsListResult": {
"description": "The list of reservations and summary of roll out count of reservations in each state.",
"properties": {
"value": {
"description": "The list of reservations.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Reservation"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
},
"summary": {
"description": "The roll out count summary of the reservations",
"type": "object",
"$ref": "#/definitions/ReservationSummary"
}
}
},
"Reservation": {
"description": "The definition of the reservation.",
"properties": {
"id": {
"description": "The id of the reservation.",
"type": "string",
"readOnly": true
},
"name": {
"description": "The name of the reservation.",
"type": "string",
"readOnly": true
},
"type": {
"description": "The type of the reservation.",
"type": "string",
"readOnly": true
},
"location": {
"description": "The location of the reservation.",
"type": "string",
"readOnly": true
},
"sku": {
"description": "The sku information associated to this reservation ",
"type": "object",
"$ref": "#/definitions/ReservationSkuProperty"
},
"properties": {
"description": "The properties associated to this reservation ",
"type": "object",
"x-ms-client-flatten": true,
"$ref": "#/definitions/ReservationProperty"
}
}
},
"ReservationSkuProperty": {
"description": "The property of reservation sku object.",
"properties": {
"name": {
"description": "The name of the reservation sku.",
"type": "string",
"readOnly": true
}
}
},
"ReservationProperty": {
"description": "The property of reservation object.",
"properties": {
"appliedScopes": {
"description": "The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope",
"type": "array",
"items": {
"$ref": "#/definitions/ReservationAppliedScope"
}
},
"appliedScopeType": {
"description": "The applied scope type of the reservation.",
"type": "string",
"readOnly": true
},
"reservedResourceType": {
"description": "The reserved source type of the reservation, e.g. virtual machine.",
"type": "string",
"readOnly": true
},
"quantity": {
"description": "The number of the reservation.",
"type": "number",
"readOnly": true
},
"provisioningState": {
"description": "The provisioning state of the reservation, e.g. Succeeded",
"type": "string",
"readOnly": true
},
"expiryDate": {
"description": "The expiry date of the reservation",
"type": "string",
"readOnly": true
},
"provisioningSubState": {
"description": "The provisioning state of the reservation, e.g. Succeeded",
"type": "string",
"readOnly": true
},
"displayName": {
"description": "The display name of the reservation",
"type": "string",
"readOnly": true
},
"displayProvisioningState": {
"description": "The provisioning state of the reservation for display, e.g. Succeeded",
"type": "string",
"readOnly": true
},
"userFriendlyRenewState": {
"description": "The renew state of the reservation for display, e.g. On",
"type": "string",
"readOnly": true
},
"userFriendlyAppliedScopeType": {
"description": "The applied scope type of the reservation for display, e.g. Shared",
"type": "string",
"readOnly": true
},
"effectiveDateTime": {
"description": "The effective date time of the reservation",
"type": "string",
"readOnly": true
},
"skuDescription": {
"description": "The sku description of the reservation",
"type": "string",
"readOnly": true
},
"term": {
"description": "The term of the reservation, e.g. P1Y",
"type": "string",
"readOnly": true
},
"renew": {
"description": "The renew state of the reservation",
"type": "boolean",
"readOnly": true
},
"renewSource": {
"description": "The renew source of the reservation",
"type": "string",
"readOnly": true
},
"utilization": {
"readOnly": true,
"type": "object",
"description": "Reservation utilization",
"properties": {
"trend": {
"description": "The number of days trend for a reservation",
"readOnly": true,
"type": "string"
},
"aggregates": {
"description": "The array of aggregates of a reservation's utilization",
"type": "array",
"items": {
"$ref": "#/definitions/ReservationUtilizationAggregates"
}
}
}
}
}
},
"ReservationAppliedScope": {
"readOnly": true,
"type": "string",
"description": "Reservation applied scope"
},
"ReservationUtilizationAggregates": {
"description": "The aggregate values of reservation utilization",
"type": "object",
"properties": {
"grain": {
"description": "The grain of the aggregate",
"readOnly": true,
"type": "number"
},
"grainUnit": {
"description": "The grain unit of the aggregate",
"readOnly": true,
"type": "string"
},
"value": {
"description": "The aggregate value",
"readOnly": true,
"type": "number"
},
"valueUnit": {
"description": "The aggregate value unit",
"readOnly": true,
"type": "string"
}
}
},
"ReservationSummary": {
"description": "The roll up count summary of reservations in each state",
"type": "object",
"properties": {
"succeededCount": {
"description": "The number of reservation in Succeeded state",
"readOnly": true,
"type": "number"
},
"failedCount": {
"description": "The number of reservation in Failed state",
"readOnly": true,
"type": "number"
},
"expiringCount": {
"description": "The number of reservation in Expiring state",
"readOnly": true,
"type": "number"
},
"expiredCount": {
"description": "The number of reservation in Expired state",
"readOnly": true,
"type": "number"
},
"pendingCount": {
"description": "The number of reservation in Pending state",
"readOnly": true,
"type": "number"
},
"cancelledCount": {
"description": "The number of reservation in Cancelled state",
"readOnly": true,
"type": "number"
}
}
}
},
"parameters": {
Expand Down
Loading