Edit

Share via

New-AzureRmDataLakeAnalyticsCatalogSecret

  • Reference
Module:
AzureRM.DataLakeAnalytics

Creates a Data Lake Analytics catalog secret.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmDataLakeAnalyticsCatalogSecret
   [-Account] <String>
   [-DatabaseName] <String>
   [-Secret] <PSCredential>
   [-DatabaseHost] <String>
   [-Port] <Int32>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
New-AzureRmDataLakeAnalyticsCatalogSecret
   [-Account] <String>
   [-DatabaseName] <String>
   [-Secret] <PSCredential>
   [-Uri] <Uri>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzureRmDataLakeAnalyticsCatalogSecret cmdlet creates a secret to use in an Azure Data Lake Analytics catalog.

Examples

Example 1: Get the secret for a catalog

PS C:\>New-AzureRmDataLakeAnalyticsCatalogSecret -Account "ContosoAdlAccount" -DatabaseName "databaseName" -Secret (Get-Credential) -Host "https://example.contoso.com" -Port 8080

This command gets the secret corresponding to the specified account, database, credential, and host.

Parameters

-Account

Specifies the name of the Data Lake Analytics account.

Type:String
Aliases:AccountName
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DatabaseHost

Specifies the host name for the database the secret is associated with in the format 'mydatabase.contoso.com'.

Type:String
Aliases:Host
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DatabaseName

Specifies the name of the database that holds the secret.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Port

Specifies the port number of the secret.

Type:Int32
Position:4
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Secret

Specifies the name and password of the secret.

Type:PSCredential
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Uri

Specifies the Uniform Resource Identifier (URI) of the secret.

Type:Uri
Position:3
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

PSCredential

Uri

Int32

Outputs

USqlSecret