Microsoft.Billing (preview:2024-08-01)

2025/05/22 • 2 updated methods

Migration_Get (updated)
Description :  Gets migration mapping details.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migration_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@removed_57a1871a6d74432480ac43dec2817cc4": {
              "#name": "locale",
              "Description": "Locale for notifications. Optional property, used only for migrate enrollment",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_861d7363f49d408d8d637a87c83dd4cd": {
              "#name": "products",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Product Details.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "productType",
                    "Description": "product type",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "productId",
                    "Description": "product Id",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "name",
                    "Description": "product name",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "skuDescription",
                    "Description": "product sku description",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "status",
                    "Description": "product transfer status",
                    "Enum": [
                      [
                        "NotStarted",
                        ""
                      ],
                      [
                        "InProgress",
                        ""
                      ],
                      [
                        "Completed",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/migrations/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Migration Details. ,
Required: False ,
}
{
destinationBillingScope:
{
Description: Destination billing scope to be mapped. ,
Required: False ,
}
string ,
status:
{
Description: Migration Status ,
Enum:
{
Draft: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
CompletedWithErrors: No description available. ,
}
,
Required: False ,
}
enum ,
transferId:
{
Description: Transfer Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Migration_Put (updated)
Description :  Migrates from source to destination billing scope
Reference :  Link ¶

⚶ Changes

{
  "#id": "Migration_Put",
  "$parameters": {
    "parameters": {
      "Description": {
        "new": "Migration details.",
        "old": "Migration Details."
      },
      "$properties": {
        "@added_7d979de951bc4edca6ca857eb647e93c": {
          "#name": "properties",
          "Description": "Migration Details.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "destinationBillingScope",
              "Description": "Destination billing scope to be mapped.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "status",
              "Description": "Migration Status",
              "Enum": [
                [
                  "Draft",
                  ""
                ],
                [
                  "InProgress",
                  ""
                ],
                [
                  "Completed",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "CompletedWithErrors",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "transferId",
              "Description": "Transfer Id",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@removed_a0a52a465c5347f096013e0e5f385d50": {
          "#name": "destinationBillingScope",
          "Description": "Destination billing scope to be mapped.",
          "Required": false,
          "Type": "string"
        },
        "@removed_7c1dada0e084440fa9527909041c6b4b": {
          "#name": "status",
          "Description": "Migration Status",
          "Enum": [
            [
              "Draft",
              ""
            ],
            [
              "InProgress",
              ""
            ],
            [
              "Completed",
              ""
            ],
            [
              "Failed",
              ""
            ],
            [
              "CompletedWithErrors",
              ""
            ]
          ],
          "Required": false,
          "Type": "string"
        },
        "@removed_232cf448150c4f7ab05fe70f3f2ad806": {
          "#name": "locale",
          "Description": "Locale for notifications. Optional property, used only for migrate enrollment",
          "Required": false,
          "Type": "string"
        },
        "@removed_a7b5458166e14ffca7f8570c3da51558": {
          "#name": "transferId",
          "Description": "Transfer Id",
          "Required": false,
          "Type": "string"
        },
        "@removed_64203f1c4f4347518e7b4b020d86fd52": {
          "#name": "products",
          "Required": false,
          "Type": "array",
          "$items": {
            "Description": "Product Details.",
            "Type": "object",
            "$properties": [
              {
                "#name": "productType",
                "Description": "product type",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "productId",
                "Description": "product Id",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "name",
                "Description": "product name",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "skuDescription",
                "Description": "product sku description",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "status",
                "Description": "product transfer status",
                "Enum": [
                  [
                    "NotStarted",
                    ""
                  ],
                  [
                    "InProgress",
                    ""
                  ],
                  [
                    "Completed",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@removed_9b87db57374b42c5aef35edab0cc65dd": {
              "#name": "locale",
              "Description": "Locale for notifications. Optional property, used only for migrate enrollment",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_41b577146c684d6b8df604c16db05b6d": {
              "#name": "products",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Product Details.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "productType",
                    "Description": "product type",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "productId",
                    "Description": "product Id",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "name",
                    "Description": "product name",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "skuDescription",
                    "Description": "product sku description",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "status",
                    "Description": "product transfer status",
                    "Enum": [
                      [
                        "NotStarted",
                        ""
                      ],
                      [
                        "InProgress",
                        ""
                      ],
                      [
                        "Completed",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /providers/Microsoft.Billing/billingAccounts/{billingAccountName}/migrations/default
{
billingAccountName:
{
Description: The ID that uniquely identifies a billing account. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. The current version is 2024-04-01. ,
Required: True ,
}
string ,
parameters:
{
Description: Migration details. ,
Required: True ,
}
{
properties:
{
Description: Migration Details. ,
Required: False ,
}
{
destinationBillingScope:
{
Description: Destination billing scope to be mapped. ,
Required: False ,
}
string ,
status:
{
Description: Migration Status ,
Enum:
{
Draft: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
CompletedWithErrors: No description available. ,
}
,
Required: False ,
}
enum ,
transferId:
{
Description: Transfer Id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Migration Details. ,
Required: False ,
}
{
destinationBillingScope:
{
Description: Destination billing scope to be mapped. ,
Required: False ,
}
string ,
status:
{
Description: Migration Status ,
Enum:
{
Draft: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
CompletedWithErrors: No description available. ,
}
,
Required: False ,
}
enum ,
transferId:
{
Description: Transfer Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}