Microsoft.Billing (preview:2020-03-01)

2025/10/30 • 5 new, 5 deleted methods

CostAllocationRules_List (new)
Description :  Get the list of all cost allocation rules for a billing account or enterprise enrollment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of cost allocation rules. ,
Required: False ,
}
[
{
id:
{
Description: Azure Resource Manager Id for the rule. This is a read ony value. ,
Required: False ,
}
string ,
name:
{
Description: Name of the rule. This is a read only value. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule. ,
Required: False ,
}
string ,
properties:
{
Description: Cost allocation rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a cost allocation rule. ,
Required: False ,
}
string ,
details:
{
Description: Resource information for the cost allocation rule ,
Required: True ,
}
{
sourceResources:
{
Description: Source resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
targetResources:
{
Description: Target resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
}
,
status:
{
Description: Status of the rule ,
Enum:
{
NotActive: Rule is saved but not used to allocate costs. ,
Active: Rule is saved and impacting cost allocation. ,
Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. ,
}
,
Required: True ,
}
enum ,
createdDate:
{
Description: Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDate:
{
Description: Time at which the rule was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rule list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_CheckNameAvailability (new)
Description :  Checks availability and correctness of a name for a cost allocation rule
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/checkNameAvailability
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
costAllocationRuleCheckNameAvailabilityRequest:
{
Description: Cost allocation rule to be created or updated ,
Required: True ,
}
{
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. This is expected to be Microsoft.CostManagement/costAllocationRules ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Whether this rule name is available ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason this name is not available ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
Valid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Error message if the name is not available ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_Get (new)
Description :  Get a cost allocation rule by rule name and billing account or enterprise enrollment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure Resource Manager Id for the rule. This is a read ony value. ,
Required: False ,
}
string ,
name:
{
Description: Name of the rule. This is a read only value. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule. ,
Required: False ,
}
string ,
properties:
{
Description: Cost allocation rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a cost allocation rule. ,
Required: False ,
}
string ,
details:
{
Description: Resource information for the cost allocation rule ,
Required: True ,
}
{
sourceResources:
{
Description: Source resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
targetResources:
{
Description: Target resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
}
,
status:
{
Description: Status of the rule ,
Enum:
{
NotActive: Rule is saved but not used to allocate costs. ,
Active: Rule is saved and impacting cost allocation. ,
Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. ,
}
,
Required: True ,
}
enum ,
createdDate:
{
Description: Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDate:
{
Description: Time at which the rule was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_CreateOrUpdate (new)
Description :  Create/Update a rule to allocate cost between different resources within a billing account or enterprise enrollment.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters. ,
Required: True ,
}
string ,
costAllocationRule:
{
Description: Cost allocation rule to be created or updated ,
Required: True ,
}
{
id:
{
Description: Azure Resource Manager Id for the rule. This is a read ony value. ,
Required: False ,
}
string ,
name:
{
Description: Name of the rule. This is a read only value. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule. ,
Required: False ,
}
string ,
properties:
{
Description: Cost allocation rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a cost allocation rule. ,
Required: False ,
}
string ,
details:
{
Description: Resource information for the cost allocation rule ,
Required: True ,
}
{
sourceResources:
{
Description: Source resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
targetResources:
{
Description: Target resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
}
,
status:
{
Description: Status of the rule ,
Enum:
{
NotActive: Rule is saved but not used to allocate costs. ,
Active: Rule is saved and impacting cost allocation. ,
Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. ,
}
,
Required: True ,
}
enum ,
createdDate:
{
Description: Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDate:
{
Description: Time at which the rule was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Azure Resource Manager Id for the rule. This is a read ony value. ,
Required: False ,
}
string ,
name:
{
Description: Name of the rule. This is a read only value. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule. ,
Required: False ,
}
string ,
properties:
{
Description: Cost allocation rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a cost allocation rule. ,
Required: False ,
}
string ,
details:
{
Description: Resource information for the cost allocation rule ,
Required: True ,
}
{
sourceResources:
{
Description: Source resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
targetResources:
{
Description: Target resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
}
,
status:
{
Description: Status of the rule ,
Enum:
{
NotActive: Rule is saved but not used to allocate costs. ,
Active: Rule is saved and impacting cost allocation. ,
Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. ,
}
,
Required: True ,
}
enum ,
createdDate:
{
Description: Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDate:
{
Description: Time at which the rule was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_Delete (new)
Description :  Delete cost allocation rule for billing account or enterprise enrollment.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_List (removed)
Description :  Get the list of all cost allocation rules for a billing account or enterprise enrollment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of cost allocation rules. ,
Required: False ,
}
[
{
id:
{
Description: Azure Resource Manager Id for the rule. This is a read ony value. ,
Required: False ,
}
string ,
name:
{
Description: Name of the rule. This is a read only value. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule. ,
Required: False ,
}
string ,
properties:
{
Description: Cost allocation rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a cost allocation rule. ,
Required: False ,
}
string ,
details:
{
Description: Resource information for the cost allocation rule ,
Required: True ,
}
{
sourceResources:
{
Description: Source resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
targetResources:
{
Description: Target resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
}
,
status:
{
Description: Status of the rule ,
Enum:
{
NotActive: Rule is saved but not used to allocate costs. ,
Active: Rule is saved and impacting cost allocation. ,
Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. ,
}
,
Required: True ,
}
enum ,
createdDate:
{
Description: Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDate:
{
Description: Time at which the rule was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rule list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_CheckNameAvailability (removed)
Description :  Checks availability and correctness of a name for a cost allocation rule
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/checkNameAvailability
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
costAllocationRuleCheckNameAvailabilityRequest:
{
Description: Cost allocation rule to be created or updated ,
Required: True ,
}
{
name:
{
Description: Rule name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. This is expected to be Microsoft.CostManagement/costAllocationRules ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Whether this rule name is available ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason this name is not available ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
Valid: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Error message if the name is not available ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_Get (removed)
Description :  Get a cost allocation rule by rule name and billing account or enterprise enrollment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure Resource Manager Id for the rule. This is a read ony value. ,
Required: False ,
}
string ,
name:
{
Description: Name of the rule. This is a read only value. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule. ,
Required: False ,
}
string ,
properties:
{
Description: Cost allocation rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a cost allocation rule. ,
Required: False ,
}
string ,
details:
{
Description: Resource information for the cost allocation rule ,
Required: True ,
}
{
sourceResources:
{
Description: Source resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
targetResources:
{
Description: Target resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
}
,
status:
{
Description: Status of the rule ,
Enum:
{
NotActive: Rule is saved but not used to allocate costs. ,
Active: Rule is saved and impacting cost allocation. ,
Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. ,
}
,
Required: True ,
}
enum ,
createdDate:
{
Description: Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDate:
{
Description: Time at which the rule was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_CreateOrUpdate (removed)
Description :  Create/Update a rule to allocate cost between different resources within a billing account or enterprise enrollment.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters. ,
Required: True ,
}
string ,
costAllocationRule:
{
Description: Cost allocation rule to be created or updated ,
Required: True ,
}
{
id:
{
Description: Azure Resource Manager Id for the rule. This is a read ony value. ,
Required: False ,
}
string ,
name:
{
Description: Name of the rule. This is a read only value. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule. ,
Required: False ,
}
string ,
properties:
{
Description: Cost allocation rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a cost allocation rule. ,
Required: False ,
}
string ,
details:
{
Description: Resource information for the cost allocation rule ,
Required: True ,
}
{
sourceResources:
{
Description: Source resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
targetResources:
{
Description: Target resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
}
,
status:
{
Description: Status of the rule ,
Enum:
{
NotActive: Rule is saved but not used to allocate costs. ,
Active: Rule is saved and impacting cost allocation. ,
Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. ,
}
,
Required: True ,
}
enum ,
createdDate:
{
Description: Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDate:
{
Description: Time at which the rule was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Azure Resource Manager Id for the rule. This is a read ony value. ,
Required: False ,
}
string ,
name:
{
Description: Name of the rule. This is a read only value. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the rule. This is a read only value of Microsoft.CostManagement/CostAllocationRule. ,
Required: False ,
}
string ,
properties:
{
Description: Cost allocation rule properties ,
Required: False ,
}
{
description:
{
Description: Description of a cost allocation rule. ,
Required: False ,
}
string ,
details:
{
Description: Resource information for the cost allocation rule ,
Required: True ,
}
{
sourceResources:
{
Description: Source resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
targetResources:
{
Description: Target resources for cost allocation. At this time, this list can contain no more than one element. ,
Required: False ,
}
[
string ,
]
,
}
,
status:
{
Description: Status of the rule ,
Enum:
{
NotActive: Rule is saved but not used to allocate costs. ,
Active: Rule is saved and impacting cost allocation. ,
Processing: Rule is saved and cost allocation is being updated. Readonly value that cannot be submitted in a put request. ,
}
,
Required: True ,
}
enum ,
createdDate:
{
Description: Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. ,
Format: date-time ,
Required: False ,
}
string ,
updatedDate:
{
Description: Time at which the rule was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
CostAllocationRules_Delete (removed)
Description :  Delete cost allocation rule for billing account or enterprise enrollment.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/costAllocationRules/{ruleName}
{
api-version:
{
Description: Version of the API to be used with the client request (e.g. '2020-06-01'). ,
Required: True ,
}
string ,
billingAccountId:
{
Description: BillingAccount ID ,
Required: True ,
}
string ,
ruleName:
{
Description: Cost allocation rule name. The name cannot include spaces or any non alphanumeric characters other than '_' and '-'. The max length is 260 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}