Skip to content

Microsoft Azure Store Cmdlets

Jump to bottom
Abdelrahman Elogeel edited this page May 29, 2014 · 1 revision

Table of Content

Get all the available Azure Store Add-Ons for purchasing

Get-AzureStoreAddOn [[-Country] <String>] -ListAvailable [<SwitchParameter>]

  • Parameters

    • -Country: If specified only return the Azure Store Add-Ons available in that Country. Default is US.
    • -ListAvailable: Get all the available Azure Store Add-Ons for purchasing.

  • Output

    Provider        Addon        Locations                          Plans
--------------  -----------  ---------------------------------  ------------------------------------
Sendgrid        SendGrid     West US, East US                   free, bronze, silver, gold, platinum
Bing            Search       West US, West Europe, East Asia    2.5M-1, 100K-1
MongoLab        MongoDB      Southeast Asia                     Free

    Notice that there we will show the identifiers of the plan, add-on and plan so that people can use them directly as the parameters of other Azure Store cmdlets.

  • Verbose

  • Errors

    • Should check that country code is in proper form (two character ISO-3166) or return an error statign that a two character country code is required

Get One or All Azure Store Add-Ons you purchased

Get-AzureStoreAddOn [[-Name] <String>]
  • Parameters
    • -Name: Name of the add-on instances you want to get.
      • If provided, will return all the instances which match the name if provided.
      • If not provided, will return all the add-on instances of the subscription.
  • Output: One add-on object or a list of add-on objects. Each object is shown as the following format. 
    Name                : mongodb01
Type                : App Service
AddOn               : mongolab
Plan                : free
Location            : West US
SchemaVersion       :
State               : Started
LastOperationStatus :
                      Type   : Create
                      Result : Succeeded
OutputItems         :
                      MONGOLAB_URI : mongodb://mongolab2:6eYtHAZTnivtBM1rXN6LDDNB1xVgxdpzD_VPrRPEcso-@ds041177.mongol...
    Notice that we will only show OutputItems for data add-ons since the value of this property is not useful for app service add-on at all for now.
  • Verbose

Purchase an Azure Store Add-On

New-AzureStoreAddOn [-Name] <String> [-Addon] <String> [-Plan] <String> [[-Location] <String>]
 [[-PromotionCode] <String>]
  • Parameters
    • -Name: Name of the add-on instance being created. Must be unique per provider per location.
    • -Addon: Identifier of the add-on you want to purchase.
    • -Plan: Identifier of the plan you want to purchase.
    • -Location: Location of the add-on instance being created. Default is East US.
    • -PromotionCode: Promotion Code if you have any.
    • -WhatIf:
  • Prompt
    • Microsoft Add-Ons 
      

      • 

    

    • 



By typing "Yes", I (a) authorize Microsoft to charge my current payment method on a monthly basis
for the amount indicated at  for  until my service is cancelled or terminated, and (b)
agree to the ’s terms of user and privacy statement at  and (c) agree to sharing my
contact information with .
* Non-Microsoft Add-Onsbash
By typing "Yes", I (a) authorize Microsoft to charge my current payment method on a monthly basis
for the amount indicated at  for  until my service is cancelled or terminated, and (b)
acknowledge the offering is provided by , not Microsoft, and agree to ’s terms of
use and privacy statement at  and (c) agree to sharing my contact information with .
```


    

  • 
Output: The same as Get-AzureStoreAddon with a single add-on instance returned.
    • 

  • 
Verbose:
    • 




 Change the Plan and/or Promotion Code of an Azure Store Add-On


Set-AzureStoreAddOn [-Name] <String> [-Plan] <String> [[-PromotionCode] <String>]


    

  • 
Parameters

      

    • 
-Name: Name of the add-on instance you want to change. If there are more than 1 add-on instance with the given name, operation will abort and an error will be reported.
      • 

    • 
-Plan: Name of the new plan you are going to use. It cannot be the same as the current plan.
      • 

    • 
-PromotionCode: Promotion code you can apply to the new plan if you have any. It only works when you specify the -Plan parameter and set it to a new plan.
      • 

    

    • 

  • 
Prompt

      

    • Microsoft Add-Ons

      

      • 

    

    • 



Note - You will be charged the amount for the new plan, without being refunded for time remaining
in the existing plan.
By typing "Yes", I (a) authorize Microsoft to charge my current payment method on a monthly basis
for the amount indicated at  for  until my service is cancelled or terminated, and (b)
agree to the ’s terms of user and privacy statement at  and (c) agree to sharing my
contact information with .
* Non-Microsoft Add-Onsbash
Note - You will be charged the amount for the new plan, without being refunded for time remaining
in the existing plan.
By typing "Yes", I (a) authorize Microsoft to charge my current payment method on a monthly basis
for the amount indicated at  for  until my service is cancelled or terminated, and (b)
acknowledge the offering is provided by , not Microsoft, and agree to ’s terms of
use and privacy statement at  and (c) agree to sharing my contact information with .
```


    

  • 
Output: The same as Get-AzureStoreAddon with a single add-on instance returned.
    • 

  • 
Verbose:
    • 




 Remove an Azure Store Add-On you purchased


Remove-AzureStoreAddOn [-Name] <String>


    

  • 
Parameters

      

    • 
-Name: Name of the add-on instance you want to remove. If there are more than 1 add-on instance with the given name, operation will abort and an error will be reported.
      • 

    • 
-WhatIf:
      • 

    

    • 

  • 
Prompt

    

    • 



If you delete this addon, your data may be deleted and the operation may not be undone.
You may have to purchase it again from the Azure Store to use it. The price of the add-on
may not be refunded. Are you sure you want to delete this add-on? Enter “Yes” to confirm.
```


    

  • 
Output: See what the REST API returns.
    • 

  • 
Verbose:
    • 



              


          



  
          

            


            
Clone this wiki locally