Get-VBOAzureSubscription
Short Description
Returns Microsoft Azure subscriptions associated with a user account that will be used to access Azure Blob Storage.
Syntax
This cmdlet provides parameter sets that allow you to:
- Get a subscription by the Microsoft Azure service account and the subscription name.
Get-VBOAzureSubscription -ServiceAccount <VBOAzureServiceAccount> [-Name <String>] [<CommonParameters>] |
- Get a subscription by the subscription ID.
Get-VBOAzureSubscription [-Id <String>] [<CommonParameters>] |
- Get a subscription by the Microsoft Entra region.
Get-VBOAzureSubscription [-DeviceCode] -Region <VBOOffice365Region> [<CommonParameters>] |
Detailed Description
This cmdlet returns an array of subscriptions associated with a user account that will be used to access Azure Blob Storage.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
ServiceAccount | Specifies a Microsoft Azure service account. The cmdlet will return an array of subscriptions added to this service account. | Accepts the VBOAzureServiceAccount object. To get this object, run the Get-VBOAzureServiceAccount cmdlet. | True | Named | True (ByValue) |
Name | Specifies a subscription name. The cmdlet will return the subscription with this name. | String | False | Named | False |
Id | Specifies a subscription ID. The cmdlet will return the subscription with this ID. | String | False | Named | False |
DeviceCode | Defines that the cmdlet will require an authentication code to connect to Microsoft Azure and get Microsoft Azure subscriptions. Default: False | SwitchParameter | False | Named | False |
Region | Specifies Microsoft Entra region where Microsoft 365 organization datacenter is located:
Default: Worldwide | VBOOffice365Region | True | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VBOAzureSubscription object that contains details on subscriptions associated with a user account that will be used to access Azure Blob Storage.
Examples
Example 1. Getting Microsoft Azure Subscription by Subscription Name
This example shows how to get a Microsoft Azure subscription by the subscription name.
Perform the following steps:
|
Example 2. Getting Microsoft Azure Subscription by ID
This command returns a Microsoft Azure subscription by ID.
|
Example 3. Getting Microsoft Azure Subscription by Microsoft Entra region
This command returns a Microsoft Azure subscription for the China Microsoft Entra region with prompting the authentication code.
|
Related Commands