Test-AzsNameAvailability
Get the list of subscriptions.
Syntax
Test-AzsNameAvailability
[-SubscriptionId <String>]
[-Name <String>]
[-ResourceType <String>]
[-DefaultProfile <PSObject>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Test-AzsNameAvailability
-NameAvailabilityDefinition \<ICheckNameAvailabilityDefinition>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Test-AzsNameAvailability
-INPUTOBJECT \<ISubscriptionsAdminIdentity>
-NameAvailabilityDefinition \<ICheckNameAvailabilityDefinition>
[-DefaultProfile <PSObject>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Test-AzsNameAvailability
-INPUTOBJECT \<ISubscriptionsAdminIdentity>
[-Name <String>]
[-ResourceType <String>]
[-DefaultProfile <PSObject>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Description
Get the list of subscriptions.
Examples
Example 1
PS C:\> Test-AzsNameAvailability -ResourceType "Microsoft.Subscriptions.Admin/offers" -Name "testoffer" | fl *
Message : A resource of type 'Microsoft.Subscriptions.Admin/offers' with name 'testoffer' already exists. Please select a different name.
NameAvailable : False
Reason : AlreadyExists
Returns the availability of the specified subscription resource type and name
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | System.Management.Automation.SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | System.Management.Automation.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: | Microsoft.Azure.PowerShell.Cmdlets.SubscriptionsAdmin.Models.ISubscriptionsAdminIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
The resource name to verify.
Type: | System.String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NameAvailabilityDefinition
The check name availability action definition. To construct, see NOTES section for NAMEAVAILABILITYDEFINITION properties and create a hash table.
Type: | Microsoft.Azure.PowerShell.Cmdlets.SubscriptionsAdmin.Models.Api20151101.ICheckNameAvailabilityDefinition |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceType
The resource type to verify.
Type: | System.String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.
Type: | System.String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | System.Management.Automation.SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Azure.PowerShell.Cmdlets.SubscriptionsAdmin.Models.Api20151101.ICheckNameAvailabilityDefinition
Microsoft.Azure.PowerShell.Cmdlets.SubscriptionsAdmin.Models.ISubscriptionsAdminIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.SubscriptionsAdmin.Models.Api20151101.ICheckNameAvailabilityResponse
ALIASES
Notes
COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <ISubscriptionsAdminIdentity>: Identity Parameter
[DelegatedProvider <String>]
: DelegatedProvider identifier.[DelegatedProviderSubscriptionId <String>]
: Delegated provider subscription identifier.[Id <String>]
: Resource identity path[Location <String>]
: The AzureStack location.[ManifestName <String>]
: The manifest name.[Offer <String>]
: Name of an offer.[OfferDelegationName <String>]
: Name of a offer delegation.[OperationsStatusName <String>]
: The operation status name.[Plan <String>]
: Name of the plan.[PlanAcquisitionId <String>]
: The plan acquisition Identifier[Quota <String>]
: Name of the quota.[ResourceGroupName <String>]
: The resource group the resource is located under.[SubscriptionId <String>]
: Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.[TargetSubscriptionId <String>]
: The target subscription ID.[Tenant <String>]
: Directory tenant name.
NAMEAVAILABILITYDEFINITION <ICheckNameAvailabilityDefinition>: The check name availability action definition.
[Name <String>]
: The resource name to verify.[ResourceType <String>]
: The resource type to verify.