Test-AzSupportCommunicationNameAvailability
Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
Syntax
Test-AzSupportCommunicationNameAvailability
[-SubscriptionId <String>]
-SupportTicketName <String>
-Name <String>
-Type <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-AzSupportCommunicationNameAvailability
[-SubscriptionId <String>]
-SupportTicketName <String>
-JsonString <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-AzSupportCommunicationNameAvailability
[-SubscriptionId <String>]
-SupportTicketName <String>
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-AzSupportCommunicationNameAvailability
[-SubscriptionId <String>]
-SupportTicketName <String>
-CheckNameAvailabilityInput <ICheckNameAvailabilityInput>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-AzSupportCommunicationNameAvailability
-InputObject <ISupportIdentity>
-Name <String>
-Type <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Test-AzSupportCommunicationNameAvailability
-InputObject <ISupportIdentity>
-CheckNameAvailabilityInput <ICheckNameAvailabilityInput>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
Examples
Example 1: Check friendly name availability of a communication for a support ticket
Test-AzSupportCommunicationNameAvailability -Name "testCommunication" -SupportTicketName "2402084010005835" -Type "Microsoft.Support/communications"
Message NameAvailable Reason
------- ------------- ------
True
Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket under an Azure subscription.
Parameters
-CheckNameAvailabilityInput
Input of CheckNameAvailability API.
Type: | ICheckNameAvailabilityInput |
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
Type: | ISupportIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-JsonFilePath
Path of Json file supplied to the Check operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JsonString
Json string supplied to the Check operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The resource name to validate.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SupportTicketName
Support ticket name.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Type
The type of resource.
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 |