AzurePowerShell@4: tarea Azure PowerShell v4
Use esta tarea para ejecutar un script de PowerShell dentro de un entorno de Azure. El contexto de Azure se autentica con la conexión de servicio de Azure Resource Manager proporcionada.
Syntax
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
inputs:
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription.
#ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
#RestrictContextToCurrentTask: false # boolean. Restrict scope of context to current task. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
# Advanced
#pwsh: false # boolean. Use PowerShell Core. Default: false.
#validateScriptSignature: false # boolean. Optional. Use when ScriptType = FilePath. Validate script signature. Default: false.
#workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
inputs:
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription.
#ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
#RestrictContextToCurrentTask: false # boolean. Restrict scope of context to current task. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
# Advanced
#pwsh: false # boolean. Use PowerShell Core. Default: false.
#workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
inputs:
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription.
#ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
# Advanced
#pwsh: false # boolean. Use PowerShell Core. Default: false.
#workingDirectory: # string. Working Directory.
# Azure PowerShell v4
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@4
inputs:
azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription.
#ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
#ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path.
#Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script.
#ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments.
#errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
#FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
# Azure PowerShell version options
#azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version.
Entradas
azureSubscription
- Suscripción de Azure
Alias de entrada: ConnectedServiceNameARM
. string
. Obligatorio.
La suscripción de Azure Resource Manager que se va a configurar antes de ejecutar PowerShell.
ScriptType
- Tipo de script
string
. Valores permitidos: FilePath
(Ruta de acceso del archivo de script), InlineScript
(Script en línea). Valor predeterminado: FilePath
.
Tipo del script: ruta de acceso del archivo o insertada.
ScriptPath
- Ruta de acceso del script
string
. Opcional. Use cuando ScriptType = FilePath
.
Ruta de acceso del script. Debe ser una ruta de acceso completa o una relativa al directorio de trabajo predeterminado.
Inline
- Script insertado
string
. Opcional. Use cuando ScriptType = InlineScript
. Valor predeterminado: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments
.
Especifica el script que se va a ejecutar. La longitud máxima de script insertada admitida es de 5000 caracteres. Use un script de un archivo si desea usar un script más largo.
ScriptArguments
- Argumentos de script
string
. Opcional. Use cuando ScriptType = FilePath
.
Parámetros adicionales que se van a pasar a PowerShell. Puede ser ordinal o parámetros con nombre.
errorActionPreference
- ErrorActionPreference
string
. Valores permitidos: stop
, continue
y silentlyContinue
. Valor predeterminado: stop
.
Selecciona el valor de la ErrorActionPreference
variable para ejecutar el script.
FailOnStandardError
- Error en el error estándar
boolean
. Valor predeterminado: false
.
Cuando esto es true, se producirá un error en esta tarea si se escriben errores en la canalización de errores o si se escriben datos en la secuencia de errores estándar.
RestrictContextToCurrentTask
- Restricción del ámbito del contexto a la tarea actual
boolean
. Valor predeterminado: false
.
Cuando esto es true, esta tarea restringirá el ámbito de contexto solo a la tarea actual y el contexto no estará disponible para otras tareas de la canalización al usar un agente privado.
azurePowerShellVersion
- versión de Azure PowerShell
Alias de entrada: TargetAzurePs
. string
. Valores permitidos: LatestVersion
(versión instalada más reciente), OtherVersion
(Especifique otra versión). Valor predeterminado: OtherVersion
.
En el caso de los agentes hospedados, la versión de Azure PowerShell admitida es: 1.0.0
(cola de VS2017 hospedada).
Para elegir la versión más reciente disponible en el agente, seleccione LatestVersion
(Versión instalada más reciente).
En el caso de los agentes privados, puede especificar una versión preferida de Azure PowerShell mediante OtherVersion
(Especificar otra versión).
preferredAzurePowerShellVersion
- Versión de Azure PowerShell preferida
Alias de entrada: CustomTargetAzurePs
. string
. Necesario cuando TargetAzurePs = OtherVersion
.
La versión de Azure PowerShell preferida debe ser una versión semántica adecuada, por ejemplo. 1.2.3.
Regex como 2.\*,2.3.\*
no se admite. El grupo de VS2017 hospedado actualmente admite la versión del módulo Az. 1.0.0.
pwsh
- Uso de PowerShell Core
boolean
. Valor predeterminado: false
.
Si esto es true, en Windows, la tarea usará pwsh.exe
desde la ruta de acceso en lugar de powershell.exe
.
validateScriptSignature
- Validación de la firma del script
boolean
. Opcional. Use cuando ScriptType = FilePath
. Valor predeterminado: false
.
Si esto es true, la tarea comprobará primero para asegurarse de que el script especificado está firmado y válido antes de ejecutarlo.
workingDirectory
- Directorio de trabajo
string
.
Directorio de trabajo donde se ejecuta el script.
Opciones de control de tareas
Todas las tareas tienen opciones de control además de las entradas de tareas. Para obtener más información, vea Opciones de control y propiedades de tareas comunes.
Variables de salida
Ninguno.
Comentarios
Se ha agregado compatibilidad con Az Module y agentes multiplataforma.
Requisitos
Requisito | Descripción |
---|---|
Tipos de canalización | YAML, compilación clásica, versión clásica |
Se ejecuta en | Agente, DeploymentGroup |
Peticiones | None |
Capabilities | Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo. |
Restricciones de comandos | Any |
Variables que se pueden establecer | Any |
Versión del agente | 2.115.0 o superior |
Categoría de la tarea: | Implementación |