Set-AzureRmVMDscExtension
Настраивает расширение DSC на виртуальной машине.
Предупреждение
Модуль AzureRM PowerShell официально объявлен устаревшим с 29 февраля 2024 г. Пользователям рекомендуется выполнить миграцию из AzureRM в модуль Az PowerShell, чтобы обеспечить постоянную поддержку и обновления.
Хотя модуль AzureRM по-прежнему может функционировать, он больше не поддерживается или не поддерживается, размещая любое постоянное использование на усмотрение и риск пользователя. Ознакомьтесь с нашими ресурсами миграции, чтобы получить рекомендации по переходу в модуль Az.
Синтаксис
Set-AzureRmVMDscExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-ArchiveBlobName] <String>
[-ArchiveStorageAccountName] <String>
[-ArchiveResourceGroupName <String>]
[-ArchiveStorageEndpointSuffix <String>]
[-ArchiveContainerName <String>]
[-ConfigurationName <String>]
[-ConfigurationArgument <Hashtable>]
[-ConfigurationData <String>]
[-Version] <String>
[-Force]
[-Location <String>]
[-AutoUpdate]
[-WmfVersion <String>]
[-DataCollection <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Описание
Командлет Set-AzureRmVMDscExtension настраивает расширение Windows PowerShell Desired State Configuration (DSC) на виртуальной машине в группе ресурсов.
Примеры
Пример 1. Установка расширения DSC
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US"
Эта команда задает расширение DSC на виртуальной машине с именем VM07, чтобы скачать Sample.ps1.zip из учетной записи хранения с именем Stg и контейнером по умолчанию. Команда вызывает конфигурацию с именем ConfigName. Файл Sample.ps1.zip ранее был отправлен с помощью Publish-AzureRmVMDscConfiguration.
Пример 2. Настройка расширения DSC с данными конфигурации
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US"
Эта команда задает расширение виртуальной машины с именем VM13, чтобы скачать Sample.ps1.zip из учетной записи хранения с именем Stg и контейнера с именем WindowsPowerShellDSC. Команда с именем ConfigName и указывает данные конфигурации и аргументы. Файл Sample.ps1.zip ранее был отправлен с помощью Publish-AzureRmVMDscConfiguration.
Пример 3. Настройка расширения DSC с данными конфигурации с автоматическим обновлением
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdate
Эта команда задает расширение виртуальной машины с именем VM22, чтобы скачать Sample.ps1.zip из учетной записи хранения с именем Stg и контейнера с именем WindowsPowerShellDSC. Команда вызывает конфигурацию с именем ConfigName и задает данные конфигурации и аргументы. Эта команда также включает автоматическое обновление обработчика расширений до последней версии. Ранее Sample.ps1.zip был отправлен с помощью Publish-AzureRmVMDscConfiguration.
Параметры
-ArchiveBlobName
Указывает имя файла конфигурации, который ранее был отправлен командлетом Publish-AzureRmVMDscConfiguration.
Тип: | String |
Aliases: | ConfigurationArchiveBlob |
Position: | 5 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ArchiveContainerName
Имя вида контейнера хранилища Azure, где находится архив конфигурации.
Тип: | String |
Aliases: | ContainerName |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ArchiveResourceGroupName
Указывает имя группы ресурсов, содержащей учетную запись хранения, содержащую архив конфигурации. Этот параметр необязателен, если учетная запись хранения и виртуальная машина находятся в одной группе ресурсов.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ArchiveStorageAccountName
Указывает имя учетной записи хранения Azure, которая используется для скачивания ArchiveBlobName.
Тип: | String |
Aliases: | StorageAccountName |
Position: | 4 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ArchiveStorageEndpointSuffix
Указывает суффикс конечной точки хранилища.
Тип: | String |
Aliases: | StorageEndpointSuffix |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-AutoUpdate
Указывает версию обработчика расширений, указанную параметром Version . По умолчанию обработчик расширений не выполняется автоматически. Используйте параметр autoUpdate, чтобы включить автоматическое обновление обработчика расширений до последней версии, как и когда оно доступно.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ConfigurationArgument
Указывает хэш-таблицу, содержащую аргументы функции конфигурации.
Тип: | Hashtable |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ConfigurationData
Указывает путь к PSD1-файлу, который указывает данные для конфигурации.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ConfigurationName
Указывает имя конфигурации, вызываемой расширением DSC.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Confirm
Запрос подтверждения перед выполнением командлета.
Тип: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DataCollection
Указывает тип сбора данных. Допустимые значения для этого параметра: включение и отключение.
Тип: | String |
Допустимые значения: | Enable, Disable |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-DefaultProfile
Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.
Тип: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Force
Принудительное выполнение команды без запроса на подтверждение пользователем.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Location
Указывает путь расширения ресурса.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Name
Указывает имя ресурса Azure Resource Manager, представляющего расширение. Значением по умолчанию является Microsoft.Powershell.DSC.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ResourceGroupName
Указывает имя группы ресурсов виртуальной машины.
Тип: | String |
Position: | 2 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Version
Указывает версию расширения DSC, к которому применяется set-AzureRmVMDscExtension.
Тип: | String |
Aliases: | HandlerVersion |
Position: | 1 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-VMName
Указывает имя виртуальной машины, в которой установлен обработчик расширения DSC.
Тип: | String |
Position: | 3 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
Тип: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-WmfVersion
Указывает версию WMF.
Тип: | String |
Допустимые значения: | 4.0, 5.0, 5.1, latest |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |