diff --git a/api-reference/beta/includes/alerts-callout-csp-partner-only.md b/api-reference/beta/includes/alerts-callout-csp-partner-only.md index f90fa35a088..ffd32d115de 100644 --- a/api-reference/beta/includes/alerts-callout-csp-partner-only.md +++ b/api-reference/beta/includes/alerts-callout-csp-partner-only.md @@ -7,5 +7,5 @@ ms.topic: include > [!NOTE] -> This API is available for Cloud Solution Provider (CSP) partners only to access their billed and unbilled data for a tenant. For information about the CSP program, see the [Microsoft Cloud Solution Provider](https://learn.microsoft.com/en-us/partner-center/csp-overview) page. +> This API is available for Cloud Solution Provider (CSP) partners only to access their billed and unbilled reconciliation data for a tenant. To learn more about the CSP program, see [Microsoft Cloud Solution Provider](/partner-center/csp-overview). diff --git a/api-reference/beta/resources/partners-billing-api-overview.md b/api-reference/beta/resources/partners-billing-api-overview.md index 54ad77bb4d2..74dfee0a235 100644 --- a/api-reference/beta/resources/partners-billing-api-overview.md +++ b/api-reference/beta/resources/partners-billing-api-overview.md @@ -1,5 +1,5 @@ --- -title: "Use the Microsoft Graph API to export partner billing data (preview)" +title: "Use the Microsoft Graph API to export partner billing data" description: "The partner billing API in Microsoft Graph offers Microsoft direct partners a faster, more efficient way to export their high-volume billed and unbilled Azure usage data." author: "abhishek-singh-ms" ms.localizationpriority: medium @@ -8,7 +8,7 @@ doc_type: resourcePageType ms.custom: zt-include --- -# Use the Microsoft Graph API to export partner billing data (preview) +# Use the Microsoft Graph API to export partner billing data [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] diff --git a/api-reference/beta/toc.yml b/api-reference/beta/toc.yml index 9cf56f3b6e6..2974e2e1cae 100644 --- a/api-reference/beta/toc.yml +++ b/api-reference/beta/toc.yml @@ -16357,7 +16357,7 @@ items: href: resources/attacksimulationtrainingusercoverage.md - name: Get training coverage for users href: api/securityreportsroot-getattacksimulationtrainingusercoverage.md - - name: Partner billing reports (preview) + - name: Partner billing reports items: - name: Overview href: resources/partners-billing-api-overview.md diff --git a/api-reference/v1.0/api/partners-billing-billedusage-export.md b/api-reference/v1.0/api/partners-billing-billedusage-export.md new file mode 100644 index 00000000000..49ecdc16df8 --- /dev/null +++ b/api-reference/v1.0/api/partners-billing-billedusage-export.md @@ -0,0 +1,94 @@ +--- +title: "billedUsage: export" +description: "Export the billed Azure usage data." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: apiPageType +--- + +# billedUsage: export + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Export the billed Azure usage data. + +## Permissions + +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + + +[!INCLUDE [permissions-table](../includes/permissions/partners-permissions.md)] + +## HTTP request + + +``` http +POST /reports/partners/billing/usage/billed/export +``` + +## Request headers + +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| + +## Request body + +In the request body, supply a JSON representation of the parameters. + +The following table shows the parameters that you can use with this action. + +|Parameter|Type|Description| +|:---|:---|:---| +|attributeSet|[microsoft.graph.partners.billing.attributeSet](../resources/partners-billing-attributeset.md)|Attributes that should be exported. Possible values are: `full`, `basic`, `unknownFutureValue`. The default value is `full`. Choose `full` for a complete response or `basic` for a subset of attributes. Optional.| +|invoiceId|String|The invoice ID for which the partner requested to export data. Required.| + +## Response + +If successful, this method returns a `202 Accepted` response code and a `Location` header that contains the URL to the long-running operation. You can check the status of the long-running operation by making a GET request to this URL that returns one of the following objects in the response body: [microsoft.graph.partners.billing.runningOperation](../resources/partners-billing-runningoperation.md), [microsoft.graph.partners.billing.exportSuccessOperation](../resources/partners-billing-exportsuccessoperation.md), or [microsoft.graph.partners.billing.failedOperation](../resources/partners-billing-failedoperation.md). + +## Examples + +### Request + +The following example shows a request. + + +``` http +POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/billed/export +Content-Type: application/json + +{ + "invoiceId" : "G016907411", + "attributeSet" : "full" +} +``` + +### Response + +The following example shows the response. + + +``` http +HTTP/1.1 202 OK +Location: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14 +``` diff --git a/api-reference/v1.0/api/partners-billing-manifest-get.md b/api-reference/v1.0/api/partners-billing-manifest-get.md new file mode 100644 index 00000000000..17a34524997 --- /dev/null +++ b/api-reference/v1.0/api/partners-billing-manifest-get.md @@ -0,0 +1,106 @@ +--- +title: "Get manifest" +description: "Read the properties and relationships of a manifest object." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: apiPageType +--- + +# Get manifest + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + + +Read the properties and relationships of a [manifest](../resources/partners-billing-manifest.md) object. + +## Permissions + +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + + +[!INCLUDE [permissions-table](../includes/permissions/partners-permissions.md)] + +## HTTP request + + +``` http +GET /reports/partners/billing/manifests/{id} +``` + +## Optional query parameters + +This method doesn't support any OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers + +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body + +Don't supply a request body for this method. + +## Response + +If successful, this method returns a `200 OK` response code and a [microsoft.graph.partners.billing.manifest](../resources/partners-billing-manifest.md) object in the response body. + +## Examples + +### Request + +The following example shows a request. + +``` http +GET https://graph.microsoft.com/v1.0/reports/partners/billing/manifests/6fe687d7-1e0f-4bd6-9091-4672691f64bc +``` + +### Response + +The following example shows the response. + +>**Note:** The response object shown here might be shortened for readability. + + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "id": "6fe687d7-1e0f-4bd6-9091-4672691f64bc", + "schemaVersion": "1", + "dataFormat": "compressedJSON", + "createdDateTime": "2023-03-09T06:34:34.87Z", + "eTag": "WYjLro78HdMg6vUWR", + "partnerTenantId": "0e195b37-4574-4539-bc42-0e539b9684c0", + "rootDirectory": "https://adlsreconbuprodeastus201.blob.core.windows.net/billedusagefastpath/v1/PartnerTenantId=0e195b37-4574-4539-bc42-0e539b9684c0/BillingMonth=202310/InvoiceId=G031809528/InvoiceVersion=202311/Fragment=basic/PartitionType=default", + "sasToken": "skoid=0c414a25-fd23-4785-815f-1258467f9ab7&sktid=975f013f-7f24-47e8-a7d3-abc4752bf346&skt=2023-12-13T00%3A37%3A17Z&ske=2023-12-14T00%3A37%3A17Z&sks=b&skv=2021-08-06&sv=2021-08-06&se=2023-12-13T12%3A37%3A17Z&sr=d&sp=rl&sdd=7&sig=RpVY0WBGUHJ2APB3N76jtMak8loAWY4oiA0%2FaoJX1bM%3D", + "partitionType": "Default", + "blobCount": 1, + "blobs": [ + { + "name": "part-00049-b016029b-a7a7-4c46-9b5e-c925ac317ac6.c000.json.gz", + "partitionValue": "default" + } + ] +} +``` diff --git a/api-reference/v1.0/api/partners-billing-operation-get.md b/api-reference/v1.0/api/partners-billing-operation-get.md new file mode 100644 index 00000000000..0dd84658696 --- /dev/null +++ b/api-reference/v1.0/api/partners-billing-operation-get.md @@ -0,0 +1,187 @@ +--- +title: "Get operation" +description: "Read the properties and relationships of an operation object." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: apiPageType +--- + +# Get operation + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + + +Read the properties and relationships of an [operation](../resources/partners-billing-operation.md) object. + +## Permissions + +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + + +[!INCLUDE [permissions-table](../includes/permissions/partners-permissions.md)] + +## HTTP request + + +``` http +GET /reports/partners/billing/operations/{id} +``` + +## Optional query parameters + +This method doesn't support any OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). + +## Request headers + +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| + +## Request body + +Don't supply a request body for this method. + +## Response + +If an operation completes successfully, this method returns a `200 OK` response code and a [microsoft.graph.partners.billing.exportSuccessOperation](../resources/partners-billing-exportsuccessoperation.md) object in the response body. The **resourceLocation** navigation property in the response body represents the [microsoft.graph.partners.billing.manifest](../resources/partners-billing-manifest.md) resource for the operation. + +If an operation fails, this method returns a `200 OK` response code and a [microsoft.graph.partners.billing.failedOperation](../resources/partners-billing-failedoperation.md) object in the response body. + +If an operation is still running, this method returns a `200 OK` response code and a [microsoft.graph.partners.billing.runningOperation](../resources/partners-billing-runningoperation.md) object in the response body. + +## Examples + +### Example 1: Get operation succeeded + +#### Request + +The following example shows a request that returns a [microsoft.graph.partners.billing.exportSuccessOperation](../resources/partners-billing-exportsuccessoperation.md) object. + + +``` http +GET https://graph.microsoft.com/v1.0/reports/partners/billing/operations/6fe687d7-1e0f-4bd6-9091-4672691f64bc +``` + +#### Response + +The following example shows the response for an operation that completed successfully. + +>**Note:** The response object shown here might be shortened for readability. + + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.partners.billing.exportSuccessOperation", + "id": "6fe687d7-1e0f-4bd6-9091-4672691f64bc", + "status": "succeeded", + "createdDateTime": "2023-03-09T08:12:53", + "lastActionDateTime": "2023-03-09T08:37:48.5046691Z", + "resourceLocation@odata.navigationLink": "https://graph.microsoft.com/v1.0/reports/partners/billing/manifests/8fe347d7-1e0f-4bd6-9091-4672691f32db" +} +``` + +### Example 2: Get operation failed + +#### Request + +The following example shows a request that returns a [microsoft.graph.partners.billing.failedOperation](../resources/partners-billing-failedoperation.md) object. + + +``` http +GET https://graph.microsoft.com/v1.0/reports/partners/billing/operations/6fe687d7-1e0f-4bd6-9091-4672691f64bc +``` + +#### Response + +The following example shows the response for an operation that failed. + +>**Note:** The response object shown here might be shortened for readability. + + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.partners.billing.failedOperation", + "id": "6fe687d7-1e0f-4bd6-9091-4672691f64bc", + "status": "failed", + "createdDateTime": "2023-03-09T08:12:53", + "lastActionDateTime": "2023-03-09T08:37:48.5046691Z", + "error": { + "message": "No data available", + "code": "5000" + } +} +``` + +### Example 3: Get operation is still running + +#### Request + +The following example shows a request that returns a [microsoft.graph.partners.billing.runningOperation](../resources/partners-billing-runningoperation.md) object. + + +``` http +GET https://graph.microsoft.com/v1.0/reports/partners/billing/operations/6fe687d7-1e0f-4bd6-9091-4672691f64bc +``` + +#### Response + +The following example shows the response for an operation that is still running. + +>**Note:** The response object shown here might be shortened for readability. + + +``` http +HTTP/1.1 200 OK +Content-Type: application/json + +{ + "@odata.type": "#microsoft.graph.partners.billing.runningOperation", + "id": "6fe687d7-1e0f-4bd6-9091-4672691f64bc", + "status": "running", + "createdDateTime": "2023-03-09T08:12:53", + "lastActionDateTime": "2023-03-09T08:37:48.5046691Z" +} +``` diff --git a/api-reference/v1.0/api/partners-billing-unbilledusage-export.md b/api-reference/v1.0/api/partners-billing-unbilledusage-export.md new file mode 100644 index 00000000000..ff3f862fa26 --- /dev/null +++ b/api-reference/v1.0/api/partners-billing-unbilledusage-export.md @@ -0,0 +1,97 @@ +--- +title: "unbilledUsage: export" +description: "Export the unbilled Azure usage data for a specific billing period and a given currency." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: apiPageType +--- + +# unbilledUsage: export + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Export the unbilled Azure usage data for a specific billing period and a given currency. + +## Permissions + +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + + +[!INCLUDE [permissions-table](../includes/permissions/partners-permissions.md)] + +## HTTP request + + +``` http +POST /reports/partners/billing/usage/unbilled/export +``` + +## Request headers + +|Name|Description| +|:---|:---| +|Authorization|Bearer {token}. Required.| +|Content-Type|application/json. Required.| + +## Request body + +In the request body, supply a JSON representation of the parameters. + +The following table shows the parameters that you can use with this action. + +|Parameter|Type|Description| +|:---|:---|:---| +|attributeSet|[microsoft.graph.partners.billing.attributeSet](../resources/partners-billing-attributeset.md)|Attributes that should be exported. Possible values are: `full`, `basic`, `unknownFutureValue`. The default value is `full`. Choose `full` for a complete response or `basic` for a subset of attributes. Optional.| +|billingPeriod|[microsoft.graph.partners.billing.billingPeriod](../resources/partners-billing-unbilledusage.md#billingperiod-values)|The billing period for the export data. Possible values are: `current`, `last`, `unknownFutureValue`. Choose `current` for the current billing period and `last` for the last billing period. Required.| +|currencyCode|String|The currency code for the partner billing. Required.| + +## Response + +If successful, this method returns a `202 Accepted` response code and a `Location` header that contains the URL to the long-running operation. You can check the status of the long-running operation by making a GET request to this URL that returns one of the following objects in the response body: [microsoft.graph.partners.billing.runningOperation](../resources/partners-billing-runningoperation.md), [microsoft.graph.partners.billing.exportSuccessOperation](../resources/partners-billing-exportsuccessoperation.md), or [microsoft.graph.partners.billing.failedOperation](../resources/partners-billing-failedoperation.md). + +## Examples + +### Request + +The following example shows a request. + + +``` http +POST https://graph.microsoft.com/v1.0/reports/partners/billing/usage/unbilled/export +Content-Type: application/json + +{ + "currencyCode": "USD", + "attributeSet": "full", + "billingPeriod": "current" +} +``` + +### Response + +The following example shows the response. + + +``` http +HTTP/1.1 202 Accepted +Content-Type: application/json +Location: https://graph.microsoft.com/v1.0/reports/partners/billing/operations/9ab9cb54-d07f-4f52-9ea6-a09d7de52c14 +``` diff --git a/api-reference/v1.0/includes/alerts-callout-csp-partner-only.md b/api-reference/v1.0/includes/alerts-callout-csp-partner-only.md new file mode 100644 index 00000000000..ffd32d115de --- /dev/null +++ b/api-reference/v1.0/includes/alerts-callout-csp-partner-only.md @@ -0,0 +1,11 @@ +--- +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +ms.topic: include +--- + + +> [!NOTE] +> This API is available for Cloud Solution Provider (CSP) partners only to access their billed and unbilled reconciliation data for a tenant. To learn more about the CSP program, see [Microsoft Cloud Solution Provider](/partner-center/csp-overview). + diff --git a/api-reference/beta/includes/permissions/operation-get-permissions.md b/api-reference/v1.0/includes/permissions/partners-permissions.md similarity index 100% rename from api-reference/beta/includes/permissions/operation-get-permissions.md rename to api-reference/v1.0/includes/permissions/partners-permissions.md diff --git a/api-reference/v1.0/resources/partners-billing-api-overview.md b/api-reference/v1.0/resources/partners-billing-api-overview.md new file mode 100644 index 00000000000..d9b86d81925 --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-api-overview.md @@ -0,0 +1,77 @@ +--- +title: "Use the Microsoft Graph API to export partner billing data" +description: "The partner billing API in Microsoft Graph offers Microsoft direct partners a faster, more efficient way to export their high-volume billed and unbilled Azure usage data." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +ms.custom: zt-include +--- + +# Use the Microsoft Graph API to export partner billing data + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +As part of the Microsoft Partner Center ecosystem, Microsoft direct partners in the Cloud Solution Provider programs can request to export their billed and unbilled data to Azure Blob Storage asynchronously. this removes the need to maintain an open connection for hours and loop through millions of transactions iteratively. The asynchronous API provides a way to quickly access billing and reconciliation data in manageable chunks. + +The partner billing API is defined in the OData subnamespace `microsoft.graph.partners.billing`. + +> [!NOTE] +> Daily-rated usage normally takes 24 hours to appear in the Microsoft Partner Center or to be available through the API. + +## Authorization + +To export reconciliation data, the calling principal must be in the partner tenant and be granted the appropriate partner billing privilege permissions. The partner billing API supports the following partner permissions. + +[!INCLUDE [permissions-table](../includes/permissions/partners-permissions.md)] + + + +[!INCLUDE [zero-trust](~/../azure_docs/includes/active-directory-zero-trust.md)] + + + + +## Common use cases + +The partner billing API provides methods and actions that allow Microsoft direct partners to export their high-volume billed and unbilled Azure usage data. + +### Billed reconciliation data + +| Use case | API | +|--|--| +| Create a new export operation to export billed reconciliation data | [billedUsage: export](../api/partners-billing-billedusage-export.md) | +| Poll for operation status update | [Get operation](../api/partners-billing-operation-get.md) | + +### Unbilled reconciliation data + +| Use case | API | +|--|--| +| Create a new export operation to export unbilled reconciliation data | [unbilledUsage: export](../api/partners-billing-unbilledusage-export.md) | +| Poll for operation status update | [Get operation](../api/partners-billing-operation-get.md) | + +## Asynchronous data retrieval + +The download of reconciliation data is a long-running operation that consists of the following operations. + +### Usage line-item endpoint + +Use the [billedUsage: export](../api/partners-billing-billedusage-export.md) or [unbilledUsage: export](../api/partners-billing-unbilledusage-export.md) API to access billed or unbilled consumption line items. The API returns a `202 Accepted` response code and a `Location` header that contains the URL to the long-running operation. You can check the status of the long-running operation by making a GET request at regular intervals until you receive a success status with a [manifest](../resources/partners-billing-manifest.md) URL. + +### Operation status endpoint + +Until you receive the success status, keep polling the [Get operation](../api/partners-billing-operation-get.md) API at regular intervals. If the requested data is unavailable, the API response includes a `Retry-After` header that indicates how long you should wait before sending another request. When the operation has completed successfully, the response also provides a [manifest](../resources/partners-billing-manifest.md) with details of the generated files. The manifest provides a storage folder from which actual billing data can be downloaded. The response splits or partitions the files to optimize throughput and I/O parallelism. + + + diff --git a/api-reference/v1.0/resources/partners-billing-attributeset.md b/api-reference/v1.0/resources/partners-billing-attributeset.md new file mode 100644 index 00000000000..ed82050855e --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-attributeset.md @@ -0,0 +1,94 @@ +--- +title: "attributeSet enum type" +description: "Represents attributes for exported data sets in the Microsoft Graph partner billing API." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: enumPageTypes +--- + +# attributeSet enum type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents attributes for exported data sets in the Microsoft Graph partner billing API. The default value is `full`. Choose `full` for a complete response or `basic` for a subset of attributes. + +## Members + +| Member | Value | Description | +|:-------------------|:------|:-------------------------------------------------| +| full | 1 | All attributes in the exported data. | +| basic | 2 | Only basic attributes in the exported data. | +| unknownFutureValue | 3 | Evolvable enumeration sentinel value. Don't use. | + +### Attributes + +The [billedUsage: export](../api/partners-billing-billedusage-export.md) or [unbilledUsage: export](../api/partners-billing-unbilledusage-export.md) API response with the `full` or `basic` request parameter returns the following attributes. + +| Attribute | Full | Basic | +|:------------------------------|:-----|:------| +| AdditionalInfo | Yes | Yes | +| AvailabilityId | Yes | No | +| BenefitID | Yes | No | +| BenefitOrderID | Yes | Yes | +| BenefitType | Yes | Yes | +| BillingCurrency | Yes | Yes | +| BillingPreTaxTotal | Yes | Yes | +| ChargeEndDate | Yes | Yes | +| ChargeStartDate | Yes | Yes | +| ChargeType | Yes | Yes | +| ConsumedService | Yes | No | +| CreditPercentage | Yes | Yes | +| CreditType | Yes | Yes | +| CustomerCountry | Yes | No | +| CustomerDomainName | Yes | No | +| CustomerId | Yes | Yes | +| CustomerName | Yes | Yes | +| EffectiveUnitPrice | Yes | Yes | +| EntitlementDescription | Yes | No | +| EntitlementId | Yes | Yes | +| InvoiceNumber | Yes | Yes | +| MeterCategory | Yes | No | +| MeterId | Yes | No | +| MeterName | Yes | No | +| MeterRegion | Yes | No | +| MeterSubCategory | Yes | No | +| MeterType | Yes | No | +| MpnId | Yes | No | +| PartnerEarnedCreditPercentage | Yes | No | +| PartnerId | Yes | Yes | +| PartnerName | Yes | Yes | +| PCToBCExchangeRate | Yes | Yes | +| PricingCurrency | Yes | Yes | +| PricingPreTaxTotal | Yes | Yes | +| ProductId | Yes | Yes | +| ProductName | Yes | No | +| PublisherId | Yes | No | +| PublisherName | Yes | Yes | +| Quantity | Yes | Yes | +| ResourceGroup | Yes | No | +| ResourceLocation | Yes | No | +| ResourceURI | Yes | Yes | +| ServiceInfo1 | Yes | No | +| ServiceInfo2 | Yes | No | +| SkuId | Yes | Yes | +| SkuName | Yes | Yes | +| SubscriptionDescription | Yes | No | +| SubscriptionId | Yes | Yes | +| Tags | Yes | No | +| Tier2MpnId | Yes | No | +| Unit | Yes | No | +| UnitPrice | Yes | Yes | +| UnitType | Yes | Yes | +| UsageDate | Yes | Yes | + + diff --git a/api-reference/v1.0/resources/partners-billing-azureusage.md b/api-reference/v1.0/resources/partners-billing-azureusage.md new file mode 100644 index 00000000000..a82de3a6421 --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-azureusage.md @@ -0,0 +1,49 @@ +--- +title: "azureUsage resource type" +description: "Represents details for billed and unbilled Azure usage data." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# azureUsage resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents details for billed and unbilled Azure usage data. + +## Methods + +None. + +## Properties + +None. + +## Relationships + +|Relationship|Type|Description| +|:---|:---|:---| +|billed|[microsoft.graph.partners.billing.billedUsage](partners-billing-billedusage.md)|Represents details for billed Azure usage data.| +|unbilled|[microsoft.graph.partners.billing.unbilledUsage](partners-billing-unbilledusage.md)|Represents details for unbilled Azure usage data.| + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "@odata.type": "#microsoft.graph.partners.billing.azureUsage" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-billedusage.md b/api-reference/v1.0/resources/partners-billing-billedusage.md new file mode 100644 index 00000000000..c609d55165d --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-billedusage.md @@ -0,0 +1,48 @@ +--- +title: "billedUsage resource type" +description: "Represents details for billed Azure usage data." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# billedUsage resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents details for billed Azure usage data. + +## Methods + +|Method|Return type|Description| +|:---|:---|:---| +|[export](../api/partners-billing-billedusage-export.md)|[microsoft.graph.partners.billing.operation](partners-billing-operation.md)|Export the billed Azure usage data.| + +## Properties + +None. + +## Relationships + +None. + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "@odata.type": "#microsoft.graph.partners.billing.billedUsage" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-billing.md b/api-reference/v1.0/resources/partners-billing-billing.md new file mode 100644 index 00000000000..6fba268b799 --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-billing.md @@ -0,0 +1,50 @@ +--- +title: "billing resource type" +description: "Represents billing details for billed and unbilled data." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# billing resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents billing details for billed and unbilled data. + +## Methods + +None. + +## Properties + +None. + +## Relationships + +|Relationship|Type|Description| +|:---|:---|:---| +|manifests|[microsoft.graph.partners.billing.manifest](partners-billing-manifest.md) collection|Represents metadata for the exported data.| +|operations|[microsoft.graph.partners.billing.operation](partners-billing-operation.md) collection|Represents an operation to export the billing data of a partner.| +|usage|[microsoft.graph.partners.billing.azureUsage](partners-billing-azureusage.md)|Represents details for billed and unbilled Azure usage data.| + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "@odata.type": "#microsoft.graph.partners.billing.billing" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-blob.md b/api-reference/v1.0/resources/partners-billing-blob.md new file mode 100644 index 00000000000..5113d7519ae --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-blob.md @@ -0,0 +1,43 @@ +--- +title: "blob resource type" +description: "Represents a billing blob that contains exported data." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# blob resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents a billing blob that contains exported data. + +## Properties + +|Property|Type|Description| +|:---|:---|:---| +|name|String|The blob name.| +|partitionValue|String|The partition that contains the file. A large partition is split into multiple files, each with the same **partitionValue**.| + +## Relationships + +None. + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "name": "String", + "partitionValue": "String" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-exportsuccessoperation.md b/api-reference/v1.0/resources/partners-billing-exportsuccessoperation.md new file mode 100644 index 00000000000..abe2249af93 --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-exportsuccessoperation.md @@ -0,0 +1,55 @@ +--- +title: "exportSuccessOperation resource type" +description: "Represents an export operation that is completed successfully." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# exportSuccessOperation resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents an export operation that is completed successfully. + +Inherits from [operation](../resources/partners-billing-operation.md). + +## Properties + +|Property|Type|Description| +|:---|:---|:---| +|createdDateTime|DateTimeOffset|The start time of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [operation](../resources/partners-billing-operation.md).| +|id|String|The unique identifier for the **exportSuccessOperation**. Inherited from [operation](../resources/partners-billing-operation.md).| +|lastActionDateTime|DateTimeOffset|The time of the last action of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [operation](../resources/partners-billing-operation.md).| +|status|microsoft.graph.longRunningOperationStatus|The status of the operation. Supports a subset of the values for **longRunningOperationStatus**. Possible value is: `completed`. Inherited from [operation](../resources/partners-billing-operation.md).| + +## Relationships + +|Relationship|Type|Description| +|:---|:---|:---| +|resourceLocation|[microsoft.graph.partners.billing.manifest](../resources/partners-billing-manifest.md)|Metadata for the exported files.| + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "@odata.type": "#microsoft.graph.partners.billing.exportSuccessOperation", + "createdDateTime": "String (timestamp)", + "id": "String (identifier)", + "lastActionDateTime": "String (timestamp)", + "status": "String" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-failedoperation.md b/api-reference/v1.0/resources/partners-billing-failedoperation.md new file mode 100644 index 00000000000..ad4b61ea260 --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-failedoperation.md @@ -0,0 +1,55 @@ +--- +title: "failedOperation resource type" +description: "Represents an export operation that failed to complete." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# failedOperation resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents an export operation that failed to complete. + +Inherits from [operation](../resources/partners-billing-operation.md). + +## Properties + +|Property|Type|Description| +|:---|:---|:---| +|createdDateTime|DateTimeOffset|The start time of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [operation](../resources/partners-billing-operation.md).| +|id|String|The unique identifier for the **failedOperation**. Inherited from [operation](../resources/partners-billing-operation.md).| +|lastActionDateTime|DateTimeOffset|The time of the last action of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [operation](../resources/partners-billing-operation.md).| +|status|microsoft.graph.longRunningOperationStatus|The status of the operation. Supports a subset of the values for **longRunningOperationStatus**. Possible value is: `failed`. Inherited from [operation](../resources/partners-billing-operation.md).| + +## Relationships + +|Relationship|Type|Description| +|:---|:---|:---| +|error|[microsoft.graph.publicError](../resources/publicerror.md)|Information about the error that caused the failure.| + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "@odata.type": "#microsoft.graph.partners.billing.failedOperation", + "createdDateTime": "String (timestamp)", + "id": "String (identifier)", + "lastActionDateTime": "String (timestamp)", + "status": "String" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-manifest.md b/api-reference/v1.0/resources/partners-billing-manifest.md new file mode 100644 index 00000000000..e1ee6a37070 --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-manifest.md @@ -0,0 +1,72 @@ +--- +title: "manifest resource type" +description: "Represents metadata for the exported data." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# manifest resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents metadata for the exported data. Use the metadata to get details of the file you want to download from an Azure Blob Storage. + +Inherits from [entity](../resources/entity.md). + +## Methods + +|Method|Return type|Description| +|:---|:---|:---| +|[Get manifest](../api/partners-billing-manifest-get.md)|[microsoft.graph.partners.billing.manifest](../resources/partners-billing-manifest.md)|Read the properties and relationships of a [manifest](../resources/partners-billing-manifest.md) object.| + +## Properties + +|Property|Type|Description| +|:---|:---|:---| +|blobCount|Int32|The total file count for this partner tenant ID.| +|blobs|[microsoft.graph.partners.billing.blob](../resources/partners-billing-blob.md) collection|A collection of blob objects that contain details of all the files for the partner tenant ID.| +|createdDateTime|DateTimeOffset|The date and time when a manifest resource was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|dataFormat|String|The billing data file format. The possible value is: `compressedJSONLines`. Each blob is a compressed file and data in the file is in [JSON lines](https://jsonlines.org/) format. Decompress the file to access the data.| +|eTag|String|Version of data represented by the manifest. Any change in **eTag** indicates a new data version.| +|id|String|The unique identifier for the **manifest**. Inherited from [entity](../resources/entity.md).| +|partitionType|String|Indicates the division of data. If a given partition has more than the supported number, the data is split into multiple files, each file representing a specific **partitionValue**. By default, the data in the file is partitioned by the number of line items.| +|partnerTenantId|String|The Microsoft Entra tenant ID of the partner.| +|rootDirectory|String|The root directory that contains all the files.| +|sasToken|String|The SAS token for accessing the directory or an individual file in the directory.| +|schemaVersion|String|The version of the manifest schema.| + +## Relationships + +None. + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "blobCount": "Int32", + "blobs": [{"@odata.type": "microsoft.graph.partners.billing.blob"}], + "createdDateTime": "String (timestamp)", + "dataFormat": "String", + "eTag": "String", + "id": "String (identifier)", + "partitionType": "String", + "partnerTenantId": "String", + "rootDirectory": "String", + "sasToken": "String", + "schemaVersion": "String" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-operation.md b/api-reference/v1.0/resources/partners-billing-operation.md new file mode 100644 index 00000000000..ebc97136b1f --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-operation.md @@ -0,0 +1,61 @@ +--- +title: "operation resource type" +description: "Represents an operation to export the billing data of a partner." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# operation resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents an operation to export the billing data of a partner. + +Base type of [exportSuccessOperation](../resources/partners-billing-exportsuccessoperation.md), [failedOperation](../resources/partners-billing-failedoperation.md), and [runningOperation](../resources/partners-billing-runningoperation.md). + +Inherits from [entity](../resources/entity.md). + +## Methods + +|Method|Return type|Description| +|:---|:---|:---| +|[Get operation](../api/partners-billing-operation-get.md)|[microsoft.graph.partners.billing.operation](../resources/partners-billing-operation.md)|Read the properties and relationships of an [operation](../resources/partners-billing-operation.md) object.| + +## Properties + +|Property|Type|Description| +|:---|:---|:---| +|createdDateTime|DateTimeOffset|The start time of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|id|String|The unique identifier for the **operation**. Inherited from [entity](../resources/partners-billing-operation.md).| +|lastActionDateTime|DateTimeOffset|The time of the last action of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.| +|status|microsoft.graph.longRunningOperationStatus|The status of the operation. Possible values are: `notStarted`, `running`, `completed`, `failed`, `unknownFutureValue`.| + +## Relationships + +None. + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "@odata.type": "#microsoft.graph.partners.billing.operation", + "createdDateTime": "String (timestamp)", + "id": "String (identifier)", + "lastActionDateTime": "String (timestamp)", + "status": "String" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-runningoperation.md b/api-reference/v1.0/resources/partners-billing-runningoperation.md new file mode 100644 index 00000000000..099bee2cc92 --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-runningoperation.md @@ -0,0 +1,53 @@ +--- +title: "runningOperation resource type" +description: "Represents an export operation that is still running, which indicates that the files aren't ready yet." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# runningOperation resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents an export operation that is still running, which indicates that the files aren't ready yet. + +Inherits from [operation](../resources/partners-billing-operation.md). + +## Properties + +|Property|Type|Description| +|:---|:---|:---| +|createdDateTime|DateTimeOffset|The start time of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [operation](../resources/partners-billing-operation.md).| +|id|String|The unique identifier for the **runningOperation**. Inherited from [operation](../resources/partners-billing-operation.md).| +|lastActionDateTime|DateTimeOffset|The time of the last action of the operation. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`. Inherited from [operation](../resources/partners-billing-operation.md).| +|status|microsoft.graph.longRunningOperationStatus|The status of the operation. Supports a subset of the values for **longRunningOperationStatus**. Possible values are: `notStarted`, `running`. Inherited from [operation](../resources/partners-billing-operation.md).| + +## Relationships + +None. + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "@odata.type": "#microsoft.graph.partners.billing.runningOperation", + "createdDateTime": "String (timestamp)", + "id": "String (identifier)", + "lastActionDateTime": "String (timestamp)", + "status": "String" +} +``` diff --git a/api-reference/v1.0/resources/partners-billing-unbilledusage.md b/api-reference/v1.0/resources/partners-billing-unbilledusage.md new file mode 100644 index 00000000000..ae73a908257 --- /dev/null +++ b/api-reference/v1.0/resources/partners-billing-unbilledusage.md @@ -0,0 +1,56 @@ +--- +title: "unbilledUsage resource type" +description: "Represents details for unbilled Azure usage data." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# unbilledUsage resource type + +Namespace: microsoft.graph.partners.billing + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents details for unbilled Azure usage data. + +## Methods + +|Method|Return type|Description| +|:---|:---|:---| +|[export](../api/partners-billing-unbilledusage-export.md)|[microsoft.graph.partners.billing.operation](partners-billing-operation.md)|Export the unbilled Azure usage data for a specific billing period and a given currency.| + +## Properties + +None. + +### billingPeriod values + +| Member | Description | +|:-------------------|:-------------------------------------------------| +| current | The current billing period. | +| last | The billing period for the last month. | +| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. | + +## Relationships + +None. + +## JSON representation + +The following JSON representation shows the resource type. + + +``` json +{ + "@odata.type": "#microsoft.graph.partners.billing.unbilledUsage" +} +``` diff --git a/api-reference/v1.0/resources/partners.md b/api-reference/v1.0/resources/partners.md new file mode 100644 index 00000000000..293a34a1326 --- /dev/null +++ b/api-reference/v1.0/resources/partners.md @@ -0,0 +1,49 @@ +--- +title: "partners resource type" +description: "Represents billing details for a Microsoft direct partner." +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +doc_type: resourcePageType +--- + +# partners resource type + +Namespace: microsoft.graph + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] + +Represents billing details for a Microsoft direct partner. + +## Methods + +None. + +## Properties + +None. + +## Relationships + +|Relationship|Type|Description| +|:---|:---|:---| +|billing|[microsoft.graph.partners.billing.billing](partners-billing-billing.md)|Represents billing details for billed and unbilled data.| + +## JSON representation + +The following JSON representation shows the resource type. + + + +``` json +{ + "@odata.type": "#microsoft.graph.partners" +} +``` diff --git a/api-reference/v1.0/resources/reportroot.md b/api-reference/v1.0/resources/reportroot.md index 5c3215c743b..db3a6657358 100644 --- a/api-reference/v1.0/resources/reportroot.md +++ b/api-reference/v1.0/resources/reportroot.md @@ -34,6 +34,7 @@ None. | monthlyPrintUsageByPrinter | [printUsageByPrinter](../resources/printusagebyprinter.md) collection | Retrieve a list of monthly print usage summaries, grouped by printer. | | monthlyPrintUsageByUser | [printUsageByUser](../resources/printusagebyuser.md) collection | Retrieve a list of monthly print usage summaries, grouped by user. | | security | [securityReportsRoot](../resources/securityreportsroot.md) | Represents an abstract type that contains resources for attack simulation and training reports. | +| partners | [partners](../resources/partners.md) | Represents billing details for a Microsoft direct partner. | ## JSON representation diff --git a/api-reference/v1.0/toc.yml b/api-reference/v1.0/toc.yml index dd75ced2098..7fc7edd15de 100644 --- a/api-reference/v1.0/toc.yml +++ b/api-reference/v1.0/toc.yml @@ -7545,6 +7545,34 @@ items: href: resources/attacksimulationtrainingusercoverage.md - name: Get training coverage for users href: api/securityreportsroot-getattacksimulationtrainingusercoverage.md + - name: Partner billing reports + items: + - name: Overview + href: resources/partners-billing-api-overview.md + - name: Billed usage + items: + - name: Billed usage + href: resources/partners-billing-billedusage.md + - name: Export + href: api/partners-billing-billedusage-export.md + - name: Manifest + items: + - name: Manifest + href: resources/partners-billing-manifest.md + - name: Get + href: api/partners-billing-manifest-get.md + - name: Operation + items: + - name: Operation + href: resources/partners-billing-operation.md + - name: Get + href: api/partners-billing-operation-get.md + - name: Unbilled usage + items: + - name: Unbilled usage + href: resources/partners-billing-unbilledusage.md + - name: Export + href: api/partners-billing-unbilledusage-export.md - name: Search items: - name: Query diff --git a/changelog/Microsoft.Partner.Billing.json b/changelog/Microsoft.Partner.Billing.json index b96ed41217e..09cdb621413 100644 --- a/changelog/Microsoft.Partner.Billing.json +++ b/changelog/Microsoft.Partner.Billing.json @@ -1,7 +1,7 @@ -{ +{ "changelog": [ { - "ChangeList": [ + "ChangeList": [ { "Id": "7c2c17ad-d53f-4573-bc55-3f5738450f30", "ApiChange": "Enum type", @@ -25,7 +25,7 @@ "ChangeType": "Addition", "Description": "Added the [blob](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-blob?view=graph-rest-beta) resource type.", "Target": "blob" - }, + }, { "Id": "7c2c17ad-d53f-4573-bc55-3f5738450f30", "ApiChange": "Resource", @@ -121,6 +121,128 @@ "CreatedDateTime": "2024-01-16T08:51:46.3920632Z", "WorkloadArea": "Reports", "SubArea": "Partner billing reports" + }, + { + "ChangeList": [ + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Enum type", + "ChangedApiName": "attributeSet", + "ChangeType": "Addition", + "Description": "Added the **attributeSet** enumeration type.", + "Target": "attributeSet" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Enum type", + "ChangedApiName": "billingPeriod", + "ChangeType": "Addition", + "Description": "Added the **billingPeriod** enumeration type.", + "Target": "billingPeriod" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "blob", + "ChangeType": "Addition", + "Description": "Added the [blob](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-blob?view=graph-rest-1.0) resource type.", + "Target": "blob" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "exportSuccessOperation", + "ChangeType": "Addition", + "Description": "Added the [exportSuccessOperation](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-exportSuccessOperation?view=graph-rest-1.0) resource type.", + "Target": "exportSuccessOperation" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "failedOperation", + "ChangeType": "Addition", + "Description": "Added the [failedOperation](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-failedOperation?view=graph-rest-1.0) resource type.", + "Target": "failedOperation" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "manifest", + "ChangeType": "Addition", + "Description": "Added the [manifest](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-manifest?view=graph-rest-1.0) resource and a supported method.", + "Target": "manifest" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "operation", + "ChangeType": "Addition", + "Description": "Added the [operation](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-operation?view=graph-rest-1.0) resource and a supported method.", + "Target": "operation" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "runningOperation", + "ChangeType": "Addition", + "Description": "Added the [runningOperation](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-runningOperation?view=graph-rest-1.0) resource type.", + "Target": "runningOperation" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "partners", + "ChangeType": "Addition", + "Description": "Added the [partners](https://learn.microsoft.com/en-us/graph/api/resources/partners?view=graph-rest-1.0) resource type.", + "Target": "partners" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "billing", + "ChangeType": "Addition", + "Description": "Added the [billing](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-billing?view=graph-rest-1.0) resource type.", + "Target": "billing" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "azureUsage", + "ChangeType": "Addition", + "Description": "Added the [azureUsage](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-azureUsage?view=graph-rest-1.0) resource type.", + "Target": "azureUsage" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "billedUsage", + "ChangeType": "Addition", + "Description": "Added the [billedUsage](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-billedUsage?view=graph-rest-1.0) resource and a supported method.", + "Target": "billedUsage" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Resource", + "ChangedApiName": "unbilledUsage", + "ChangeType": "Addition", + "Description": "Added the [unbilledUsage](https://learn.microsoft.com/en-us/graph/api/resources/partners-billing-unbilledUsage?view=graph-rest-1.0) resource and a supported method.", + "Target": "unbilledUsage" + }, + { + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "ApiChange": "Relationship", + "ChangedApiName": "partners", + "ChangeType": "Addition", + "Description": "Added the **partners** relationship to the [reportRoot](https://learn.microsoft.com/en-us/graph/api/resources/reportRoot?view=graph-rest-1.0) resource.", + "Target": "reportRoot" + } + ], + "Id": "abf7f5a2-4842-4016-a573-08731f5cb362", + "Cloud": "Prod", + "Version": "v1.0", + "CreatedDateTime": "2024-01-31T08:51:46.3920632Z", + "WorkloadArea": "Reports", + "SubArea": "Partner billing reports" } ] } diff --git a/concepts/partners-billing-concept-overview.md b/concepts/partners-billing-concept-overview.md index 5c8ddea2e71..efcf1fb40ed 100644 --- a/concepts/partners-billing-concept-overview.md +++ b/concepts/partners-billing-concept-overview.md @@ -1,12 +1,14 @@ --- -title: "Use the partner billing API in Microsoft Graph to access billing data (preview)" +title: "Use the partner billing API in Microsoft Graph to access billing data" description: "Learn how to use the partner billing API in Microsoft Graph to facilitate the export of billing data." author: "abhishek-singh-ms" ms.localizationpriority: medium ms.prod: "reports" --- -# Use the partner billing API in Microsoft Graph to access billing data (preview) +# Use the partner billing API in Microsoft Graph to access billing data + +[!INCLUDE [alerts-callout-csp-partner-only](../includes/alerts-callout-csp-partner-only.md)] The partner billing API in Microsoft Graph allow Microsoft direct partners in the Cloud Solution Provider programs to export their high-volume billed and unbilled data asynchronously. This removes the need to maintain an open connection for hours and loop through millions of transactions iteratively. Asynchronous APIs enable fast, efficient retrieval of billing and reconciliation data in manageable chunks for quicker reconciliation. @@ -43,9 +45,10 @@ Use the [Get operation](/graph/api/partners-billing-operation-get) endpoint to p Looking for the API reference for this service? -[Partner billing API in Microsoft Graph beta](/graph/api/resources/partners-billing-api-overview?view=graph-rest-beta&preserve-view=true) +- [Partner billing API in Microsoft Graph v1.0](/graph/api/resources/partners-billing-api-overview?view=graph-rest-1.0&preserve-view=true) +- [Partner billing API in Microsoft Graph beta](/graph/api/resources/partners-billing-api-overview?view=graph-rest-beta&preserve-view=true) ## Next steps -- To learn more about the partner billing API, see [Use the Microsoft Graph API to export partner billing data (preview)](/graph/api/resources/partners-billing-api-overview?view=graph-rest-beta&preserve-view=true). +- To learn more about the partner billing API, see [Use the Microsoft Graph API to export partner billing data](/graph/api/resources/partners-billing-api-overview). - Try the partner billing API in [Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). diff --git a/concepts/reportroot-concept-overview.md b/concepts/reportroot-concept-overview.md index 16596174e27..fcff78ac451 100644 --- a/concepts/reportroot-concept-overview.md +++ b/concepts/reportroot-concept-overview.md @@ -52,7 +52,7 @@ You can use the reports API to access the data sets listed in the following tabl | Microsoft 365 (general) | [Activations](/graph/api/resources/office-365-activations-reports)
[Active users](/graph/api/resources/office-365-active-users-reports)
[Apps usage](/graph/api/resources/microsoft-365-apps-usage-report)
[Browser usage (preview)](/graph/api/resources/microsoft-365-browser-usage-report)
[Groups activity](/graph/api/resources/office-365-groups-activity-reports) | | OneDrive | [Activity](/graph/api/resources/onedrive-activity-reports)
[Usage](/graph/api/resources/onedrive-usage-reports) | | Outlook | [Activity](/graph/api/resources/email-activity-reports)
[App usage](/graph/api/resources/email-app-usage-reports)
[Mailbox usage](/graph/api/resources/mailbox-usage-reports) | -| Partner billing | [Billed usage (preview)](/graph/api/resources/partners-billing-billedusage)
[Unbilled usage (preview)](/graph/api/resources/partners-billing-unbilledusage) | +| Partner billing | [Billed usage](/graph/api/resources/partners-billing-billedusage)
[Unbilled usage](/graph/api/resources/partners-billing-unbilledusage) | | SharePoint | [Activity](/graph/api/resources/sharepoint-activity-reports)
[Site usage](/graph/api/resources/sharepoint-site-usage-reports) | | Skype for Business | [Activity](/graph/api/resources/skype-for-business-activity-reports)
[Device usage](/graph/api/resources/skype-for-business-device-usage-reports)
[Organizer activity](/graph/api/resources/skype-for-business-organizer-activity-reports)
[Participant activity](/graph/api/resources/skype-for-business-participant-activity-reports)
[Peer to peer activity](/graph/api/resources/skype-for-business-peer-to-peer-activity) | | Yammer | [Activity](/graph/api/resources/yammer-activity-reports)
[Device usage](/graph/api/resources/yammer-device-usage-reports)
[Groups activity](/graph/api/resources/yammer-groups-activity-reports) | @@ -64,6 +64,8 @@ Looking for the API reference for this service? - [Identity and access reports API in Microsoft Graph beta](/graph/api/resources/report-identity-access?view=graph-rest-beta&preserve-view=true) - [Microsoft 365 usage reports API in Microsoft Graph v1.0](/graph/api/resources/report?view=graph-rest-1.0&preserve-view=true) - [Microsoft 365 usage reports API in Microsoft Graph beta](/graph/api/resources/report?view=graph-rest-beta&preserve-view=true) +- [Partner billing reports API in Microsoft Graph v1.0](/graph/api/resources/partners-billing-api-overview?view=graph-rest-1.0&preserve-view=true) +- [Partner billing reports API in Microsoft Graph beta](/graph/api/resources/partners-billing-api-overview?view=graph-rest-beta&preserve-view=true) ## Next steps diff --git a/concepts/toc.yml b/concepts/toc.yml index c108e00fc75..7dffcd0a3a8 100644 --- a/concepts/toc.yml +++ b/concepts/toc.yml @@ -788,7 +788,7 @@ items: displayName: report, reports - name: Authorization for Microsoft 365 usage reports href: reportroot-authorization.md - - name: Partner billing (preview) + - name: Partner billing href: partners-billing-concept-overview.md - name: Search items: diff --git a/concepts/whats-new-overview.md b/concepts/whats-new-overview.md index 50219152ef5..d79f0d3914c 100644 --- a/concepts/whats-new-overview.md +++ b/concepts/whats-new-overview.md @@ -30,6 +30,15 @@ Use the **webURL** property to get the deep link URL of an [educationSubmission] Through the **attributes** property of the [accessPackageResource resource type](/graph/api/resources/accesspackageresource), you can now view details of the attributes that are collected from the requestor and sent to the resource application. +### Reports | Partner billing reports + +The new partner billing API in Microsoft Graph offers Microsoft direct partners a faster, more efficient way to export their high-volume billed and unbilled Azure usage data. Partners can quickly create export operations, monitor their status, and retrieve manifests using the following APIs: + +- [billedUsage: export](/graph/api/partners-billing-billedusage-export) +- [unbilledUsage: export](/graph/api/partners-billing-unbilledusage-export) +- [Get operation](/graph/api/partners-billing-operation-get) +- [Get manifest](/graph/api/partners-billing-manifest-get) + ### Teamwork and communications | Calls and online meetings Communications servers can publish [deltaParticipants](/graph/api/resources/deltaParticipants) notifications for the creation, update, or deletion of a [participant](/graph/api/resources/participant) in a [call](/graph/api/resources/call). For more information, see [JSON payload examples](/graph/api/application-post-calls#notification---roster) of notifications with delta roster disabled or enabled. diff --git a/includes/alerts-callout-csp-partner-only.md b/includes/alerts-callout-csp-partner-only.md new file mode 100644 index 00000000000..ffd32d115de --- /dev/null +++ b/includes/alerts-callout-csp-partner-only.md @@ -0,0 +1,11 @@ +--- +author: "sourishdeb" +ms.localizationpriority: medium +ms.prod: "reports" +ms.topic: include +--- + + +> [!NOTE] +> This API is available for Cloud Solution Provider (CSP) partners only to access their billed and unbilled reconciliation data for a tenant. To learn more about the CSP program, see [Microsoft Cloud Solution Provider](/partner-center/csp-overview). +