Condividi tramite

Deployments - Create Or Update

Servizio:
Resource Management
Versione API:
2025-04-01

Distribuisce le risorse in un gruppo di risorse.
È possibile specificare il modello e i parametri direttamente nella richiesta o nel collegamento ai file JSON.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
deploymentName
 path True

string

minLength: 1
maxLength: 64
pattern: ^[-\w\._\(\)]+$

Nome della distribuzione.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._\(\)]+$

Nome del gruppo di risorse in cui distribuire le risorse. Il nome è insensibile alle maiuscole e minuscole. Il gruppo di risorse deve già esistere.
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.
identity

DeploymentIdentity

Configurazione dell'identità gestita per una distribuzione.
location

string

Percorso in cui 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 del provisioning.
201 Created

DeploymentExtended

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

CloudError

Risposta di errore che descrive il motivo per cui 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 template with a uri and queryString
Create a deployment that will deploy a templateSpec with the given resourceId
Create a deployment that will redeploy another deployment on failure
Create a deployment that will redeploy the last successful deployment on failure
Create deployment using external inputs

Create a deployment that will deploy a template with a uri and queryString

Esempio di richiesta

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

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "queryString": "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"
    },
    "parameters": {},
    "mode": "Incremental"
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "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:20:01.723776Z",
    "duration": "PT22.8356799S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Storage",
        "resourceTypes": [
          {
            "resourceType": "storageAccounts",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [],
    "outputResources": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
      }
    ]
  }
}
Codice di stato:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "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:20:01.723776Z",
    "duration": "PT22.8356799S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Storage",
        "resourceTypes": [
          {
            "resourceType": "storageAccounts",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": []
  }
}

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/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2025-04-01

{
  "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

Codice di stato:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "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:20:01.723776Z",
    "duration": "PT22.8356799S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Storage",
        "resourceTypes": [
          {
            "resourceType": "storageAccounts",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [],
    "outputResources": [
      {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account"
      }
    ]
  }
}
Codice di stato:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "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:20:01.723776Z",
    "duration": "PT22.8356799S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Storage",
        "resourceTypes": [
          {
            "resourceType": "storageAccounts",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": []
  }
}

Create a deployment that will redeploy another deployment on failure

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2025-04-01

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Complete",
    "onErrorDeployment": {
      "type": "SpecificDeployment",
      "deploymentName": "name-of-deployment-to-use"
    }
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "contentVersion": "1.0.0.0"
    },
    "parameters": {},
    "mode": "Complete",
    "provisioningState": "Accepted",
    "timestamp": "2019-03-01T00:00:00.0000000Z",
    "duration": "PT0.8204881S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Network",
        "resourceTypes": [
          {
            "resourceType": "virtualNetworks",
            "locations": [
              "centralus"
            ]
          },
          {
            "resourceType": "virtualNetworks/subnets",
            "locations": [
              "centralus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet1"
      },
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          },
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks/subnets",
            "resourceName": "VNet1/Subnet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet2"
      }
    ],
    "onErrorDeployment": {
      "type": "SpecificDeployment",
      "deploymentName": "name-of-deployment-to-use"
    }
  }
}
Codice di stato:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "contentVersion": "1.0.0.0"
    },
    "parameters": {},
    "mode": "Complete",
    "provisioningState": "Accepted",
    "timestamp": "2019-03-01T00:00:00.0000000Z",
    "duration": "PT0.8204881S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Network",
        "resourceTypes": [
          {
            "resourceType": "virtualNetworks",
            "locations": [
              "centralus"
            ]
          },
          {
            "resourceType": "virtualNetworks/subnets",
            "locations": [
              "centralus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet1"
      },
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          },
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks/subnets",
            "resourceName": "VNet1/Subnet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet2"
      }
    ],
    "onErrorDeployment": {
      "type": "SpecificDeployment",
      "deploymentName": "name-of-deployment-to-use"
    }
  }
}

Create a deployment that will redeploy the last successful deployment on failure

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment?api-version=2025-04-01

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Complete",
    "onErrorDeployment": {
      "type": "LastSuccessful"
    }
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "contentVersion": "1.0.0.0"
    },
    "parameters": {},
    "mode": "Complete",
    "provisioningState": "Accepted",
    "timestamp": "2019-03-01T00:00:00.0000000Z",
    "duration": "PT0.8204881S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Network",
        "resourceTypes": [
          {
            "resourceType": "virtualNetworks",
            "locations": [
              "centralus"
            ]
          },
          {
            "resourceType": "virtualNetworks/subnets",
            "locations": [
              "centralus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet1"
      },
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          },
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks/subnets",
            "resourceName": "VNet1/Subnet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet2"
      }
    ],
    "onErrorDeployment": {
      "type": "LastSuccessful",
      "deploymentName": "{nameOfLastSuccesfulDeployment}"
    }
  }
}
Codice di stato:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json",
      "contentVersion": "1.0.0.0"
    },
    "parameters": {},
    "mode": "Complete",
    "provisioningState": "Accepted",
    "timestamp": "2019-03-01T00:00:00.0000000Z",
    "duration": "PT0.8204881S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Network",
        "resourceTypes": [
          {
            "resourceType": "virtualNetworks",
            "locations": [
              "centralus"
            ]
          },
          {
            "resourceType": "virtualNetworks/subnets",
            "locations": [
              "centralus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet1"
      },
      {
        "dependsOn": [
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks",
            "resourceName": "VNet1"
          },
          {
            "id": "{resourceid}",
            "resourceType": "Microsoft.Network/virtualNetworks/subnets",
            "resourceName": "VNet1/Subnet1"
          }
        ],
        "id": "{resourceid}",
        "resourceType": "Microsoft.Network/virtualNetworks/subnets",
        "resourceName": "VNet1/Subnet2"
      }
    ],
    "onErrorDeployment": {
      "type": "LastSuccessful",
      "deploymentName": "{nameOfLastSuccesfulDeployment}"
    }
  }
}

Create deployment using external inputs

Esempio di richiesta

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

{
  "properties": {
    "template": {
      "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "parameters": {
        "inputObj": {
          "type": "object"
        }
      },
      "resources": [],
      "outputs": {
        "inputObj": {
          "type": "object",
          "value": "[parameters('inputObj')]"
        }
      }
    },
    "parameters": {
      "inputObj": {
        "expression": "[createObject('foo', externalInputs('fooValue'))]"
      }
    },
    "externalInputDefinitions": {
      "fooValue": {
        "kind": "sys.envVar",
        "config": "FOO_VALUE"
      }
    },
    "externalInputs": {
      "fooValue": {
        "value": "baz"
      }
    },
    "mode": "Incremental"
  }
}

Risposta di esempio

Codice di stato:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateHash": "17686481789412793580",
    "parameters": {
      "inputObj": {
        "type": "Object",
        "value": {
          "foo": "baz"
        }
      }
    },
    "mode": "Incremental",
    "provisioningState": "Succeeded",
    "timestamp": "2025-04-09T14:36:48.2047169Z",
    "correlationId": "ef613b6c-f76e-48fd-9da7-28884243c5e5",
    "providers": [],
    "dependencies": [],
    "outputs": {
      "inputObj": {
        "type": "Object",
        "value": {
          "foo": "baz"
        }
      }
    },
    "outputResources": []
  }
}
Codice di stato:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment",
  "name": "my-deployment",
  "type": "Microsoft.Resources/deployments",
  "properties": {
    "templateHash": "17686481789412793580",
    "parameters": {
      "inputObj": {
        "type": "Object",
        "value": {
          "foo": "baz"
        }
      }
    },
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2025-04-09T14:36:47.6637583Z",
    "duration": "PT0.0009164S",
    "correlationId": "ef613b6c-f76e-48fd-9da7-28884243c5e5",
    "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 pattern 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.
DeploymentDiagnosticsDefinition
DeploymentExtended

Informazioni sulla distribuzione.
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentExternalInput

Input esterno di distribuzione per la parametrizzazione.
DeploymentExternalInputDefinition

Definizione dell'input esterno di distribuzione per la parametrizzazione.
DeploymentIdentity

Configurazione dell'identità gestita per una distribuzione.
DeploymentIdentityType

Tipo di identità.
DeploymentMode

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

Parametro di distribuzione per il modello.
DeploymentProperties

Proprietà di 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.
ExtensionConfigPropertyType
KeyVaultParameterReference

Informazioni di riferimento sul parametro di Azure Key Vault.
KeyVaultReference

Informazioni di riferimento su Azure Key Vault.
Level

Indica il livello di risposta aggiuntivo.
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.
TemplateLink

Entità che rappresenta il riferimento al modello.
UserAssignedIdentity

Proprietà di identità assegnate dall'utente
ValidationLevel

Livello di convalida eseguito nella distribuzione.
ZoneMapping

Alias

Object

Tipo di alias.

Nome Tipo Descrizione
defaultMetadata

AliasPathMetadata

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

AliasPattern

Modello predefinito per un alias.
name

string

Nome alias.
paths

AliasPath[]

Percorsi di un alias.
type

AliasType

Tipo dell'alias.

AliasPath

Object

Tipo dei percorsi per alias.

Nome Tipo Descrizione
apiVersions

string[]

Versioni dell'API.
metadata

AliasPathMetadata

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

string

Percorso di un alias.
pattern

AliasPattern

Modello per un percorso alias.

AliasPathAttributes

Enumerazione

Attributi del token a cui fa riferimento il percorso alias.

Valore Descrizione
None

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

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

AliasPathMetadata

Object
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

Enumerazione

Tipo del token a cui fa riferimento il percorso alias.

Valore Descrizione
NotSpecified

Il tipo di token non è specificato.
Any

Il tipo di token può essere qualsiasi elemento.
String

Il tipo di token è string.
Object

Il tipo di token è object.
Array

Il tipo di token è array.
Integer

Il tipo di token è integer.
Number

Il tipo di token è number.
Boolean

Il tipo di token è booleano.

AliasPattern

Object

Tipo del modello per un percorso alias.

Nome Tipo Descrizione
phrase

string

Frase del criterio alias.
type

AliasPatternType

Tipo di pattern alias
variable

string

Variabile del pattern alias.

AliasPatternType

Enumerazione

Tipo di pattern alias

Valore Descrizione
NotSpecified

NotSpecified non è consentito.
Extract

Extract è l'unico valore consentito.

AliasType

Enumerazione

Tipo dell'alias.

Valore Descrizione
NotSpecified

Il tipo di alias è sconosciuto (uguale a non fornire il tipo di alias).
PlainText

Il valore alias non è segreto.
Mask

Il valore alias è segreto.

ApiProfile

Object
Nome Tipo Descrizione
apiVersion

string

Versione dell'API.
profileVersion

string

Versione del profilo.

BasicDependency

Object

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

Object

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 Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

DebugSetting

Object

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 è nessuno. Quando si imposta questo valore, considerare attentamente il tipo di informazioni passate durante la distribuzione. Registrando informazioni sulla richiesta o sulla risposta, è possibile esporre dati sensibili recuperati tramite le operazioni di distribuzione.

Dependency

Object

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

Object

Parametri dell'operazione di distribuzione.

Nome Tipo Descrizione
identity

DeploymentIdentity

Configurazione dell'identità gestita per una distribuzione.
location

string

Percorso in cui archiviare i dati di distribuzione.
properties

DeploymentProperties

Proprietà di distribuzione.
tags

object

Tag di distribuzione

DeploymentDiagnosticsDefinition

Object
Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
level

Level

Indica il livello di risposta aggiuntivo.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

DeploymentExtended

Object

Informazioni sulla distribuzione.

Nome Tipo Descrizione
id

string

ID della distribuzione.
location

string

percorso della distribuzione.
name

string

Nome della distribuzione.
properties

DeploymentPropertiesExtended

Proprietà di distribuzione.
tags

object

Tag di distribuzione
type

string

Tipo di distribuzione.

DeploymentExtensionConfigItem

Object
Nome Tipo Descrizione
keyVaultReference

KeyVaultParameterReference

Riferimento di Azure Key Vault usato per recuperare il valore segreto della proprietà config dell'estensione.
type

ExtensionConfigPropertyType

Tipo di valore della proprietà di configurazione dell'estensione.
value

Valore della proprietà config dell'estensione.

DeploymentExtensionDefinition

Object
Nome Tipo Descrizione
alias

string

Alias dell'estensione come definito nel modello di distribuzione.
config

<string,  DeploymentExtensionConfigItem>

La configurazione dell'estensione.
configId

string

L'ID di configurazione dell'estensione. Identifica in modo univoco un piano di controllo della distribuzione all'interno di un'estensione.
name

string

Nome dell'estensione.
version

string

La versione dell'estensione.

DeploymentExternalInput

Object

Input esterno di distribuzione per la parametrizzazione.

Nome Tipo Descrizione
value

Valore di input esterno.

DeploymentExternalInputDefinition

Object

Definizione dell'input esterno di distribuzione per la parametrizzazione.

Nome Tipo Descrizione
config

Configurazione per l'ingresso esterno.
kind

string

Il tipo di input esterno.

DeploymentIdentity

Object

Configurazione dell'identità gestita per una distribuzione.

Nome Tipo Descrizione
type

DeploymentIdentityType

Tipo di identità.
userAssignedIdentities

<string,  UserAssignedIdentity>

Set di identità assegnate dall'utente associate alla risorsa.

DeploymentIdentityType

Enumerazione

Tipo di identità.

Valore Descrizione
None
UserAssigned

DeploymentMode

Enumerazione

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

Valore Descrizione
Incremental
Complete

DeploymentParameter

Object

Parametro di distribuzione per il modello.

Nome Tipo Descrizione
expression

string

Espressione di input per il parametro.
reference

KeyVaultParameterReference

Informazioni di riferimento sul parametro di Azure Key Vault.
value

Valore di input per il parametro .

DeploymentProperties

Object

Proprietà di distribuzione.

Nome Tipo Descrizione
debugSetting

DebugSetting

Impostazione di debug della distribuzione.
expressionEvaluationOptions

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.
extensionConfigs

object

Configurazioni da usare per le estensioni di distribuzione. Le chiavi di questo oggetto sono alias di estensione della distribuzione definiti nel modello di distribuzione.
externalInputDefinitions

<string,  DeploymentExternalInputDefinition>

Definizioni di input esterno, utilizzate dagli strumenti esterni per definire i valori di input esterni previsti.
externalInputs

<string,  DeploymentExternalInput>

Valori di input esterni, utilizzati dagli strumenti esterni per la valutazione dei parametri.
mode

DeploymentMode

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

OnErrorDeployment

Distribuzione in caso di comportamento dell'errore.
parameters

<string,  DeploymentParameter>

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. Utilizzare la proprietà parametersLink o la proprietà parameters, ma non entrambe. Può essere un JObject o una stringa JSON ben formata.
parametersLink

ParametersLink

URI del file di parametri. Questo elemento viene usato per collegarsi a un file di parametri esistente. Utilizzare 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ò trattarsi di una stringa JSON JObject o di formato corretto. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe.
templateLink

TemplateLink

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

ValidationLevel

Livello di convalida della distribuzione

DeploymentPropertiesExtended

Object

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.
diagnostics

DeploymentDiagnosticsDefinition[]

Contiene informazioni diagnostiche raccolte durante il processo di convalida.
duration

string

Durata della distribuzione del modello.
error

ErrorResponse

Risposta di errore
Errore di distribuzione.
extensions

DeploymentExtensionDefinition[]

Le estensioni utilizzate in questa distribuzione.
mode

DeploymentMode

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

OnErrorDeploymentExtended

Distribuzione in caso di 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 (date-time)

Timestamp della distribuzione del modello.
validatedResources

ResourceReference[]

Matrice di risorse convalidate.
validationLevel

ValidationLevel

Livello di convalida della distribuzione

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorResponse

Object

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

Object

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

Enumerazione

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

Valore Descrizione
NotSpecified
Outer
Inner

ExtensionConfigPropertyType

Enumerazione
Valore Descrizione
String

Tipo di proprietà che rappresenta un valore stringa.
Int

Tipo di proprietà che rappresenta un valore intero.
Bool

Tipo di proprietà che rappresenta un valore booleano.
Array

Tipo di proprietà che rappresenta un valore di matrice.
Object

Tipo di proprietà che rappresenta il valore di un oggetto.
SecureString

Tipo di proprietà che rappresenta un valore stringa sicuro.
SecureObject

Tipo di proprietà che rappresenta un valore di oggetto sicuro.

KeyVaultParameterReference

Object

Informazioni di riferimento sul parametro di Azure Key Vault.

Nome Tipo Descrizione
keyVault

KeyVaultReference

Informazioni di riferimento su Azure Key Vault.
secretName

string

Nome del segreto di Azure Key Vault.
secretVersion

string

Versione del segreto di Azure Key Vault.

KeyVaultReference

Object

Informazioni di riferimento su Azure Key Vault.

Nome Tipo Descrizione
id

string

ID risorsa di Azure Key Vault.

Level

Enumerazione

Indica il livello di risposta aggiuntivo.

Valore Descrizione
Warning
Info
Error

OnErrorDeployment

Object

Distribuzione in caso di comportamento degli errori.

Nome Tipo Descrizione
deploymentName

string

Distribuzione da usare in caso di errore.
type

OnErrorDeploymentType

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

OnErrorDeploymentExtended

Object

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

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

OnErrorDeploymentType

Enumerazione

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

Valore Descrizione
LastSuccessful
SpecificDeployment
Object

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

Object

Informazioni sul provider di risorse.

Nome Tipo Descrizione
id

string

ID provider.
namespace

string

Spazio dei nomi del provider di risorse.
providerAuthorizationConsentState

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

ProviderResourceType[]

Raccolta di tipi di risorse del provider.

ProviderAuthorizationConsentState

Enumerazione

Stato di consenso dell'autorizzazione del provider.

Valore Descrizione
NotSpecified
Required
NotRequired
Consented

ProviderExtendedLocation

Object

Posizione estesa del provider.

Nome Tipo Descrizione
extendedLocations

string[]

Località estese per la località di Azure.
location

string

Località di Azure.
type

string

Tipo di posizione estesa.

ProviderResourceType

Object

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[]

Versione dell'API.
capabilities

string

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

Enumerazione

Indica lo stato del provisioning.

Valore Descrizione
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

ResourceReference

Object

Modello id risorsa.

Nome Tipo Descrizione
apiVersion

string

La versione dell'API con cui è stata distribuita la risorsa.
extension

DeploymentExtensionDefinition

L'estensione con cui è stata distribuita la risorsa.
id

string

ID risorsa di Azure completo.
identifiers

object

Identificatori di risorse estendibili.
resourceType

string

Tipo di risorsa.
Object

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 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, verrà fatto riferimento a un artefatto in TemplateSpec. Se l'elemento padre è stato collegato con 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.

UserAssignedIdentity

Object

Proprietà di identità assegnate dall'utente

Nome Tipo Descrizione
clientId

string (uuid)

ID client dell'identità assegnata.
principalId

string (uuid)

ID entità dell'identità assegnata.

ValidationLevel

Enumerazione

Livello di convalida eseguito nella distribuzione.

Valore Descrizione
Template

Viene eseguita l'analisi statica del modello.
Provider

Viene eseguita l'analisi statica del modello e le dichiarazioni delle risorse vengono inviate ai provider di risorse per la convalida semantica. Verifica che il chiamante disponga delle autorizzazioni di scrittura RBAC per ogni risorsa.
ProviderNoRbac

Viene eseguita l'analisi statica del modello e le dichiarazioni delle risorse vengono inviate ai provider di risorse per la convalida semantica. Ignora la verifica che il chiamante disponga delle autorizzazioni di scrittura RBAC per ogni risorsa.

ZoneMapping

Object
Nome Tipo Descrizione
location

string

Posizione del mapping della zona.
zones

string[]