Condividi tramite


Deployments - Create Or Update At Subscription Scope

Distribuisce le risorse nell'ambito della sottoscrizione.
È possibile fornire il modello e i parametri direttamente nella richiesta o nel collegamento ai file JSON.

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
deploymentName
path True

string

Nome della distribuzione.

Criterio di espressione regolare: ^[-\w\._\(\)]+$

subscriptionId
path True

string

ID sottoscrizione di Microsoft Azure.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties True

DeploymentProperties

Proprietà di distribuzione.

location

string

Percorso per archiviare i dati di distribuzione.

tags

object

Tag di distribuzione

Risposte

Nome Tipo Descrizione
200 OK

DeploymentExtended

OK: restituisce informazioni sulla distribuzione, incluso lo stato di provisioning.

201 Created

DeploymentExtended

Creato: restituisce informazioni sulla distribuzione, incluso lo stato del provisioning.

Other Status Codes

CloudError

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Create a deployment that will deploy a templateSpec with the given resourceId

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-04-01

{
  "location": "eastus",
  "properties": {
    "templateLink": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}

Risposta di esempio

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "templateLink": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
      "contentVersion": "1.0.0.0"
    },
    "templateHash": "0000000000000000000",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Succeeded",
    "timestamp": "2020-06-05T01:51:58.6288067Z",
    "duration": "PT1.2637681S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [],
    "dependencies": [],
    "outputResources": []
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "templateLink": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
      "contentVersion": "1.0.0.0"
    },
    "templateHash": "0000000000000000000",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2020-06-05T01:51:58.6288067Z",
    "duration": "PT1.2637681S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [],
    "dependencies": []
  }
}

Definizioni

Nome Descrizione
Alias

Tipo di alias.

AliasPath

Tipo dei percorsi per alias.

AliasPathAttributes

Attributi del token a cui fa riferimento il percorso alias.

AliasPathMetadata
AliasPathTokenType

Tipo del token a cui fa riferimento il percorso alias.

AliasPattern

Tipo del modello per un percorso alias.

AliasPatternType

Tipo di modello alias

AliasType

Tipo dell'alias.

ApiProfile
BasicDependency

Informazioni sulle dipendenze della distribuzione.

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

DebugSetting

Impostazione di debug.

Dependency

Informazioni sulle dipendenze della distribuzione.

Deployment

Parametri dell'operazione di distribuzione.

DeploymentExtended

Informazioni sulla distribuzione.

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere incrementale o completo. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità completa perché è possibile eliminare in modo involontario le risorse.

DeploymentProperties

Proprietà della distribuzione.

DeploymentPropertiesExtended

Proprietà di distribuzione con dettagli aggiuntivi.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

ErrorResponse

Risposta di errore

ExpressionEvaluationOptions

Specifica se le espressioni di modello vengono valutate nell'ambito del modello padre o del modello annidato.

ExpressionEvaluationOptionsScopeType

Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.

OnErrorDeployment

Distribuzione sul comportamento degli errori.

OnErrorDeploymentExtended

Distribuzione sul comportamento degli errori con dettagli aggiuntivi.

OnErrorDeploymentType

La distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

ParametersLink

Entità che rappresenta il riferimento ai parametri di distribuzione.

Provider

Informazioni sul provider di risorse.

ProviderAuthorizationConsentState

Stato di consenso dell'autorizzazione del provider.

ProviderExtendedLocation

Percorso esteso del provider.

ProviderResourceType

Tipo di risorsa gestito dal provider di risorse.

ProvisioningState

Indica lo stato del provisioning.

ResourceReference

Modello ID risorsa.

TemplateLink

Entità che rappresenta il riferimento al modello.

ZoneMapping

Alias

Tipo di alias.

Nome Tipo Descrizione
defaultMetadata

AliasPathMetadata

Metadati predefiniti del percorso alias. Si applica al percorso predefinito e a qualsiasi percorso alias che non dispone di metadati

defaultPath

string

Percorso predefinito per un alias.

defaultPattern

AliasPattern

Modello predefinito per un alias.

name

string

Nome alias.

paths

AliasPath[]

Percorsi per un alias.

type

AliasType

Tipo dell'alias.

AliasPath

Tipo dei percorsi per alias.

Nome Tipo Descrizione
apiVersions

string[]

Versioni dell'API.

metadata

AliasPathMetadata

Metadati del percorso alias. Se mancante, tornare ai metadati predefiniti dell'alias.

path

string

Percorso di un alias.

pattern

AliasPattern

Modello per un percorso alias.

AliasPathAttributes

Attributi del token a cui fa riferimento il percorso alias.

Nome Tipo Descrizione
Modifiable

string

Il token a cui fa riferimento il percorso alias è modificabile dai criteri con effetto "modifica".

None

string

Il token a cui fa riferimento il percorso alias non ha attributi.

AliasPathMetadata

Nome Tipo Descrizione
attributes

AliasPathAttributes

Attributi del token a cui fa riferimento il percorso alias.

type

AliasPathTokenType

Tipo del token a cui fa riferimento il percorso alias.

AliasPathTokenType

Tipo del token a cui fa riferimento il percorso alias.

Nome Tipo Descrizione
Any

string

Il tipo di token può essere qualsiasi elemento.

Array

string

Il tipo di token è matrice.

Boolean

string

Il tipo di token è booleano.

Integer

string

Il tipo di token è integer.

NotSpecified

string

Il tipo di token non è specificato.

Number

string

Il tipo di token è numero.

Object

string

Il tipo di token è oggetto.

String

string

Il tipo di token è stringa.

AliasPattern

Tipo del modello per un percorso alias.

Nome Tipo Descrizione
phrase

string

Frase del modello alias.

type

AliasPatternType

Tipo di modello alias

variable

string

Variabile del modello alias.

AliasPatternType

Tipo di modello alias

Nome Tipo Descrizione
Extract

string

L'estrazione è l'unico valore consentito.

NotSpecified

string

NotSpecified non è consentito.

AliasType

Tipo dell'alias.

Nome Tipo Descrizione
Mask

string

Il valore dell'alias è segreto.

NotSpecified

string

Il tipo di alias è sconosciuto (come non specificare il tipo di alias).

PlainText

string

Il valore dell'alias non è segreto.

ApiProfile

Nome Tipo Descrizione
apiVersion

string

La versione delle API.

profileVersion

string

Versione del profilo.

BasicDependency

Informazioni sulle dipendenze della distribuzione.

Nome Tipo Descrizione
id

string

ID della dipendenza.

resourceName

string

Nome della risorsa di dipendenza.

resourceType

string

Tipo di risorsa di dipendenza.

CloudError

Risposta di errore per una richiesta di gestione delle risorse.

Nome Tipo Descrizione
error

ErrorResponse

Risposta di errore
Risposta di errore comune per tutte le API di Resource Manager di Azure per restituire i dettagli degli errori per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

DebugSetting

Impostazione di debug.

Nome Tipo Descrizione
detailLevel

string

Specifica il tipo di informazioni da registrare per il debug. I valori consentiti sono none, requestContent, responseContent o requestContent e responseContent separati da una virgola. Il valore predefinito è none. Quando si imposta questo valore, considerare attentamente il tipo di informazioni passate durante la distribuzione. La registrazione di informazioni sulla richiesta o sulla risposta può esporre dati riservati, che vengono recuperati tramite le operazioni di distribuzione.

Dependency

Informazioni sulle dipendenze della distribuzione.

Nome Tipo Descrizione
dependsOn

BasicDependency[]

Elenco di dipendenze.

id

string

ID della dipendenza.

resourceName

string

Nome della risorsa di dipendenza.

resourceType

string

Tipo di risorsa di dipendenza.

Deployment

Parametri dell'operazione di distribuzione.

Nome Tipo Descrizione
location

string

Percorso per archiviare i dati di distribuzione.

properties

DeploymentProperties

Proprietà di distribuzione.

tags

object

Tag di distribuzione

DeploymentExtended

Informazioni sulla distribuzione.

Nome Tipo Descrizione
id

string

ID della distribuzione.

location

string

posizione della distribuzione.

name

string

Nome della distribuzione.

properties

DeploymentPropertiesExtended

Proprietà della distribuzione.

tags

object

Tag di distribuzione

type

string

Tipo della distribuzione.

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere incrementale o completo. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità completa perché è possibile eliminare in modo involontario le risorse.

Nome Tipo Descrizione
Complete

string

Incremental

string

DeploymentProperties

Proprietà della distribuzione.

Nome Tipo Descrizione
debugSetting

DebugSetting

Impostazione di debug della distribuzione.

expressionEvaluationOptions

ExpressionEvaluationOptions

Specifica se le espressioni di modello vengono valutate nell'ambito del modello padre o del modello annidato. Applicabile solo ai modelli annidati. Se non specificato, il valore predefinito è esterno.

mode

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere incrementale o completo. Nella modalità incrementale, le risorse vengono distribuite senza eliminare le risorse esistenti non incluse nel modello. In modalità completa le risorse vengono distribuite e le risorse esistenti nel gruppo di risorse non incluse nel modello vengono eliminate. Prestare attenzione quando si usa la modalità completa perché è possibile eliminare in modo involontario le risorse.

onErrorDeployment

OnErrorDeployment

La distribuzione sul comportamento dell'errore.

parameters

object

Coppie nome e valore che definiscono i parametri di distribuzione per il modello. Questo elemento viene usato quando si desidera specificare i valori dei parametri direttamente nella richiesta anziché collegarsi a un file di parametri esistente. Usare la proprietà parametersLink o la proprietà parameters, ma non entrambe. Può essere una stringa JSON ben formata o JObject.

parametersLink

ParametersLink

URI del file di parametri. Usare questo elemento per collegare un file di parametri esistente. Usare la proprietà parametersLink o la proprietà parameters, ma non entrambe.

template

object

Contenuto del modello. Questo elemento viene usato quando si vuole passare la sintassi del modello direttamente nella richiesta anziché collegarsi a un modello esistente. Può essere una stringa JSON con formato JObject o ben formato. Usare la proprietà templateLink o la proprietà modello, ma non entrambi.

templateLink

TemplateLink

URI del modello. Usare la proprietà templateLink o la proprietà modello, ma non entrambi.

DeploymentPropertiesExtended

Proprietà di distribuzione con dettagli aggiuntivi.

Nome Tipo Descrizione
correlationId

string

ID di correlazione della distribuzione.

debugSetting

DebugSetting

Impostazione di debug della distribuzione.

dependencies

Dependency[]

Elenco delle dipendenze di distribuzione.

duration

string

Durata della distribuzione del modello.

error

ErrorResponse

Risposta di errore
Errore di distribuzione.

mode

DeploymentMode

Modalità di distribuzione. I valori possibili sono incrementali e completi.

onErrorDeployment

OnErrorDeploymentExtended

La distribuzione sul comportamento dell'errore.

outputResources

ResourceReference[]

Matrice di risorse di cui è stato effettuato il provisioning.

outputs

object

Coppie chiave/valore che rappresentano l'output della distribuzione.

parameters

object

Parametri di distribuzione.

parametersLink

ParametersLink

URI che fa riferimento ai parametri.

providers

Provider[]

Elenco dei provider di risorse necessari per la distribuzione.

provisioningState

ProvisioningState

Indica lo stato del provisioning.

templateHash

string

Hash prodotto per il modello.

templateLink

TemplateLink

URI che fa riferimento al modello.

timestamp

string

Timestamp della distribuzione del modello.

validatedResources

ResourceReference[]

Matrice di risorse convalidate.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorResponse[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ExpressionEvaluationOptions

Specifica se le espressioni di modello vengono valutate nell'ambito del modello padre o del modello annidato.

Nome Tipo Descrizione
scope

ExpressionEvaluationOptionsScopeType

Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.

ExpressionEvaluationOptionsScopeType

Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato.

Nome Tipo Descrizione
Inner

string

NotSpecified

string

Outer

string

OnErrorDeployment

Distribuzione sul comportamento degli errori.

Nome Tipo Descrizione
deploymentName

string

Distribuzione da usare in caso di errore.

type

OnErrorDeploymentType

La distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

OnErrorDeploymentExtended

Distribuzione sul comportamento degli errori con dettagli aggiuntivi.

Nome Tipo Descrizione
deploymentName

string

Distribuzione da usare in caso di errore.

provisioningState

string

Stato del provisioning per la distribuzione degli errori.

type

OnErrorDeploymentType

La distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

OnErrorDeploymentType

La distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment.

Nome Tipo Descrizione
LastSuccessful

string

SpecificDeployment

string

Entità che rappresenta il riferimento ai parametri di distribuzione.

Nome Tipo Descrizione
contentVersion

string

Se incluso, deve corrispondere a ContentVersion nel modello.

uri

string

URI del file di parametri.

Provider

Informazioni sul provider di risorse.

Nome Tipo Descrizione
id

string

ID del provider.

namespace

string

Spazio dei nomi del provider di risorse.

providerAuthorizationConsentState

ProviderAuthorizationConsentState

Stato di consenso dell'autorizzazione del provider.

registrationPolicy

string

Criterio di registrazione del provider di risorse.

registrationState

string

Stato di registrazione del provider di risorse.

resourceTypes

ProviderResourceType[]

Raccolta di tipi di risorse del provider.

ProviderAuthorizationConsentState

Stato di consenso dell'autorizzazione del provider.

Nome Tipo Descrizione
Consented

string

NotRequired

string

NotSpecified

string

Required

string

ProviderExtendedLocation

Percorso esteso del provider.

Nome Tipo Descrizione
extendedLocations

string[]

Posizioni estese per la posizione di Azure.

location

string

Posizione di Azure.

type

string

Tipo di percorso esteso.

ProviderResourceType

Tipo di risorsa gestito dal provider di risorse.

Nome Tipo Descrizione
aliases

Alias[]

Alias supportati da questo tipo di risorsa.

apiProfiles

ApiProfile[]

Profili API per il provider di risorse.

apiVersions

string[]

La versione delle API.

capabilities

string

Le funzionalità aggiuntive offerte da questo tipo di risorsa.

defaultApiVersion

string

Versione dell'API predefinita.

locationMappings

ProviderExtendedLocation[]

Mapping dei percorsi supportati da questo tipo di risorsa.

locations

string[]

Raccolta di posizioni in cui è possibile creare questo tipo di risorsa.

properties

object

Proprietà.

resourceType

string

Tipo di risorsa.

zoneMappings

ZoneMapping[]

ProvisioningState

Indica lo stato del provisioning.

Nome Tipo Descrizione
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

NotSpecified

string

Ready

string

Running

string

Succeeded

string

Updating

string

ResourceReference

Modello ID risorsa.

Nome Tipo Descrizione
id

string

ID risorsa completo.

Entità che rappresenta il riferimento al modello.

Nome Tipo Descrizione
contentVersion

string

Se incluso, deve corrispondere a ContentVersion nel modello.

id

string

ID risorsa di una specifica modello. Utilizzare la proprietà ID o URI, ma non entrambi.

queryString

string

Stringa di query (ad esempio, un token di firma di accesso condiviso) da usare con l'URI templateLink.

relativePath

string

La proprietà relativePath può essere usata per distribuire un modello collegato in una posizione relativa all'elemento padre. Se il modello padre è stato collegato a un modello TemplateSpec, verrà fatto riferimento a un artefatto in TemplateSpec. Se l'elemento padre è stato collegato a un URI, la distribuzione figlio sarà una combinazione degli URI padre e relativi

uri

string

URI del modello da distribuire. Usare l'URI o la proprietà ID, ma non entrambi.

ZoneMapping

Nome Tipo Descrizione
location

string

Posizione del mapping della zona.

zones

string[]