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

2025/09/26 • 5 new, 5 deleted methods

Operations_List (new)
Description :  Lists the available billing REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/operations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing operations supported by the Microsoft.Billing resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Identifies if the operation is a data operation. ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Billing. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed such as invoice and billing subscription. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type such as read, write and delete. ,
Required: False ,
}
string ,
description:
{
Description: Description of operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Activate_Promotion (new)
Description :  Activate promotion and create promotion resource.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/promotions/{promotionId}
{
promotionId:
{
Description: Promotion Id ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to activate the promotion. ,
Required: True ,
}
{
sku:
{
Required: False ,
}
{
name:
{
Description: SKU Name of the promotion to activate ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the promotion. ,
Required: False ,
}
string ,
appliedScopes:
{
Description: List of subscriptions getting the benefit of the promotion. ,
Required: False ,
}
[
string ,
]
,
orderId:
{
Description: Unique Id for the promotion order. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
etag:
{
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the promotion ,
Required: False ,
}
string ,
name:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the promotion. ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: This is the DateTime when the promotion would come in effect ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: Last update time of the promotion resource. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the Reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of the promotion. ,
Required: False ,
}
string ,
appliedScopes:
{
Description: List of subscriptions getting the benefit of the promotion. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: Type of resource. "Microsoft.Billing/Promotions" ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Promotion_Get (new)
Description :  Get the details of the `Promotion`.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/promotions/{promotionId}
{
promotionId:
{
Description: Promotion Id ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the promotion ,
Required: False ,
}
string ,
name:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the promotion. ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: This is the DateTime when the promotion would come in effect ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: Last update time of the promotion resource. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the Reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of the promotion. ,
Required: False ,
}
string ,
appliedScopes:
{
Description: List of subscriptions getting the benefit of the promotion. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: Type of resource. "Microsoft.Billing/Promotions" ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Promotions_List (new)
Description :  List of all the `Promotion`s that the user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/promotions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of promotions. ,
Required: False ,
}
[
{
etag:
{
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the promotion ,
Required: False ,
}
string ,
name:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the promotion. ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: This is the DateTime when the promotion would come in effect ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: Last update time of the promotion resource. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the Reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of the promotion. ,
Required: False ,
}
string ,
appliedScopes:
{
Description: List of subscriptions getting the benefit of the promotion. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: Type of resource. "Microsoft.Billing/Promotions" ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Promotion_CheckEligibility (new)
Description :  Checks the eligibility of a subscription for all active promotions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/promotions/{promotionSkuId}/checkEligibility
{
promotionSkuId:
{
Description: Promotion Sku Id ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID that uniquely identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
promotion:
{
Required: False ,
}
{
id:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
name:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
eligible:
{
Description: Specifies whether the subscription is eligible for the promotion ,
Required: False ,
}
boolean ,
reason:
{
Description: Reason in case the subscription is not eligible for promotion. ,
Required: False ,
}
string ,
details:
{
Description: Details in case the subscription is not eligible for promotion. ,
Required: False ,
}
string ,
eligibilitySubscriptionId:
{
Description: Subscription Id on which the eligibility check was performed. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Date till when the promotion is available. ,
Format: date ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists the available billing REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/operations
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2020-05-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of billing operations supported by the Microsoft.Billing resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
isDataAction:
{
Description: Identifies if the operation is a data operation. ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Billing. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed such as invoice and billing subscription. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type such as read, write and delete. ,
Required: False ,
}
string ,
description:
{
Description: Description of operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
}
Activate_Promotion (removed)
Description :  Activate promotion and create promotion resource.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Billing/promotions/{promotionId}
{
promotionId:
{
Description: Promotion Id ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
parameters:
{
Description: Request parameters that are provided to activate the promotion. ,
Required: True ,
}
{
sku:
{
Required: False ,
}
{
name:
{
Description: SKU Name of the promotion to activate ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the promotion. ,
Required: False ,
}
string ,
appliedScopes:
{
Description: List of subscriptions getting the benefit of the promotion. ,
Required: False ,
}
[
string ,
]
,
orderId:
{
Description: Unique Id for the promotion order. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
etag:
{
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the promotion ,
Required: False ,
}
string ,
name:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the promotion. ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: This is the DateTime when the promotion would come in effect ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: Last update time of the promotion resource. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the Reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of the promotion. ,
Required: False ,
}
string ,
appliedScopes:
{
Description: List of subscriptions getting the benefit of the promotion. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: Type of resource. "Microsoft.Billing/Promotions" ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Promotion_Get (removed)
Description :  Get the details of the `Promotion`.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/promotions/{promotionId}
{
promotionId:
{
Description: Promotion Id ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the promotion ,
Required: False ,
}
string ,
name:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the promotion. ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: This is the DateTime when the promotion would come in effect ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: Last update time of the promotion resource. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the Reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of the promotion. ,
Required: False ,
}
string ,
appliedScopes:
{
Description: List of subscriptions getting the benefit of the promotion. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: Type of resource. "Microsoft.Billing/Promotions" ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Promotions_List (removed)
Description :  List of all the `Promotion`s that the user has access.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Billing/promotions
{
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of promotions. ,
Required: False ,
}
[
{
etag:
{
Format: int64 ,
Required: False ,
}
integer ,
id:
{
Description: Identifier of the promotion ,
Required: False ,
}
string ,
name:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
displayName:
{
Description: Friendly name for user to easily identified the promotion. ,
Required: False ,
}
string ,
effectiveDateTime:
{
Description: This is the DateTime when the promotion would come in effect ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedDateTime:
{
Description: Last update time of the promotion resource. ,
Format: date-time ,
Required: False ,
}
string ,
expiryDate:
{
Description: This is the date when the Reservation will expire. ,
Format: date ,
Required: False ,
}
string ,
provisioningState:
{
Description: Current state of the promotion. ,
Required: False ,
}
string ,
appliedScopes:
{
Description: List of subscriptions getting the benefit of the promotion. ,
Required: False ,
}
[
string ,
]
,
}
,
type:
{
Description: Type of resource. "Microsoft.Billing/Promotions" ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link (url) to the next page of results. ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Promotion_CheckEligibility (removed)
Description :  Checks the eligibility of a subscription for all active promotions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Billing/promotions/{promotionSkuId}/checkEligibility
{
promotionSkuId:
{
Description: Promotion Sku Id ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID that uniquely identifies an Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2019-10-01-preview. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
promotion:
{
Required: False ,
}
{
id:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
name:
{
Description: Name of the promotion ,
Required: False ,
}
string ,
eligible:
{
Description: Specifies whether the subscription is eligible for the promotion ,
Required: False ,
}
boolean ,
reason:
{
Description: Reason in case the subscription is not eligible for promotion. ,
Required: False ,
}
string ,
details:
{
Description: Details in case the subscription is not eligible for promotion. ,
Required: False ,
}
string ,
eligibilitySubscriptionId:
{
Description: Subscription Id on which the eligibility check was performed. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Date till when the promotion is available. ,
Format: date ,
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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: The sub 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 ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}