Get-AzTenantDeploymentWhatIfResult

Módulo:

Az.Resources

Obtiene un resultado what-if de plantilla para una implementación en el ámbito del inquilino.

Sintaxis

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterObject <Hashtable>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateFile <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateParameterUri <String>
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateObject <Hashtable>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateUri <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzTenantDeploymentWhatIfResult
   [-Name <String>]
   -Location <String>
   [-ResultFormat <WhatIfResultFormat>]
   [-ExcludeChangeType <String[]>]
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

El cmdlet Get-AzTenantDeploymentWhatIfResult obtiene el resultado What-If de la plantilla de ARM para una implementación de plantilla en el ámbito de inquilino especificado. Devuelve una lista de cambios que indican qué recursos se actualizarán si la implementación se aplica sin realizar ningún cambio en los recursos reales. Para especificar el formato del resultado devuelto, use el parámetro ResultFormat .

Ejemplos

Ejemplo 1: Obtención de un resultado what-if en el ámbito del inquilino

Get-AzTenantDeploymentWhatIfResult `
    -DeploymentName "deploy-01" `
    -Location "West US" `
    -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
    -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
    -ResultFormat "FullResourcePayloads"

Este comando obtiene un resultado what-if en el ámbito del inquilino mediante un archivo de plantilla personalizado y un archivo de parámetros en el disco. El comando usa el parámetro Location para especificar dónde almacenar los datos de implementación. El comando usa el parámetro TemplateFile para especificar un archivo de plantilla. El comando usa el parámetro TemplateParameterFile para especificar un archivo de parámetros de plantilla. El comando usa el parámetro ResultFormat para establecer el resultado What-If para incluir cargas completas de recursos.

Ejemplo 2: Obtención de un resultado what-If en el ámbito del inquilino con ResourceIdOnly

Get-AzTenantDeploymentWhatIfResult `
    -DeploymentName "deploy-01" `
    -Location "West US" `
    -TemplateFile "D:\Azure\Templates\ServiceTemplate.json" `
    -TemplateParameterFile "D:\Azure\Templates\ServiceParameters.json" `
    -ResultFormat "ResourceIdOnly"

Este comando obtiene un resultado what-if en el ámbito del inquilino mediante un archivo de plantilla personalizado y un archivo de parámetros en el disco. El comando usa el parámetro Location para especificar dónde almacenar los datos de implementación. El comando usa el parámetro TemplateFile para especificar un archivo de plantilla. El comando usa el parámetro TemplateParameterFile para especificar un archivo de parámetros de plantilla. El comando usa el parámetro ResultFormat para establecer el resultado What-If para que solo contenga identificadores de recursos.

Ejemplo 3: Usar un archivo .bicepparam para calcular what-if

Get-AzTenantDeploymentWhatIfResult -Location "West US" -TemplateParameterFile "./parameters.bicepparam"

Este comando obtiene un resultado What-If en el ámbito del inquilino actual mediante un archivo .bicepparam en el disco. El comando usa el parámetro TemplateParameterFile para especificar un archivo .bicepparam.

Parámetros

-DefaultProfile

Credenciales, cuenta, inquilino y suscripción usados para la comunicación con Azure.

Tipo:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-ExcludeChangeType

Lista separada por comas de tipos de cambio de recursos que se excluirán de los resultados what-if.

Tipo:	String[]
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Location

Ubicación para almacenar los datos de implementación.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Name

Nombre de la implementación que va a crear. Si no se especifica, el valor predeterminado es el nombre de archivo de plantilla cuando se proporciona un archivo de plantilla; el valor predeterminado es la hora actual en que se proporciona un objeto de plantilla, por ejemplo, "20131223140835".

Tipo:	String
Alias:	DeploymentName
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-Pre

Cuando se establece, indica que el cmdlet debe usar versiones de API de versión preliminar al determinar automáticamente qué versión se va a usar.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-ResultFormat

Formato de resultado What-If.

Tipo:	WhatIfResultFormat
Valores aceptados:	ResourceIdOnly, FullResourcePayloads
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-SkipTemplateParameterPrompt

Omite el procesamiento de parámetros dinámicos de PowerShell que comprueba si el parámetro de plantilla proporcionado contiene todos los parámetros necesarios usados por la plantilla. Esta comprobación solicitaría al usuario que proporcione un valor para los parámetros que faltan, pero si se proporciona -SkipTemplateParameterPrompt, se omitirá este mensaje y se producirá un error inmediatamente si se encontró que un parámetro no está enlazado en la plantilla. En el caso de los scripts no interactivos, se puede proporcionar -SkipTemplateParameterPrompt para proporcionar un mejor mensaje de error en caso de que no se cumplan todos los parámetros necesarios.

Tipo:	SwitchParameter
Posición:	Named
Valor predeterminado:	None
Requerido:	False
Aceptar entrada de canalización:	False
Aceptar caracteres comodín:	False

-TemplateFile

Ruta de acceso local al archivo de plantilla. Tipo de archivo de plantilla admitido: json y bicep.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-TemplateObject

Tabla hash que representa la plantilla.

Tipo:	Hashtable
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-TemplateParameterFile

Archivo de parámetros que se va a usar para la plantilla.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-TemplateParameterObject

Tabla hash que representa los parámetros.

Tipo:	Hashtable
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-TemplateParameterUri

Uri al archivo de parámetros de plantilla.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-TemplateSpecId

Identificador de recurso de templateSpec que se va a implementar.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

-TemplateUri

Uri al archivo de plantilla.

Tipo:	String
Posición:	Named
Valor predeterminado:	None
Requerido:	True
Aceptar entrada de canalización:	True
Aceptar caracteres comodín:	False

Entradas

String

Hashtable

Salidas

PSWhatIfOperationResult