New-AzureRmDataLakeAnalyticsCatalogCredential
Creates a new Azure Data Lake Analytics catalog credential.
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-AzureRmDataLakeAnalyticsCatalogCredential
[-Account] <String>
[-DatabaseName] <String>
[-CredentialName] <String>
[-Credential] <PSCredential>
[-Uri] <Uri>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzureRmDataLakeAnalyticsCatalogCredential
[-Account] <String>
[-DatabaseName] <String>
[-CredentialName] <String>
[-Credential] <PSCredential>
[-DatabaseHost] <String>
[-Port] <Int32>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-AzureRmDataLakeAnalyticsCatalogCredential cmdlet creates a new credential to use in an Azure Data Lake Analytics catalog for connecting to external data sources.
Examples
Example 1: Create a credential for a catalog specifying host and port
PS C:\> New-AzureRmDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdlAccount" `
-DatabaseName "databaseName" `
-CredentialName "exampleDbCred" `
-Credential (Get-Credential) `
-DatabaseHost "example.contoso.com" -Port 8080This command creates the specified credential for the specified account, database, host and port using https protocol.
Example 2: Create a credential for a catalog specifying full URI
PS C:\> New-AzureRmDataLakeAnalyticsCatalogCredential -AccountName "ContosoAdlAccount" `
-DatabaseName "databaseName" `
-CredentialName "exampleDbCred" `
-Credential (Get-Credential) `
-Uri "http://httpExample.contoso.com:8080"This command creates the specified credential for the specified account, database and external data source URI.
Parameters
-Account
Specifies the Data Lake Analytics account name.
| Type: | String |
| Aliases: | AccountName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies the user name and corresponding password of the credential.
| Type: | PSCredential |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CredentialName
Specifies the name and password of the credential.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DatabaseHost
Specifies the host name of the external data source the credential can connect to in the format mydatabase.contoso.com.
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DatabaseName
Specifies the name of the database in the Data Lake Analytics account that the credential will be stored in.
| 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 used to connect to the specified DatabaseHost using this credential.
| Type: | Int32 |
| Position: | 5 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Uri
Specifies the full Uniform Resource Identifier (URI) of the external data source this credential can connect to.
| Type: | Uri |
| Position: | 4 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |