Test-AzHealthcareServiceNameAvailability

Module:

Az.HealthcareApis

Check if a service instance name is available.

Syntax

Test-AzHealthcareServiceNameAvailability
    [-SubscriptionId <String>]
    -Name <String>
    -Type <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-AzHealthcareServiceNameAvailability
    [-SubscriptionId <String>]
    -CheckNameAvailabilityInput <ICheckNameAvailabilityParameters>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-AzHealthcareServiceNameAvailability
    -InputObject <IHealthcareApisIdentity>
    -Name <String>
    -Type <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Test-AzHealthcareServiceNameAvailability
    -InputObject <IHealthcareApisIdentity>
    -CheckNameAvailabilityInput <ICheckNameAvailabilityParameters>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Check if a service instance name is available.

Examples

Example 1: Check if a service instance name is available.

Test-AzHealthcareServiceNameAvailability -Name azpsdicom -Type Microsoft.HealthcareApis/services

Message NameAvailable Reason
------- ------------- ------
        True

Check if a service instance name is available.

Parameters

-CheckNameAvailabilityInput

Input values. To construct, see NOTES section for CHECKNAMEAVAILABILITYINPUT properties and create a hash table.

Type:	ICheckNameAvailabilityParameters
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IHealthcareApisIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the service instance to check.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The subscription identifier.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Type

The fully qualified resource type which includes provider namespace.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

ICheckNameAvailabilityParameters

IHealthcareApisIdentity

Outputs

IServicesNameAvailabilityInfo