Invoke-AzSelfHelpCheckNameAvailability
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus .
This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions
Syntax
PostExpanded (Default)
Invoke-AzSelfHelpCheckNameAvailability
-Scope <String>
[-Name <String>]
[-Type <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Post
Invoke-AzSelfHelpCheckNameAvailability
-Scope <String>
-CheckNameAvailabilityRequest <ICheckNameAvailabilityRequest>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PostViaJsonFilePath
Invoke-AzSelfHelpCheckNameAvailability
-Scope <String>
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PostViaJsonString
Invoke-AzSelfHelpCheckNameAvailability
-Scope <String>
-JsonString <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
This API is used to check the uniqueness of a resource name used for a diagnostic, troubleshooter or solutions
Examples
Example 1: Invoke-AzSelfHelpCheckNameAvailability
$CHECKNAMEAVAILABILITYREQUEST = [ordered]@{
"name" ="helloworld"
"type" = "solutions"
}
Invoke-AzSelfHelpCheckNameAvailability -Scope "/subscriptions/6bded6d5-a6af-43e1-96d3-bf71f6f5f8ba" -CheckNameAvailabilityRequest $CHECKNAMEAVAILABILITYREQUEST
Message NameAvailable Reason
------- ------------- ------
True
Checks if resource name is available/unique for the scope or not
Parameters
-CheckNameAvailabilityRequest
The check availability request body.
Parameter properties
Parameter sets
Post
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Post operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PostViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Post operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PostViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the resource for which availability needs to be checked.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PostExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Scope
scope = resourceUri of affected resource.<br/> For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Type
The resource type.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
PostExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
