Services - Check Name Availability

Service:

Healthcare Apis

API Version:

2022-06-01

Check if a service instance name is available.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability?api-version=2022-06-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
name	True	string	The name of the service instance to check.
type	True	string	The fully qualified resource type which includes provider namespace.

Responses

Name	Type	Description
200 OK	ServicesNameAvailabilityInfo	This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the service name is available. If the name is not available, the body contains the reason.
Other Status Codes	ErrorDetails	DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Check name availability

Sample request

HTTP

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.HealthcareApis/checkNameAvailability?api-version=2022-06-01

{
  "type": "Microsoft.HealthcareApis/services",
  "name": "serviceName"
}

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthcareapis
# USAGE
    python check_name_availability_post.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HealthcareApisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.services.check_name_availability(
        check_name_availability_inputs={"name": "serviceName", "type": "Microsoft.HealthcareApis/services"},
    )
    print(response)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/CheckNameAvailabilityPost.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HealthcareApis;
using Azure.ResourceManager.HealthcareApis.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/CheckNameAvailabilityPost.json
// this example is just showing the usage of "Services_CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
HealthcareApisNameAvailabilityContent content = new HealthcareApisNameAvailabilityContent("serviceName", new ResourceType("Microsoft.HealthcareApis/services"));
HealthcareApisNameAvailabilityResult result = await subscriptionResource.CheckHealthcareApisNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "Service name is not available."
}

Definitions

Name	Description
CheckNameAvailabilityParameters	Input values.
ErrorDetails	Error details.
ErrorDetailsInternal	Error details.
ServiceNameUnavailabilityReason	The reason for unavailability.
ServicesNameAvailabilityInfo	The properties indicating whether a given service name is available.

CheckNameAvailabilityParameters

Input values.

Name	Type	Description
name	string	The name of the service instance to check.
type	string	The fully qualified resource type which includes provider namespace.

ErrorDetails

Error details.

Name	Type	Description
error	ErrorDetailsInternal	Error details

ErrorDetailsInternal

Error details.

Name	Type	Description
code	string	The error code.
message	string	The error message.
target	string	The target of the particular error.

ServiceNameUnavailabilityReason

The reason for unavailability.

Name	Type	Description
AlreadyExists	string
Invalid	string

ServicesNameAvailabilityInfo

The properties indicating whether a given service name is available.

Name	Type	Description
message	string	The detailed reason message.
nameAvailable	boolean	The value which indicates whether the provided name is available.
reason	ServiceNameUnavailabilityReason	The reason for unavailability.