Microsoft.Management (preview:2024-02-01)

2025/09/29 • 1 updated methods

CheckNameAvailability (updated)
Description :  Checks if the specified management group or service group name is valid and unique
Reference :  Link ¶

⚶ Changes

{
  "#id": "CheckNameAvailability",
  "Description": {
    "new": "Checks if the specified management group or service group name is valid and unique",
    "old": "Checks if the specified management group name is valid and unique"
  },
  "$parameters": [
    {
      "#name": "checkNameAvailabilityRequest",
      "Description": {
        "new": "Management group or service group name availability check parameters.",
        "old": "Management group name availability check parameters."
      },
      "$schema": {
        "Description": {
          "new": "Management group or service group name availability check parameters.",
          "old": "Management group name availability check parameters."
        },
        "$properties": [
          {
            "#name": "type",
            "Enum": {
              "new": [
                [
                  "Microsoft.Management/managementGroups",
                  ""
                ],
                [
                  "Microsoft.Management/serviceGroups",
                  ""
                ]
              ],
              "old": [
                [
                  "Microsoft.Management/managementGroups",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Describes the result of the request to check management group name or service group name availability.",
        "old": "Describes the result of the request to check management group name availability."
      }
    }
  }
}

⚼ Request

POST:  /providers/Microsoft.Management/checkNameAvailability
{
api-version:
{
Description: Version of the API to be used with the client request. The current version is 2018-01-01-preview. ,
Required: True ,
}
string ,
checkNameAvailabilityRequest:
{
Description: Management group or service group name availability check parameters. ,
Required: True ,
}
{
name:
{
Description: the name to check for availability ,
Required: False ,
}
string ,
type:
{
Description: fully qualified resource type which includes provider namespace ,
Enum:
{
Microsoft.Management/managementGroups: No description available. ,
Microsoft.Management/serviceGroups: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Required. True indicates name is valid and available. False indicates the name is invalid, unavailable, or both. ,
Required: False ,
}
boolean ,
reason:
{
Description: Required if nameAvailable == false. Invalid indicates the name provided does not match the resource provider's naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Required if nameAvailable == false. Localized. If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: A human-readable representation of the error's details. ,
Required: False ,
}
string ,
}
,
}