display custom error message in Azure powershell and exit

Question

I am trying to get the list of storages name for a specific subscription using powershell. If I have the correct subscription name, I get the result but if there is some mistype then I get this error:

Select-AzSubscription : Please provide a valid tenant or a valid subscription. Select-AzSubscription -SubscriptionName $subName CategoryInfo : CloseError: (:) [Set-AzContext], ArgumentException FullyQualifiedErrorId : Microsoft.Azure.Commands.Profile.SetAzureRMContextCommand

What would be the best option to handle the error message and exit out from the script with a message "Couldn't find the subscription". Here is the powershell code:

###Set a subscription name
$subName = "Test SubscriptionName"

Select-AzSubscription -SubscriptionName $subName

### Select storage accounts based for above subscription
$sAccount = Get-AzStorageAccount | select StorageAccountName
$sAccount

Ivan Glasenberg · Accepted Answer · 2020-12-10 01:02:42Z

1

The better solution should be use the scripts below:

$subName = "Test SubscriptionName"

try{ 
     Select-AzSubscription -SubscriptionName $subName -ErrorAction Stop        
    } 
catch [System.ArgumentException]{
        Write-Host "Couldn't find the subscription"

        #use exit to exit the script
        exit
     }

#Select storage accounts based for above subscription      
$sAccount = Get-AzStorageAccount | select StorageAccountName
$sAccount

answered Dec 10, 2020 at 1:02

Ivan Glasenberg

30.3k2 gold badges56 silver badges68 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Jack Smith Over a year ago

Thank you, makes sense! That way, I can see where the error is.

Mike Smith - MCT · Accepted Answer · 2020-12-10 01:03:45Z

1

You can just do a null test:

$sub = Select-AzSubscription -SubscriptionName $subName -ErrorAction SilentlyContinue
if ($sub -eq $null) 
  { 
    "Couldn't find the subscription"
    ## Add you exit code here!
  }  
else
  { "Good subname" }

answered Dec 10, 2020 at 1:03

Mike Smith - MCT

1,2611 gold badge11 silver badges16 bronze badges

Comments

Jack Smith · Accepted Answer · 2020-12-10 01:07:46Z

1

I was able to solve it using try-catch method. Here is the solution:

 $subName = "Test SubscriptionName"

Try { 
     Select-AzSubscription -SubscriptionName $subName -ErrorAction Stop
        #Select storage accounts based for above subscription
         $sAccount = Get-AzStorageAccount | select StorageAccountName
          $sAccount
         } 
Catch{
        Write-Host  $_.Exception.Message
     }

edited Dec 10, 2020 at 1:07

answered Dec 10, 2020 at 0:52

Jack Smith

631 silver badge7 bronze badges

4 Comments

Ivan Glasenberg Over a year ago

It's not a good solution. If the subname is correct, and the error is from the following code like Get-AzStorageAccount, your code still prints the message "couldn't find the subscription".

Jack Smith Over a year ago

@IvanYang how about now? is it possible to add a custom error message with the Exception message ? For example: if the error is in subName then 'Please re-enter your subName' + Exception message and if it is in Get-AzStorageAccount then 'You don't have storage account' + Exception?

Ivan Glasenberg Over a year ago

yes, you can add a custom error message. And you can also specify the exception type as mentioned in my answer.

Jack Smith Over a year ago

@IvanYang, just saw your answer. Thank you!

Collectives™ on Stack Overflow

display custom error message in Azure powershell and exit

3 Answers 3

1 Comment

Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related