Microsoft.DocumentDB (preview:2025-05-01)

2025/05/20 • 3 updated methods

FleetspaceAccount_List (updated)
Description :  Lists all the fleetspaces accounts under a fleetspace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FleetspaceAccount_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "@added_3c8e49dd928b4a608f316984efb8eafc": {
                  "#name": "globalDatabaseAccountProperties",
                  "Description": "Configuration for fleetspace Account in the fleetspace.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "resourceId",
                      "Description": "The resource identifier of global database account in the Fleetspace Account.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "armLocation",
                      "Description": "The location of  global database account in the Fleetspace Account.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              },
              {
                "@removed_f3071531372c4c4d90c47d9a59fd051d": {
                  "#name": "accountResourceIdentifier",
                  "Description": "The resource identifier of global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_0656aec9ea044d75ba65f5d6b0fff2d5": {
                  "#name": "accountLocation",
                  "Description": "The location of  global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of global database accounts in a fleetspace and their properties. ,
Required: False ,
}
[
{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
globalDatabaseAccountProperties:
{
Description: Configuration for fleetspace Account in the fleetspace. ,
Required: False ,
}
{
resourceId:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
armLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
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 ,
}
,
]
,
}
,
}
FleetspaceAccount_Get (updated)
Description :  Retrieves the properties of an existing Azure Cosmos DB fleetspace account under a fleetspace
Reference :  Link ¶

⚶ Changes

{
  "#id": "FleetspaceAccount_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_d9423fab8e2e4f38aaf54434702405b0": {
              "#name": "globalDatabaseAccountProperties",
              "Description": "Configuration for fleetspace Account in the fleetspace.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The resource identifier of global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "armLocation",
                  "Description": "The location of  global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          },
          {
            "@removed_79ad78c686944eca976667cbd55ad57a": {
              "#name": "accountResourceIdentifier",
              "Description": "The resource identifier of global database account in the Fleetspace Account.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_462ce918169b43459eb6960729271afc": {
              "#name": "accountLocation",
              "Description": "The location of  global database account in the Fleetspace Account.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts/{fleetspaceAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
fleetspaceAccountName:
{
Description: Cosmos DB fleetspace account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
globalDatabaseAccountProperties:
{
Description: Configuration for fleetspace Account in the fleetspace. ,
Required: False ,
}
{
resourceId:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
armLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
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 ,
}
,
]
,
}
,
}
FleetspaceAccount_Create (updated)
Description :  Creates an Azure Cosmos DB fleetspace account under a fleetspace.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FleetspaceAccount_Create",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "@added_3def04b05a6145bcb7631f82f0edca07": {
              "#name": "globalDatabaseAccountProperties",
              "Description": "Configuration for fleetspace Account in the fleetspace.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The resource identifier of global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "armLocation",
                  "Description": "The location of  global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          },
          {
            "@removed_542100cc686b48c9b2f0ca0d430f0547": {
              "#name": "accountResourceIdentifier",
              "Description": "The resource identifier of global database account in the Fleetspace Account.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_fa980e4971624681be58aceb6bf8b93b": {
              "#name": "accountLocation",
              "Description": "The location of  global database account in the Fleetspace Account.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@added_394180855361408bb68ddb0b560a286d": {
              "#name": "globalDatabaseAccountProperties",
              "Description": "Configuration for fleetspace Account in the fleetspace.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The resource identifier of global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "armLocation",
                  "Description": "The location of  global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          },
          {
            "@removed_ca4003d65e4c46c6bb1677d8c9dae0cc": {
              "#name": "accountResourceIdentifier",
              "Description": "The resource identifier of global database account in the Fleetspace Account.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_12b50c325834432aa74c0e3b72369324": {
              "#name": "accountLocation",
              "Description": "The location of  global database account in the Fleetspace Account.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "@added_0b36c9e9d1e24501afa3697beebad28d": {
              "#name": "globalDatabaseAccountProperties",
              "Description": "Configuration for fleetspace Account in the fleetspace.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "resourceId",
                  "Description": "The resource identifier of global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "armLocation",
                  "Description": "The location of  global database account in the Fleetspace Account.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          },
          {
            "@removed_148bbcd20f28402b910ce9bdf95cf0dc": {
              "#name": "accountResourceIdentifier",
              "Description": "The resource identifier of global database account in the Fleetspace Account.",
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_8c0a5adfd09e446da433f816f749c1c1": {
              "#name": "accountLocation",
              "Description": "The location of  global database account in the Fleetspace Account.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/fleets/{fleetName}/fleetspaces/{fleetspaceName}/fleetspaceAccounts/{fleetspaceAccountName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
fleetName:
{
Description: Cosmos DB fleet name. Needs to be unique under a subscription. ,
Required: True ,
}
string ,
fleetspaceName:
{
Description: Cosmos DB fleetspace name. Needs to be unique under a fleet. ,
Required: True ,
}
string ,
fleetspaceAccountName:
{
Description: Cosmos DB fleetspace account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The parameters to provide for the current fleetspace account. ,
Required: True ,
}
{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
globalDatabaseAccountProperties:
{
Description: Configuration for fleetspace Account in the fleetspace. ,
Required: False ,
}
{
resourceId:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
armLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
globalDatabaseAccountProperties:
{
Description: Configuration for fleetspace Account in the fleetspace. ,
Required: False ,
}
{
resourceId:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
armLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: An Azure Cosmos DB Global Database Account which is part of a Fleetspace Account. ,
Required: False ,
}
{
provisioningState:
{
Description: A provisioning state of the Fleetspace Account. ,
Enum:
{
Creating: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
globalDatabaseAccountProperties:
{
Description: Configuration for fleetspace Account in the fleetspace. ,
Required: False ,
}
{
resourceId:
{
Description: The resource identifier of global database account in the Fleetspace Account. ,
Required: False ,
}
string ,
armLocation:
{
Description: The location of global database account in the Fleetspace Account. ,
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 ,
}
,
]
,
}
,
}