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.

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

BillingActivityList Changes #11245

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,93 @@
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingActivityList": {
"get": {
"tags": [
"BillingActivity"
],
"x-ms-examples": {
"BillingActivityList": {
"$ref": "./examples/BillingActivityList.json"
}
},
"operationId": "BillingActivityList_Get",
"description": "Gets billing activity logs for a billing account",
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountNameParameter"
},
{
"$ref": "#/parameters/startDateParameter"
},
{
"$ref": "#/parameters/endDateParameter"
},
{
"$ref": "#/parameters/activityLogEventCategoryParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/BillingActivityList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingActivityEventCategory": {
"get": {
"tags": [
"BillingActivity"
],
"x-ms-examples": {
"BillingActivityEventCategory": {
"$ref": "./examples/BillingActivityEventCategory.json"
}
},
"operationId": "BillingActivityTypesList_Get",
"description": "Gets billing activity types at enrollment scope.",
"parameters": [
{
"$ref": "#/parameters/apiVersionParameter"
},
{
"$ref": "#/parameters/billingAccountNameParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/BillingActivityEventCategoryListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission": {
"post": {
"tags": [
Expand Down Expand Up @@ -5602,6 +5689,154 @@
}
},
"definitions": {
"BillingActivityList": {
"description": "The list of activity logs.",
"properties": {
"value": {
"description": "The list of activity logs.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/BillingActivity"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
}
}
},
"BillingActivity": {
"description": "The activity log.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"description": "The properties of the activity event.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/BillingActivityProperties"
}
}
},
"BillingActivityProperties": {
"description": "The properties of the activity logs.",
"properties": {
"activityEventName": {
"description": "The unique string needed to get related properties related to this event.",
"type": "string",
"readOnly": true
},
"createdOn": {
"description": "The date the activity log was created.",
"type": "string",
"readOnly": true
},
"createdByUserEmailAddress": {
"description": "The email address of the user who created the activity log. This is supported only for non SPN users.",
"type": "string",
"readOnly": true
},
"enrollmentNumber": {
"description": "The enrollment number for which the activity log is being fetched.",
"type": "string",
"readOnly": true
},
"friendlyEventName": {
"description": "The string describing the activityEventName.",
"type": "string",
"readOnly": true
},
"relatedProperties": {
"description": "The related specific properties for an event.",
"type": "array",
"items": {
"$ref": "#/definitions/ActivityEventRelatedProperty"
}
}
}
},
"ActivityEventRelatedProperty": {
"description": "The activityEventRelatedProperty key-value pair item.",
"type": "object",
"properties": {
"propertyName": {
"description": "Name of the activity event property.",
"readOnly": true,
"type": "string"
},
"propertyValue": {
"description": "Value of the activity event property.",
"readOnly": true,
"type": "string"
}
}
},
"BillingActivityEventCategoryListResult": {
"description": "The list of activity categories.",
"properties": {
"value": {
"description": "The list of activity categories.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/BillingActivityEventCategory"
}
},
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
}
}
},
"BillingActivityEventCategory": {
"description": "The properties of an activity event category.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"description": "The properties of an activity event category.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/BillingActivityEventCategoryProperties"
}
}
},
"BillingActivityEventCategoryProperties": {
"description": "The properties of an activity event category.",
"properties": {
"categoryName": {
"description": "The event category name",
"type": "string",
"readOnly": true
},
"relatedProperties": {
"description": "The related specific properties for an event.",
"type": "array",
"items": {
"$ref": "#/definitions/BillingActivityEventProperties"
}
}
}
},
"BillingActivityEventProperties": {
"description": "The additional specific properties for an event.",
"properties": {
"name": {
"description": "Name of the additional property for an event.",
"type": "string",
"readOnly": true
}
}
},
"CustomerListResult": {
"description": "The list of customers.",
"properties": {
Expand Down Expand Up @@ -8838,6 +9073,32 @@
"type": "string",
"description": "The version of the API to be used with the client request. The current version is 2019-10-01-preview."
},
"startDateParameter": {
"name": "$startDate",
"description": "Start datetime from which activity logs are requested. The date should be specified in MM-DD-YYYY format.",
"format": "date-time",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"endDateParameter": {
"name": "$endDate",
"description": "Start datetime till which activity logs are requested. The date should be specified in MM-DD-YYYY format.",
"format": "date-time",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"activityLogEventCategoryParameter": {
"name": "activityLogEventCategory",
"description": "Operation type based on which activity logs will be filtered. ",
"in": "query",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"subscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"parameters": {
"api-version": "2019-10-01-preview",
"billingAccountName": "{billingAccountName}"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingActivityEventCategoryListResult/7303440",
"name": "7303440",
"properties": {
"categoryName": "ManageAccountAdd",
"relatedProperties": [
"AccountAuthType",
"AccountCostCenter",
"AccountName"
]
},
"type": "Microsoft.Billing/billingAccounts/billingActivityEventCategory"
},
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingActivityEventCategoryListResult/7303441",
"name": "7303441",
"properties": {
"categoryName": "EaPortalPurchaseOrderNumberUpdate",
"relatedProperties": [
"DocumentId",
"InvoiceId",
"PurchaseOrderNumber",
"BillingPeriodStartDate",
"BillingPeriodEndDate"
]
},
"type": "Microsoft.Billing/billingAccounts/billingActivityEventCategory"
}
]
}
}
}
}
Loading