Deployments - Create Or Update At Tenant Scope

Distribuisce le risorse nell'ambito del tenant.
È possibile specificare il modello e i parametri direttamente nella richiesta o collegarsi ai file JSON.

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

Parametri dell'URI

Name In Required Type Description
deploymentName
path True
  • string

Nome della distribuzione.

Regex pattern: ^[-\w\._\(\)]+$

api-version
query True
  • string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Name Required Type Description
location True
  • string

Percorso in cui archiviare i dati di distribuzione.

properties True

Proprietà di distribuzione.

tags
  • object

Tag di distribuzione

Risposte

Name Type Description
200 OK

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

201 Created

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

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

Create deployment at tenant scope.

Sample Request

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/tenant-dep01?api-version=2021-04-01

{
  "location": "eastus",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Sample Response

{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}
{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Definizioni

Alias

Tipo di alias.

AliasPath

Tipo dei percorsi per alias.

AliasPathAttributes

Attributi del token a cui fa riferimento il percorso alias.

AliasPathMetadata
AliasPathTokenType

Tipo di token a cui fa riferimento il percorso alias.

AliasPattern

Tipo del modello per un percorso alias.

AliasPatternType

Tipo di modello di 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.

DeploymentExtended

Informazioni sulla distribuzione.

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere Incremental o Complete. 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 involontariamente le risorse.

DeploymentProperties

Proprietà della distribuzione.

DeploymentPropertiesExtended

Proprietà di distribuzione con dettagli aggiuntivi.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorResponse

Risposta di errore

ExpressionEvaluationOptions

Specifica se le espressioni 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 in caso di comportamento degli errori.

OnErrorDeploymentExtended

Distribuzione sul comportamento degli errori con dettagli aggiuntivi.

OnErrorDeploymentType

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

Posizione estesa del provider.

ProviderResourceType

Tipo di risorsa gestito dal provider di risorse.

ProvisioningState

Indica lo stato del provisioning.

ResourceReference

Modello ID risorsa.

ScopedDeployment

Parametri dell'operazione di distribuzione.

TemplateLink

Entità che rappresenta il riferimento al modello.

ZoneMapping

Alias

Tipo di alias.

Name Type Description
defaultMetadata

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

defaultPath
  • string

Percorso predefinito per un alias.

defaultPattern

Modello predefinito per un alias.

name
  • string

Nome dell'alias.

paths

Percorsi di un alias.

type

Tipo dell'alias.

AliasPath

Tipo dei percorsi per alias.

Name Type Description
apiVersions
  • string[]

Versioni dell'API.

metadata

Metadati del percorso alias. Se mancante, eseguire il fallback ai metadati predefiniti dell'alias.

path
  • string

Percorso di un alias.

pattern

Modello per un percorso alias.

AliasPathAttributes

Attributi del token a cui fa riferimento il percorso alias.

Name Type Description
Modifiable
  • string

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

None
  • string

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

AliasPathMetadata

Name Type Description
attributes

Attributi del token a cui fa riferimento il percorso alias.

type

Tipo di token a cui fa riferimento il percorso alias.

AliasPathTokenType

Tipo di token a cui fa riferimento il percorso alias.

Name Type Description
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 è number.

Object
  • string

Il tipo di token è object.

String
  • string

Il tipo di token è string.

AliasPattern

Tipo del modello per un percorso alias.

Name Type Description
phrase
  • string

Frase del modello alias.

type

Tipo di modello di alias

variable
  • string

Variabile del pattern alias.

AliasPatternType

Tipo di modello di alias

Name Type Description
Extract
  • string

Extract è l'unico valore consentito.

NotSpecified
  • string

NotSpecified non è consentito.

AliasType

Tipo dell'alias.

Name Type Description
Mask
  • string

Il valore alias è secret.

NotSpecified
  • string

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

PlainText
  • string

Il valore alias non è segreto.

ApiProfile

Name Type Description
apiVersion
  • string

La versione delle API.

profileVersion
  • string

Versione del profilo.

BasicDependency

Informazioni sulle dipendenze della distribuzione.

Name Type Description
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.

Name Type Description
error

Risposta di errore
Risposta di errore comune per tutte le API Resource Manager di Azure per restituire i dettagli dell'errore per le operazioni non riuscite. Segue anche il formato di risposta di errore OData.

DebugSetting

Impostazione di debug.

Name Type Description
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.

Name Type Description
dependsOn

Elenco di dipendenze.

id
  • string

ID della dipendenza.

resourceName
  • string

Nome della risorsa di dipendenza.

resourceType
  • string

Tipo di risorsa di dipendenza.

DeploymentExtended

Informazioni sulla distribuzione.

Name Type Description
id
  • string

ID della distribuzione.

location
  • string

percorso della distribuzione.

name
  • string

Nome della distribuzione.

properties

Proprietà della distribuzione.

tags
  • object

Tag di distribuzione

type
  • string

Tipo della distribuzione.

DeploymentMode

Modalità usata per distribuire le risorse. Questo valore può essere Incremental o Complete. 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 involontariamente le risorse.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentProperties

Proprietà della distribuzione.

Name Type Description
debugSetting

Impostazione di debug della distribuzione.

expressionEvaluationOptions

Specifica se le espressioni 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

Modalità usata per distribuire le risorse. Questo valore può essere Incremental o Complete. 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 involontariamente le risorse.

onErrorDeployment

Distribuzione in caso di comportamento degli errori.

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 un JObject o una stringa JSON ben formata.

parametersLink

URI del file di parametri. Questo elemento viene usato per il collegamento a 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 ben formata o JObject. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe.

templateLink

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

DeploymentPropertiesExtended

Proprietà di distribuzione con dettagli aggiuntivi.

Name Type Description
correlationId
  • string

ID di correlazione della distribuzione.

debugSetting

Impostazione di debug della distribuzione.

dependencies

Elenco delle dipendenze della distribuzione.

duration
  • string

Durata della distribuzione del modello.

error

Risposta di errore
Errore di distribuzione.

mode

Modalità di distribuzione. I valori possibili sono Incremental e Complete.

onErrorDeployment

Distribuzione in caso di comportamento degli errori.

outputResources

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

URI che fa riferimento ai parametri.

providers

Elenco dei provider di risorse necessari per la distribuzione.

provisioningState

Indica lo stato del provisioning.

templateHash
  • string

Hash prodotto per il modello.

templateLink

URI che fa riferimento al modello.

timestamp
  • string

Timestamp della distribuzione del modello.

validatedResources

Matrice di risorse convalidate.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Name Type Description
info
  • object

Informazioni aggiuntive.

type
  • string

Tipo di informazioni aggiuntive.

ErrorResponse

Risposta di errore

Name Type Description
additionalInfo

Informazioni aggiuntive sull'errore.

code
  • string

Codice di errore.

details

Dettagli dell'errore.

message
  • string

Messaggio di errore.

target
  • string

Destinazione dell'errore.

ExpressionEvaluationOptions

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

Name Type Description
scope

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.

Name Type Description
Inner
  • string
NotSpecified
  • string
Outer
  • string

OnErrorDeployment

Distribuzione in caso di comportamento degli errori.

Name Type Description
deploymentName
  • string

Distribuzione da usare in caso di errore.

type

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

OnErrorDeploymentExtended

Distribuzione sul comportamento degli errori con dettagli aggiuntivi.

Name Type Description
deploymentName
  • string

Distribuzione da usare in caso di errore.

provisioningState
  • string

Stato del provisioning per la distribuzione degli errori.

type

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

OnErrorDeploymentType

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

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

Entità che rappresenta il riferimento ai parametri di distribuzione.

Name Type Description
contentVersion
  • string

Se incluso, deve corrispondere a ContentVersion nel modello.

uri
  • string

URI del file di parametri.

Provider

Informazioni sul provider di risorse.

Name Type Description
id
  • string

ID del provider.

namespace
  • string

Spazio dei nomi del provider di risorse.

providerAuthorizationConsentState

Stato di consenso dell'autorizzazione del provider.

registrationPolicy
  • string

Criteri di registrazione del provider di risorse.

registrationState
  • string

Stato di registrazione del provider di risorse.

resourceTypes

Raccolta di tipi di risorse del provider.

ProviderAuthorizationConsentState

Stato di consenso dell'autorizzazione del provider.

Name Type Description
Consented
  • string
NotRequired
  • string
NotSpecified
  • string
Required
  • string

ProviderExtendedLocation

Posizione estesa del provider.

Name Type Description
extendedLocations
  • string[]

Località estese per la località di Azure.

location
  • string

Località di Azure.

type
  • string

Tipo di posizione estesa.

ProviderResourceType

Tipo di risorsa gestito dal provider di risorse.

Name Type Description
aliases

Alias supportati da questo tipo di risorsa.

apiProfiles

Profili API per il provider di risorse.

apiVersions
  • string[]

La versione delle API.

capabilities
  • string

Funzionalità aggiuntive offerte da questo tipo di risorsa.

defaultApiVersion
  • string

Versione API predefinita.

locationMappings

Mapping dei percorsi supportati da questo tipo di risorsa.

locations
  • string[]

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

properties
  • object

Proprietà.

resourceType
  • string

Tipo di risorsa.

zoneMappings

ProvisioningState

Indica lo stato del provisioning.

Name Type Description
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.

Name Type Description
id
  • string

ID risorsa completo.

ScopedDeployment

Parametri dell'operazione di distribuzione.

Name Type Description
location
  • string

Percorso in cui archiviare i dati di distribuzione.

properties

Proprietà di distribuzione.

tags
  • object

Tag di distribuzione

Entità che rappresenta il riferimento al modello.

Name Type Description
contentVersion
  • string

Se incluso, deve corrispondere a ContentVersion nel modello.

id
  • string

ID risorsa di una specifica di 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 utilizzata per distribuire un modello collegato in una posizione relativa all'elemento padre. Se il modello padre è stato collegato a un oggetto TemplateSpec, questo farà 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 relativePath

uri
  • string

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

ZoneMapping

Name Type Description
location
  • string

Posizione del mapping della zona.

zones
  • string[]