New-AzDataFactoryEncryptValue
機密データを暗号化します。
構文
New-AzDataFactoryEncryptValue
[-DataFactoryName] <String>
[[-Value] <SecureString>]
[-GatewayName] <String>
[[-Credential] <PSCredential>]
[[-Type] <String>]
[[-NonCredentialValue] <String>]
[[-AuthenticationType] <String>]
[[-Server] <String>]
[[-Database] <String>]
[-ResourceGroupName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
New-AzDataFactoryEncryptValue
[-DataFactory] <PSDataFactory>
[[-Value] <SecureString>]
[-GatewayName] <String>
[[-Credential] <PSCredential>]
[[-Type] <String>]
[[-NonCredentialValue] <String>]
[[-AuthenticationType] <String>]
[[-Server] <String>]
[[-Database] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
New-AzDataFactoryEncryptValue コマンドレットは、パスワードや Microsoft SQL Server 接続文字列などの機密データを暗号化し、暗号化された値を返します。
例
例 1: ODBC 以外の接続文字列を暗号化する
$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catalog;user id =user123;password=******' -AsPlainText -Force
New-AzDataFactoryEncryptValue -GatewayName "WikiGateway" -DataFactoryName "WikiAdf" -Value $value -ResourceGroupName "ADF" -Type OnPremisesSqlLinkedService
最初のコマンドでは、ConvertTo-SecureString コマンドレットを使用して、指定した接続文字列を SecureString オブジェクトに変換し、そのオブジェクトを $Value 変数に格納します。
詳細を表示するには「Get-Help ConvertTo-SecureString
」を入力します。
使用できる値: SQL Server または Oracle 接続文字列。
2 番目のコマンドは、指定されたデータ ファクトリ、ゲートウェイ、リソース グループ、およびリンクされたサービスの種類の$Valueに格納されているオブジェクトの暗号化された値を作成します。
例 2: Windows 認証を使用する ODBC 以外の接続文字列を暗号化する。
$Value = ConvertTo-SecureString -String 'Data Source=ContosoServer;Initial Catalog=catalog;Integrated Security=True' -AsPlainText -Force
$Credential = Get-Credential
New-AzDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesSqlLinkedService
最初のコマンドでは、ConvertTo-SecureString を使用して指定した接続文字列をセキュリティで保護された文字列オブジェクトに変換し、そのオブジェクトを$Value変数に格納します。
2 番目のコマンドでは、Get-Credential コマンドレットを使用して Windows 認証 (ユーザー名とパスワード) を収集し、その PSCredential オブジェクトを$Credential変数に格納します。
詳細を表示するには「Get-Help Get-Credential
」を入力します。
3 番目のコマンドは、指定したデータ ファクトリ、ゲートウェイ、リソース グループ、およびリンクされたサービスの種類の$Valueと$Credentialに格納されているオブジェクトの暗号化された値を作成します。
例 3: ファイル システムのリンクされたサービスのサーバー名と資格情報を暗号化する
$Value = ConvertTo-SecureString "******" -AsPlainText -Force
$Credential = Get-Credential
New-AzDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesFileSystemLinkedService
最初のコマンドでは、 ConvertTo-SecureString を使用して指定した文字列をセキュリティで保護された文字列に変換し、そのオブジェクトを$Value変数に格納します。 2 番目のコマンドは、Get-Credential を使用してWindows 認証 (ユーザー名とパスワード) を収集し、そのPSCredential オブジェクトを$Credential変数に格納します。 3 番目のコマンドは、指定したデータ ファクトリ、ゲートウェイ、リソース グループ、およびリンクされたサービスの種類の$Valueと$Credentialに格納されているオブジェクトの暗号化された値を作成します。
例 4: HDFS のリンクされたサービスの資格情報を暗号化する
$UserName = ConvertTo-SecureString "******" -AsPlainText -Force
$Password = ConvertTo-SecureString "******" -AsPlainText -Force
$Credential = New-Object System.Management.Automation.PSCredential ($UserName, $Password)
New-AzDataFactoryEncryptValue -DataFactoryName "MyDataFactory" -ResourceGroupName "MyResourceGroup" -GatewayName "MyDataManagementGateway" -Type HdfsLinkedService -AuthenticationType Windows -Credential $Credential -NonCredentialValue "http://server01.com:50070/webhdfs/v1/user/username"
ConvertTo-SecureString コマンドは、指定した文字列をセキュリティで保護された文字列に変換します。 New-Object コマンドは、セキュリティで保護されたユーザー名とパスワード文字列を使用して PSCredential オブジェクトを作成します。 代わりに、Get-Credential コマンドを使用してWindows 認証 (ユーザー名とパスワード) を収集し、返されたPSCredential オブジェクトを前の例に示すように$credential変数に格納できます。 New-AzDataFactoryEncryptValue コマンドは、指定されたデータ ファクトリ、ゲートウェイ、リソース グループ、およびリンクされたサービスの種類の$Credentialに格納されているオブジェクトの暗号化された値を作成します。
例 5: ODBC のリンクされたサービスの資格情報を暗号化する
$Content = ConvertTo-SecureString "UID=username@contoso;PWD=******;" -AsPlainText -Force
New-AzDataFactoryEncryptValue -ResourceGroupName $RGName -DataFactoryName $DFName -GatewayName $Gateway -Type OnPremisesOdbcLinkedService -AuthenticationType Basic -NonCredentialValue "Driver={SQL Server};Server=server01.database.contoso.net; Database=HDISScenarioTest;" -Value $content
ConvertTo-SecureString コマンドは、指定した文字列をセキュリティで保護された文字列に変換します。 New-AzDataFactoryEncryptValue コマンドは、指定されたデータ ファクトリ、ゲートウェイ、リソース グループ、およびリンクされたサービスの種類の$Valueに格納されているオブジェクトの暗号化された値を作成します。
パラメーター
-AuthenticationType
データ ソースへの接続に使用する認証の種類を指定します。 このパラメーターの有効値は、次のとおりです。
- Windows
- 基本
- 匿名。
型: | String |
指定可能な値: | Windows, Basic, Anonymous |
配置: | 6 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Credential
使用するWindows 認証資格情報 (ユーザー名とパスワード) を指定します。 このコマンドレットは、ここで指定する資格情報データを暗号化します。
型: | PSCredential |
配置: | 3 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Database
リンクされたサービスのデータベース名を指定します。
型: | String |
配置: | 8 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DataFactory
PSDataFactory オブジェクトを指定します。 このコマンドレットは、このパラメーターが指定するデータ ファクトリのデータを暗号化します。
型: | PSDataFactory |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DataFactoryName
データ ファクトリの名前を指定します。 このコマンドレットは、このパラメーターが指定するデータ ファクトリのデータを暗号化します。
型: | String |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-GatewayName
ゲートウェイの名前を指定します。 このコマンドレットは、このパラメーターが指定するゲートウェイのデータを暗号化します。
型: | String |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-NonCredentialValue
Open Database Connectivity (ODBC) 接続文字列の資格情報以外の部分を指定します。 このパラメーターは、ODBC のリンクされたサービスにのみ適用されます。
型: | String |
配置: | 5 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
Azure リソース グループの名前を指定します。 このコマンドレットは、このパラメーターが指定するグループのデータを暗号化します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Server
リンクされたサービスのサーバー名を指定します。
型: | String |
配置: | 7 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Type
リンクされたサービスの種類を指定します。 このコマンドレットは、このパラメーターが指定するリンクされたサービスの種類のデータを暗号化します。 このパラメーターの有効値は、次のとおりです。
- OnPremisesSqlLinkedService
- OnPremisesFileSystemLinkedService
- OnPremisesOracleLinkedService
- OnPremisesOdbcLinkedService
- OnPremisesPostgreSqlLinkedService
- OnPremisesTeradataLinkedService
- OnPremisesMySQLLinkedService
- OnPremisesDB2LinkedService
- OnPremisesSybaseLinkedService
型: | String |
指定可能な値: | OnPremisesSqlLinkedService, OnPremisesFileSystemLinkedService, OnPremisesOracleLinkedService, OnPremisesOdbcLinkedService, OnPremisesPostgreSqlLinkedService, OnPremisesTeradataLinkedService, OnPremisesMySQLLinkedService, OnPremisesDB2LinkedService, OnPremisesSybaseLinkedService, HdfsLinkedService |
配置: | 4 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Value
暗号化する値を指定します。 オンプレミスの SQL Server のリンクされたサービスとオンプレミスの Oracle のリンクされたサービスの場合は、接続文字列を使用します。 オンプレミスの ODBC のリンクされたサービスの場合は、接続文字列の資格情報部分を使用します。 オンプレミスのファイル システムのリンクされたサービスの場合、ファイル システムがゲートウェイ コンピューターに対してローカルである場合は、Local または localhost を使用し、ファイル システムがゲートウェイ コンピューターとは異なるサーバー上にある場合は\\servername を使用します。
型: | SecureString |
配置: | 1 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
出力
メモ
- キーワード: azure, azurerm, arm, リソース, 管理, マネージャー, データ, ファクトリ
関連リンク
Azure PowerShell