check_name_availability

Creates, updates, deletes, gets or lists a check_name_availability resource.

Overview

Name	check_name_availability
Type	Resource
Id	azure_extras.self_help.check_name_availability

Fields

The following fields are returned by SELECT queries:

check_availability

Name	Datatype	Description
message	string	Gets an error message explaining the 'reason' value with more details. This field is returned iif nameAvailable is false.
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_availability	select	scope		This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
scope	string	scope = resourceUri of affected resource. For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read. Required.

SELECT examples

check_availability

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

SELECT
message,
nameAvailable,
reason
FROM azure_extras.self_help.check_name_availability
WHERE scope = '{{ scope }}' -- required
;