New-AzDeployment
Crie uma implantação no escopo da assinatura atual.
Sintaxe
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterObject <Hashtable>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterObject <Hashtable>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterObject <Hashtable>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterObject <Hashtable>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterFile <String>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterFile <String>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterFile <String>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterFile <String>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterUri <String>
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterUri <String>
-TemplateFile <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterUri <String>
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateParameterUri <String>
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateObject <Hashtable>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateUri <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzDeployment
[-Name <String>]
-Location <String>
[-DeploymentDebugLogLevel <String>]
[-Tag <Hashtable>]
[-WhatIfResultFormat <WhatIfResultFormat>]
[-WhatIfExcludeChangeType <String[]>]
[-ProceedIfNoChange]
[-AsJob]
[-QueryString <String>]
-TemplateSpecId <String>
[-SkipTemplateParameterPrompt]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet New-AzDeployment adiciona uma implantação no escopo da assinatura atual. Isso inclui os recursos que a implantação exige.
Um recurso do Azure é uma entidade do Azure gerenciada pelo usuário. Um recurso pode residir em um grupo de recursos, como servidor de banco de dados, banco de dados, site, máquina virtual ou conta de armazenamento. Ou pode ser um recurso de nível de assinatura, como definição de função, definição de política, etc.
Para adicionar recursos a um grupo de recursos, use o New-AzResourceGroupDeployment que cria uma implantação em um grupo de recursos. O cmdlet New-AzDeployment cria uma implantação no escopo da assinatura atual, que implanta recursos no nível da assinatura.
Para adicionar uma implantação na assinatura, especifique o local e um modelo. O local informa ao Azure Resource Manager onde armazenar os dados de implantação. O modelo é uma cadeia de caracteres JSON que contém recursos individuais a serem implantados. O modelo inclui espaços reservados de parâmetro para os recursos necessários e valores de propriedade configuráveis, como nomes e tamanhos.
Para usar um modelo personalizado para a implantação, especifique o parâmetro TemplateFile ou o parâmetro TemplateUri. Cada modelo tem parâmetros para propriedades configuráveis. Para especificar valores para os parâmetros de modelo, especifique o parâmetro TemplateParameterFile ou o parâmetro TemplateParameterObject . Como alternativa, você pode usar os parâmetros de modelo que são adicionados dinamicamente ao comando quando você especifica um modelo. Para usar parâmetros dinâmicos, digite-os no prompt de comando ou digite um sinal de menos (-) para indicar um parâmetro e use a tecla Tab para percorrer os parâmetros disponíveis. Os valores de parâmetro de modelo inseridos no prompt de comando têm precedência sobre os valores em um objeto ou arquivo de parâmetro de modelo.
Exemplos
Exemplo 1: Usar um modelo personalizado e um arquivo de parâmetro para criar uma implantação
New-AzDeployment -Location "West US" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json" -Tag @{"key1"="value1"; "key2"="value2";}
Esse comando cria uma nova implantação no escopo da assinatura atual usando um modelo personalizado e um arquivo de modelo no disco, com o parâmetro de marcas definidas. O comando usa o parâmetro TemplateFile para especificar o modelo e o parâmetro TemplateParameterFile para especificar um arquivo que contém parâmetros e valores de parâmetro.
Exemplo 2: Implantar um modelo armazenado em uma conta de armazenamento não pública usando um uri e um token SAS
New-AzDeployment -Location "West US" -TemplateUri "https://example.com/example.json" -QueryString "foo"
Esse comando cria uma nova implantação usando o modelo em TemplateUri que não é público e requer um parâmetro de token para acessar que seria fornecido usando o parâmetro QueryString.
A execução desse comando acessa efetivamente o modelo usando o url https://example.com/example.json?foo
.
Isso pode ser usado se você quiser usar um modelo em uma conta de armazenamento fornecendo o token SAS como o QueryString
Exemplo 3: Usar um objeto de modelo personalizado e um arquivo de parâmetro para criar uma implantação
$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\EngineeringSite.json")
$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable
New-AzDeployment -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\EngSiteParams.json"
Esse comando cria uma nova implantação no escopo da assinatura atual usando um modelo personalizado e um arquivo de modelo no disco que foi convertido em uma tabela de hash na memória. Os dois primeiros comandos leem o texto do arquivo de modelo no disco e o convertem em uma tabela de hash na memória. O último comando usa o parâmetro TemplateObject para especificar essa tabela de hash e o parâmetro TemplateParameterFile para especificar um arquivo que contém parâmetros e valores de parâmetro.
Exemplo 4: Usar um arquivo .bicepparam para criar uma implantação
New-AzDeployment -Location "West US" -TemplateParameterFile "./parameters.bicepparam"
Esse comando cria uma nova implantação no escopo da assinatura atual usando um arquivo .bicepparam no disco. O comando usa o parâmetro TemplateParameterFile para especificar um arquivo .bicepparam.
Parâmetros
-AsJob
Executar cmdlet em segundo plano
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.
Tipo: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-DeploymentDebugLogLevel
O nível de log de depuração de implantação.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Location
O local para armazenar dados de implantação.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Name
O nome da implantação que ele criará. Se não for especificado, o padrão será o nome do arquivo de modelo quando um arquivo de modelo for fornecido; O padrão é a hora atual em que um objeto de modelo é fornecido, por exemplo, "20131223140835".
Tipo: | String |
Aliases: | DeploymentName |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Pre
Quando definido, indica que o cmdlet deve usar versões de API de pré-lançamento ao determinar automaticamente qual versão usar.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ProceedIfNoChange
Não peça confirmação se não houver alterações no resultado hipotético. Aplicável quando o interruptor -Confirm está definido.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-QueryString
A cadeia de caracteres de consulta (por exemplo, um token SAS) a ser usada com o parâmetro TemplateUri. Seria usado no caso de modelos vinculados
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-SkipTemplateParameterPrompt
Ignora o processamento de parâmetro dinâmico do PowerShell que verifica se o parâmetro de modelo fornecido contém todos os parâmetros necessários usados pelo modelo. Essa verificação solicitaria que o usuário fornecesse um valor para os parâmetros ausentes, mas fornecer o -SkipTemplateParameterPrompt ignorará esse prompt e apresentará um erro imediatamente se um parâmetro não estiver associado ao modelo. Para scripts não interativos, -SkipTemplateParameterPrompt pode ser fornecido para fornecer uma mensagem de erro melhor no caso em que nem todos os parâmetros necessários são atendidos.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Tag
As tags a serem colocadas na implantação.
Tipo: | Hashtable |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-TemplateFile
Caminho local para o arquivo de modelo. Tipo de arquivo de modelo compatível: json e bicep.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-TemplateObject
Uma tabela de hash que representa o modelo.
Tipo: | Hashtable |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-TemplateParameterFile
Arquivo de parâmetro a ser usado para o modelo.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-TemplateParameterObject
Uma tabela de hash que representa os parâmetros.
Tipo: | Hashtable |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-TemplateParameterUri
Uri para o arquivo de parâmetro de modelo.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-TemplateSpecId
ID do recurso do templateSpec a ser implantado.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-TemplateUri
Uri para o arquivo de modelo.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-WhatIfExcludeChangeType
Tipos de alteração de recursos separados por vírgulas a serem excluídos dos resultados hipotéticos. Aplicável quando a chave -WhatIf ou -Confirm está definida.
Tipo: | String[] |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-WhatIfResultFormat
O formato do resultado hipotético.
Tipo: | WhatIfResultFormat |
Valores aceitos: | ResourceIdOnly, FullResourcePayloads |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |