New-AzManagementGroupDeployment

Creare una distribuzione in un gruppo di gestione

Sintassi

New-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <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-AzManagementGroupDeployment
   [-Name <String>]
   -ManagementGroupId <String>
   -Location <String>
   [-DeploymentDebugLogLevel <String>]
   [-Tag <Hashtable>]
   [-WhatIfResultFormat <WhatIfResultFormat>]
   [-WhatIfExcludeChangeType <String[]>]
   [-ProceedIfNoChange]
   [-AsJob]
   [-QueryString <String>]
   -TemplateSpecId <String>
   [-SkipTemplateParameterPrompt]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Descrizione

Il cmdlet New-AzManagementGroupDeployment aggiunge una distribuzione in un gruppo di gestione.

Per aggiungere una distribuzione in un gruppo di gestione, specificare il gruppo di gestione, il percorso e un modello. Il percorso indica ad Azure Resource Manager dove archiviare i dati di distribuzione. Il modello è una stringa JSON che contiene singole risorse da distribuire. Il modello include segnaposto dei parametri per le risorse necessarie e valori di proprietà configurabili, ad esempio nomi e dimensioni.

Per usare un modello personalizzato per la distribuzione, specificare il parametro TemplateFile o il parametro TemplateUri . Ogni modello ha parametri per le proprietà configurabili. Per specificare i valori per i parametri del modello, specificare il parametro TemplateParameterFile o il parametro TemplateParameterObject . In alternativa, è possibile usare i parametri del modello aggiunti dinamicamente al comando quando si specifica un modello. Per usare i parametri dinamici, digitarli al prompt dei comandi o digitare un segno meno (-) per indicare un parametro e usare il tasto TAB per scorrere i parametri disponibili. I valori dei parametri del modello immessi al prompt dei comandi hanno la precedenza sui valori in un oggetto parametro modello o in un file.

Per aggiungere risorse a un gruppo di risorse, usare New-AzResourceGroupDeployment che crea una distribuzione in un gruppo di risorse. Per aggiungere risorse a una sottoscrizione, usare New-AzSubscriptionDeployment che crea una distribuzione nell'ambito della sottoscrizione, che distribuisce le risorse a livello di sottoscrizione. Per aggiungere risorse nell'ambito del tenant, usare New-AzTenantDeployment che crea una distribuzione nell'ambito del tenant.

Esempio

Esempio 1: Usare un modello personalizzato e un file di parametri per creare una distribuzione

New-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateFile "D:\Azure\Templates\OrgSetup.json" -TemplateParameterFile "D:\Azure\Templates\OrgParms.json" -Tag @{"key1"="value1"; "key2"="value2";}

Questo comando crea una nuova distribuzione nel gruppo di gestione "myMG" usando un modello personalizzato e un file modello su disco, con il parametro tag definito. Il comando usa il parametro TemplateFile per specificare il modello e il parametro TemplateParameterFile per specificare un file che contiene parametri e valori di parametro.

Esempio 2: Distribuire un modello archiviato in un account di archiviazione non pubblico usando un URI e un token di firma di accesso condiviso

New-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateUri "https://example.com/example.json" -QueryString "foo"

Questo comando crea una nuova distribuzione usando il modello in TemplateUri che non è pubblico e richiede un parametro token per accedere a che verrebbe fornito usando il parametro QueryString. L'esecuzione di questo comando accede effettivamente al modello usando l'URL https://example.com/example.json?foo. Questa operazione può essere usata se si vuole usare un modello in un account di archiviazione specificando il token di firma di accesso condiviso come QueryString

Esempio 3: Usare un oggetto modello personalizzato e un file di parametri per creare una distribuzione

$TemplateFileText = [System.IO.File]::ReadAllText("D:\Azure\Templates\OrgSetup.json")
$TemplateObject = ConvertFrom-Json $TemplateFileText -AsHashtable
New-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateObject $TemplateObject -TemplateParameterFile "D:\Azure\Templates\OrgParams.json"

Questo comando crea una nuova distribuzione nel gruppo di gestione "myMG" usando un modello personalizzato e un file modello su disco convertito in una tabella hash in memoria. I primi due comandi leggono il testo per il file modello su disco e lo converte in una tabella hash in memoria. L'ultimo comando usa il parametro TemplateObject per specificare questa tabella hash e il parametro TemplateParameterFile per specificare un file che contiene parametri e valori di parametro.

Esempio 4: Usare un file bicepparam per creare una distribuzione

New-AzManagementGroupDeployment -ManagementGroupId "myMG" -Location "West US" -TemplateParameterFile "./parameters.bicepparam"

Questo comando crea una nuova distribuzione nell'ambito del gruppo di gestione usando un file bicepparam su disco. Il comando usa il parametro TemplateParameterFile per specificare un file con estensione bicepparam.

Parametri

-AsJob

Eseguire il cmdlet in background

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

-Confirm

Richiede conferma prima di eseguire il cmdlet.

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

-DefaultProfile

Le credenziali, l’account, il tenant e la sottoscrizione usati per comunicare con Azure.

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

-DeploymentDebugLogLevel

Livello del log di debug della distribuzione.

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

-Location

Percorso in cui archiviare i dati di distribuzione.

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

-ManagementGroupId

ID del gruppo di gestione.

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

-Name

Nome della distribuzione che verrà creato. Se non specificato, per impostazione predefinita viene impostato il nome del file modello quando viene fornito un file modello; il valore predefinito è l'ora corrente in cui viene fornito un oggetto modello, ad esempio "20131223140835".

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

-Pre

Se impostato, indica che il cmdlet deve usare versioni API non definitive quando si determina automaticamente quale versione usare.

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

-ProceedIfNoChange

Non chiedere conferma se non sono presenti modifiche nel risultato di simulazione. Applicabile quando è impostata l'opzione -Confirm.

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

-QueryString

Stringa di query (ad esempio, un token di firma di accesso condiviso) da usare con il parametro TemplateUri. Verrebbe usato in caso di modelli collegati

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

-SkipTemplateParameterPrompt

Ignora l'elaborazione dei parametri dinamici di PowerShell che controlla se il parametro del modello fornito contiene tutti i parametri necessari usati dal modello. Questo controllo richiede all'utente di specificare un valore per i parametri mancanti, ma specificando -SkipTemplateParameterPrompt ignorerà questa richiesta e genererà un errore immediatamente se non è stato trovato un parametro da associare nel modello. Per gli script non interattivi, è possibile specificare -SkipTemplateParameterPrompt per fornire un messaggio di errore migliore nel caso in cui non siano soddisfatti tutti i parametri obbligatori.

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

-Tag

Tag da inserire nella distribuzione.

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

-TemplateFile

Percorso locale del file modello. Tipo di file modello supportato: json e bicep.

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

-TemplateObject

Tabella hash che rappresenta il modello.

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

-TemplateParameterFile

File di parametri da usare per il modello.

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

-TemplateParameterObject

Tabella hash che rappresenta i parametri.

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

-TemplateParameterUri

URI al file di parametri del modello.

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

-TemplateSpecId

ID risorsa del modelloSpec da distribuire.

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

-TemplateUri

Uri del file modello.

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

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

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

-WhatIfExcludeChangeType

Tipi di modifica delle risorse delimitati da virgole da escludere dai risultati di simulazione. Applicabile quando è impostata l'opzione -WhatIf o -Confirm.

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

-WhatIfResultFormat

Formato dei risultati di simulazione. Applicabile quando è impostata l'opzione -WhatIf o -Confirm.

Type:WhatIfResultFormat
Accepted values:ResourceIdOnly, FullResourcePayloads
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Input

Hashtable

String

Output

PSDeployment