---
title: "POST /{scope}/providers/Microsoft.Help/checkNameAvailability"
method: POST
path: "/{scope}/providers/Microsoft.Help/checkNameAvailability"
---

# POST /{scope}/providers/Microsoft.Help/checkNameAvailability

`POST /{scope}/providers/Microsoft.Help/checkNameAvailability`

This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions

## Path parameters

- `scope` string, required

## Parameters

- `../../../../../../common-types/resource-management/v5/types.json#/components/parameters/ApiVersionParameter` — unresolved $ref

## Request body

- CheckNameAvailabilityRequest — unresolved $ref

## Response `200`

The request has succeeded.

- CheckNameAvailabilityResponse — Response for whether the requested resource name is available or not.
  - `nameAvailable` boolean — Returns true or false depending on the availability of the name
  - `reason` string — Reason for why value is not available. This field is returned if nameAvailable is false.
  - `message` string — Gets an error message explaining the 'reason' value with more details. This field is returned iif nameAvailable is false.

## Other responses

- `default` — An unexpected error response.

## Changes

> 4 revisions in range; 1 could not be searched.

- **2026-07-13** (2023-01-01-preview) `6cda0116dbab` — 1 warning, 2 info
  - deleted the `query` request parameter `api-version`
  - api operation id `CheckNameAvailability_Post` removed and replaced with `CheckNameAvailability_CheckAvailability`
  - api tag `checkNameAvailability` removed
- **2026-07-13** (2023-01-01-preview) `97ac17161450` — 3 info
  - api operation id `Diagnostics_CheckNameAvailability` removed and replaced with `CheckNameAvailability_Post`
  - api tag `checkNameAvailability` added
  - api tag `diagnostics` removed

[Change history](https://skmtc.dev/azure/apis/help-microsoft-help-help/changes/:scope/providers/Microsoft.Help/checkNameAvailability/post.md)

---

[API](https://skmtc.dev/azure/apis/help-microsoft-help-help.md) · [All operations](https://skmtc.dev/azure/apis/help-microsoft-help-help/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/help-microsoft-help-help/revisions/6cda0116dbab/schema)
