Publish-AzureRmVMDscConfiguration

DSC スクリプトを Azure BLOB ストレージにアップロードします。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Publish-AzureRmVMDscConfiguration
       [-ResourceGroupName] <String>
       [-ConfigurationPath] <String>
       [[-ContainerName] <String>]
       [-StorageAccountName] <String>
       [-StorageEndpointSuffix <String>]
       [-Force]
       [-SkipDependencyDetection]
       [-ConfigurationDataPath <String>]
       [-AdditionalPath <String[]>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Publish-AzureRmVMDscConfiguration
       [-ConfigurationPath] <String>
       [[-OutputArchivePath] <String>]
       [-Force]
       [-SkipDependencyDetection]
       [-ConfigurationDataPath <String>]
       [-AdditionalPath <String[]>]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

Publish-AzureRmVMDscConfiguration コマンドレットは、Desired State Configuration (DSC) スクリプトを Azure Blob Storage にアップロードします。これは後で Set-AzureRmVMDscExtension コマンドレットを使用して Azure 仮想マシンに適用できます。

例 1: .zip パッケージを作成して Azure Storage にアップロードする

PS C:\> Publish-AzureRmVMDscConfiguration ".\MyConfiguration.ps1"

このコマンドは、特定のスクリプトと依存リソース モジュールの.zip パッケージを作成し、Azure Storage にアップロードします。

例 2: .zip パッケージを作成し、ローカル ファイルに格納する

PS C:\> Publish-AzureRmVMDscConfiguration ".\MyConfiguration.ps1" -OutputArchivePath ".\MyConfiguration.ps1.zip"

このコマンドは、指定されたスクリプトと依存リソース モジュールの.zip パッケージを作成し、.\MyConfiguration.ps1.zip という名前のローカル ファイルに格納します。

例 3: アーカイブに構成を追加し、ストレージにアップロードする

PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -SkipDependencyDetection

このコマンドは、Sample.ps1 という名前の構成を構成アーカイブに追加して Azure Storage にアップロードし、依存リソース モジュールをスキップします。

例 4: 構成データと構成データをアーカイブに追加し、ストレージにアップロードする

PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -ConfigurationDataPath "C:\SampleData.psd1"

このコマンドは、Sample.ps1 という名前の構成と SampleData.psd1 という名前の構成データを構成アーカイブに追加して、Azure Storage にアップロードします。

例 5: 構成、構成データ、および追加のコンテンツをアーカイブに追加し、ストレージにアップロードする

PS C:\> Publish-AzureRmVMDscConfiguration -ConfigurationPath "C:\Sample.ps1" -AdditionalPath @("C:\ContentDir1", "C:\File.txt") -ConfigurationDataPath "C:\SampleData.psd1"

このコマンドは、Sample.ps1 という名前の構成、構成データ SampleData.psd1、および追加コンテンツを構成アーカイブに追加して、Azure Storage にアップロードします。

パラメーター

-AdditionalPath

構成アーカイブに含めるファイルまたはディレクトリのパスを指定します。 構成と共に仮想マシンにダウンロードされます。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationDataPath

構成のデータを指定する .psd1 ファイルのパスを指定します。 これは構成アーカイブに追加され、構成関数に渡されます。 Set-AzureRmVMDscExtension コマンドレットを使用して提供される構成データ パスによって上書きされます

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

-ConfigurationPath

1 つ以上の構成を含むファイルのパスを指定します。 ファイルには、Windows PowerShell スクリプト (.ps1) ファイルまたは Windows PowerShell モジュール (.psm1) ファイルを指定できます。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContainerName

構成のアップロード対象となる Azure ストレージ コンテナーの名前を指定します。

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

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

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputArchivePath

構成アーカイブを書き込むローカル .zip ファイルのパスを指定します。 このパラメーターを使用すると、構成スクリプトは Azure BLOB ストレージにアップロードされません。

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

-ResourceGroupName

ストレージ アカウントを含むリソース グループの名前を指定します。

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

-SkipDependencyDetection

このコマンドレットが構成アーカイブから DSC リソースの依存関係を除外することを示します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StorageAccountName

ContainerName パラメーターで指定されたコンテナーに構成スクリプトをアップロードするために使用する Azure ストレージ アカウント名を指定します。

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

-StorageEndpointSuffix

ストレージ エンドポイントのサフィックスを指定します。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

String

String[]

出力

String