This is an archive version of the document. To get the most up-to-date information, see the current version.Add-VBOAzureServiceAccount
Short Description
Creates Microsoft Azure service accounts that are required to use the Azure archiver appliance when transferring backed-up data from Azure Blob storage to Azure Archive storage.
Syntax
This cmdlet provides parameter sets that allow you to:
- Use an existing Azure AD application and authenticate to Microsoft 365 with an application certificate.
Add-VBOAzureServiceAccount -Region <VBOAzureRegionType> -TenantId <string> -ApplicationId <guid> -ApplicationCertificatePath <string> [-ApplicationCertificatePassword <securestring>] [-ConfigureApplication <switchparameter>] [-Description <string>] [-SubscriptionIds <string[]>] [<CommonParameters>] |
- Register a new Azure AD application in Azure Active Directory.
Add-VBOAzureServiceAccount -Region <VBOAzureRegionType> -TenantId <string> -ApplicationName <string> -ApplicationCertificatePath <string> [-ApplicationCertificatePassword <securestring>] [-Description <string>] [-SubscriptionIds <string[]>] [<CommonParameters>] |
- Use an existing Azure AD application and authenticate to Microsoft 365 with an application secret.
Add-VBOAzureServiceAccount -Region <VBOAzureRegionType> -TenantId <string> -ApplicationId <guid> -ApplicationSecret <securestring> [-ConfigureApplication <switchparameter>] [-Description <string>] [-SubscriptionIds <string[]>] [<CommonParameters>] |
Detailed Description
This cmdlet creates the VBOAzureServiceAccount object. This object contains details of the Microsoft Azure service account that is required to use the Azure archiver appliance when transferring backed-up data from Azure Blob storage to Azure Archive storage.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
|---|---|---|---|---|---|---|
Region | Specifies a Microsoft Azure region. You can select the following types of region:
| VBOAzureRegionType | True | Named | False | False |
ApplicationName | Specifies a name of a new Azure AD application. The cmdlet will register an Azure AD application with this name in Azure Active Directory. | String | True | Named | False | False |
ApplicationId | Specifies an Azure AD application ID. The cmdlet will use this application ID to set up a secure connection to Microsoft 365 organization. | Guid | True | Named | False | False |
ApplicationCertificatePassword | Specifies the certificate password. The cmdlet will use this password to confirm the certificate that you want to import to an Azure AD application. | SecureString | False | Named | False | False |
ApplicationCertificatePath | Specifies a path to the folder where the certificate is located. The cmdlet will import the certificate that is located in this path to set up a secure connection to Microsoft 365 organization. | String | True | Named | False | False |
ApplicationSecret | Specifies an application secret. The cmdlet will use an application secret to set up a secure connection to Microsoft 365 organization. | SecureString | True | Named | False | False |
TenantId | Specifies the Microsoft 365 organization ID in Microsoft Azure. | String | True | Named | False | False |
ConfigureApplication | Defines that the cmdlet will configure settings of an existing Azure AD application: grant the required permissions and register the specified certificate in Azure Active Directory. | SwitchParameter | False | Named | False | False |
Description | Specifies a description of Microsoft Azure service account. The default description contains information on the user who created the Microsoft Azure service account, date and time when the Microsoft Azure service account was created. | String | False | Named | False | False |
SubscriptionIds | Specifies an array of subscriptions associated with a user account that was used to sign in to Microsoft Azure. | String[] | False | Named | False | 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 VBOAzureServiceAccount object that contains Microsoft Azure service account details.
Examples
Example 1. Creating Microsoft Azure Service Account Through Registering New Azure AD Application
Example 2. Creating Microsoft Azure Service Account Through Using Existing Azure AD Application with Application Certificate
Example 3. Creating Microsoft Azure Service Account Through Using Existing Azure AD Application with Application Secret
Related Commands
