Invoice Sections - Create Or Update
Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.
PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}?api-version=2020-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
billing
|
path | True |
string |
The ID that uniquely identifies a billing account. |
billing
|
path | True |
string |
The ID that uniquely identifies a billing profile. |
invoice
|
path | True |
string |
The ID that uniquely identifies an invoice section. |
api-version
|
query | True |
string |
The version of the API to be used with the client request. The current version is 2020-05-01. |
Request Body
Name | Type | Description |
---|---|---|
properties.displayName |
string |
The name of the invoice section. |
properties.labels |
object |
Dictionary of metadata associated with the invoice section. |
properties.tags |
object |
Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK. The request has succeeded. |
|
202 Accepted |
Accepted Headers
|
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
PutInvoiceSection
Sample request
PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}?api-version=2020-05-01
{
"properties": {
"displayName": "invoiceSection1",
"labels": {
"pcCode": "A123456",
"costCategory": "Support"
}
}
}
Sample response
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/putInvoiceSection_00000000-0000-0000-0000-000000000000?api-version=2020-05-01
Retry-After: 60
{
"id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}",
"name": "{invoiceSectionName}",
"type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections",
"properties": {
"displayName": "invoiceSection1",
"labels": {
"pcCode": "A123456",
"costCategory": "Support"
},
"systemId": "XX1X-XXAA-XXX-ZZZ"
}
}
Definitions
Name | Description |
---|---|
Error |
The details of the error. |
Error |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. |
Error |
|
Invoice |
An invoice section. |
Invoice |
Identifies the state of an invoice section. |
target |
Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. |
ErrorDetails
The details of the error.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
details |
The sub details of the error. |
|
message |
string |
Error message indicating why the operation failed. |
target |
string |
The target of the particular error. |
ErrorResponse
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Name | Type | Description |
---|---|---|
error |
The details of the error. |
ErrorSubDetails
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
message |
string |
Error message indicating why the operation failed. |
target |
string |
The target of the particular error. |
InvoiceSection
An invoice section.
Name | Type | Description |
---|---|---|
id |
string |
Resource Id. |
name |
string |
Resource name. |
properties.displayName |
string |
The name of the invoice section. |
properties.labels |
object |
Dictionary of metadata associated with the invoice section. |
properties.state |
Identifies the state of an invoice section. |
|
properties.systemId |
string |
The system generated unique identifier for an invoice section. |
properties.tags |
object |
Dictionary of metadata associated with the invoice section. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / |
properties.targetCloud |
Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. |
|
type |
string |
Resource type. |
InvoiceSectionState
Identifies the state of an invoice section.
Name | Type | Description |
---|---|---|
Active |
string |
|
Restricted |
string |
targetCloud
Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds.
Name | Type | Description |
---|---|---|
USGov |
string |
|
USNat |
string |
|
USSec |
string |