Skip to content

Test-AzAppConfigurationStoreNameAvailability.md

Latest commit

 

History

History
172 lines (132 loc) · 3.82 KB

Test-AzAppConfigurationStoreNameAvailability.md

File metadata and controls

172 lines (132 loc) · 3.82 KB
external help file
Module Name Az.AppConfiguration
online version https://learn.microsoft.com/powershell/module/az.appconfiguration/test-azappconfigurationstorenameavailability
schema 2.0.0

Test-AzAppConfigurationStoreNameAvailability

SYNOPSIS

Checks whether the configuration store name is available for use.

SYNTAX

CheckExpanded (Default)

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

CheckViaJsonFilePath

Test-AzAppConfigurationStoreNameAvailability -JsonFilePath <String> [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

CheckViaJsonString

Test-AzAppConfigurationStoreNameAvailability -JsonString <String> [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

DESCRIPTION

Checks whether the configuration store name is available for use.

EXAMPLES

Example 1: Test availability of the app configuration store name

Test-AzAppConfigurationStoreNameAvailability -Name appconfig-test01
Message                          NameAvailable Reason
-------                          ------------- ------
The specified name is available. True

This command tests availability of the app configuration store name.

PARAMETERS

-DefaultProfile

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

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

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

-JsonFilePath

Path of Json file supplied to the Check operation

Type: System.String
Parameter Sets: CheckViaJsonFilePath
Aliases:

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

-JsonString

Json string supplied to the Check operation

Type: System.String
Parameter Sets: CheckViaJsonString
Aliases:

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

-Name

The name to check for availability.

Type: System.String
Parameter Sets: CheckExpanded
Aliases:

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

-SubscriptionId

The Microsoft Azure subscription ID.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.AppConfiguration.Models.INameAvailabilityStatus

NOTES

RELATED LINKS