Update-AzConfig

Обновления конфигурации Azure PowerShell.

Синтаксис

Update-AzConfig
      [-AppliesTo <String>]
      [-Scope <ConfigScope>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-CheckForUpgrade <Boolean>]
      [-DefaultSubscriptionForLogin <String>]
      [-DisableErrorRecordsPersistence <Boolean>]
      [-DisableInstanceDiscovery <Boolean>]
      [-DisplayBreakingChangeWarning <Boolean>]
      [-DisplayRegionIdentified <Boolean>]
      [-DisplaySurveyMessage <Boolean>]
      [-EnableDataCollection <Boolean>]
      [-EnableLoginByWam <Boolean>]
      [<CommonParameters>]

Описание

Обновления конфигурации Azure PowerShell. В зависимости от того, к какой конфигурации необходимо обновить, можно указать область, к которой хранится конфигурация, и к какой модуле или командлету он применяется.

Примечание.

Не рекомендуется обновлять конфигурации в нескольких процессах PowerShell. Либо выполните это в одном процессе, либо убедитесь, что обновления находятся на область процесса (-Scope Process), чтобы избежать непредвиденных побочных эффектов.

Примеры

Пример 1

Update-AzConfig -DefaultSubscriptionForLogin "Name of subscription"

Key                         Value                Applies To Scope       Help Message
---                         -----                ---------- -----       ------------
DefaultSubscriptionForLogin Name of subscription Az         CurrentUser Subscription name or GUID. Sets the default context for Azure PowerShell when lo…

Задает конфигурацию DefaultSubscriptionForLogin в качестве имени подписки. Если Connect-AzAccount указанная подписка будет выбрана в качестве подписки по умолчанию.

Пример 2

Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo "Az.KeyVault"

Key                          Value Applies To  Scope       Help Message
---                          ----- ----------  -----       ------------
DisplayBreakingChangeWarning False Az.KeyVault CurrentUser Controls if warning messages for breaking changes are displayed or suppressed. When enabled,…

Задает конфигурацию DisplayBreakingChangeWarnings как "$false" для модуля Az.KeyVault. Это предотвращает запрос всех предупреждающих сообщений о предстоящих критических изменениях в модуле Az.KeyVault.

Пример 3

Update-AzConfig -EnableDataCollection $true

Key                  Value Applies To Scope       Help Message
---                  ----- ---------- -----       ------------
EnableDataCollection True  Az         CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experi…

Задает конфигурацию EnableDataCollection как "$true". Это позволяет отправлять данные телеметрии. Установка этой конфигурации эквивалентна Enable-AzDataCollection и Disable-AzDataCollection.

Пример 4

Update-AzConfig -DisplaySecretsWarning $true

Key                   Value Applies To Scope       Help Message
---                   ----- ---------- -----       ------------
DisplaySecretsWarning True  Az         CurrentUser When enabled, a warning message for secrets redaction will be displ…

Задает конфигурацию DisplaySecretsWarning как "$true". Это позволяет обнаружить секреты во время выполнения командлета и отобразить предупреждение, если в выходных данных обнаружены какие-либо секреты.

Параметры

-AppliesTo

Указывает, к какой части Azure PowerShell применяется конфигурация. Возможны следующие значения:

  • Az: конфигурация применяется ко всем модулям и командлетам Azure PowerShell.
  • Имя модуля: конфигурация применяется к определенному модулю Azure PowerShell. Например, Az.служба хранилища.
  • Имя командлета: конфигурация применяется к определенному командлету Azure PowerShell. Например, Get-AzKeyVault. Если он не указан, при получении или очистке конфигураций по умолчанию используется для всех указанных выше значений; при обновлении значение по умолчанию — Az.
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CheckForUpgrade

При включении Azure PowerShell проверка для обновлений автоматически и отображает сообщение подсказки при доступности обновления. Значение по умолчанию — true.

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

-Confirm

Запрос подтверждения перед выполнением командлета.

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

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

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

-DefaultSubscriptionForLogin

Имя подписки или GUID. Задает контекст по умолчанию для Azure PowerShell при выполнении входа без указания подписки.

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

-DisableErrorRecordsPersistence

При отключении записи об ошибках не записываются в ~/. Azure/ErrorRecords. Эта конфигурация будет заменена параметром EnableErrorRecordsPersistence в следующем крупном выпуске Az около ноября 2023 года.

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

-DisableInstanceDiscovery

Установите для него значение true, чтобы отключить обнаружение экземпляров и проверку центра. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных не может быть достигнута, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров влечет за собой получение метаданных https://login.microsoft.com/ центра для проверки центра. Установив для этого значение true, проверка центра отключена. В результате важно убедиться, что настроенный узел центра является допустимым и надежным.

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

-DisplayBreakingChangeWarning

Определяет, отображаются ли или подавляются предупреждения о критических изменениях. При включении при выполнении командлетов с критическими изменениями в будущем выпуске отображается предупреждение о критическом изменении.

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

-DisplayRegionIdentified

При включении Azure PowerShell отображает рекомендации по регионам, которые могут снизить затраты.

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

-DisplaySecretsWarning

Если этот параметр включен, появится предупреждение, когда выходные данные командлета содержат секреты. Дополнительные сведения см. на странице https://go.microsoft.com/fwlink/?linkid=2258844.

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

-DisplaySurveyMessage

При включении вам предлагается редко участвовать в опросах взаимодействия с пользователями для Azure PowerShell.

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

-EnableDataCollection

При включении командлеты Azure PowerShell отправляют данные телеметрии в корпорацию Майкрософт, чтобы улучшить взаимодействие с клиентами. Дополнительные сведения см. в нашем заявлении о конфиденциальности: https://aka.ms/privacy

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

-EnableLoginByWam

[предварительная версия] При включении диспетчер веб-учетных записей (WAM) будет интерактивным интерфейсом входа по умолчанию. Он вернется к использованию браузера, если платформа не поддерживает WAM. Обратите внимание, что эта функция находится в предварительной версии. Учетная запись Майкрософт (MSA) в настоящее время не поддерживается. Вы можете обратиться к команде Azure PowerShell, если у вас есть отзывы: https://aka.ms/azpsissue

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

-Scope

Определяет область изменений конфигурации, например, применяются ли изменения только к текущему процессу или ко всем сеансам, запущенным этим пользователем. По умолчанию это CurrentUser.

Type:ConfigScope
Accepted values:CurrentUser, Process, Default, Environment
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

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

Входные данные

Boolean

String

Выходные данные

PSConfig