Condividi tramite

Distribuzioni di Microsoft.Resources 2023-07-01

  • Articolo

Osservazioni

Per Bicep, è consigliabile usando moduli anziché questo tipo di risorsa.

Definizione di risorsa Bicep

Il tipo di risorsa delle distribuzioni può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Resources/deployments, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Resources/deployments@2023-07-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    expressionEvaluationOptions: {
      scope: 'string'
    }
    mode: 'string'
    onErrorDeployment: {
      deploymentName: 'string'
      type: 'string'
    }
    parameters: {
      {customized property}: {
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        value: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    }
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(Azure.Bicep.Types.Concrete.AnyType)
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

DebugSetting

Nome Descrizione Valore
detailLevel 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. corda

DeploymentParameter

Nome Descrizione Valore
riferimento Informazioni di riferimento sul parametro di Azure Key Vault. KeyVaultParameterReference
valore Valore di input per il parametro . qualunque

DeploymentPropertiesOrDeploymentPropertiesExtended

Nome Descrizione Valore
debugSetting Impostazione di debug della distribuzione. DebugSetting
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. ExpressionEvaluationOptions
modo 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. 'Complete'
'Incremental' (obbligatorio)
onErrorDeployment Distribuzione in caso di comportamento dell'errore. OnErrorDeploymentOrOnErrorDeploymentExtended
Parametri 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. DeploymentPropertiesParameters
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. ParametersLink
sagoma 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. qualunque
templateLink URI del modello. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe. TemplateLink

DeploymentPropertiesParameters

Nome Descrizione Valore

DeploymentTag

Nome Descrizione Valore

ExpressionEvaluationOptions

Nome Descrizione Valore
portata Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato. 'Interno'
'NotSpecified'
'Outer'

KeyVaultParameterReference

Nome Descrizione Valore
keyVault Informazioni di riferimento su Azure Key Vault. KeyVaultReference (obbligatorio)
secretName Nome del segreto di Azure Key Vault. stringa (obbligatorio)
secretVersion Versione del segreto di Azure Key Vault. corda

KeyVaultReference

Nome Descrizione Valore
Id ID risorsa di Azure Key Vault. stringa (obbligatorio)

Microsoft.Resources/deployments

Nome Descrizione Valore
ubicazione Percorso in cui archiviare i dati di distribuzione. corda
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[-\w\._\(\)]+$ (obbligatorio)
proprietà Proprietà di distribuzione. DeploymentPropertiesOrDeploymentPropertiesExtended (obbligatorio)
portata Usare quando si crea una risorsa in un ambito diverso dall'ambito di distribuzione. Impostare questa proprietà sul nome simbolico di una risorsa per applicare la risorsa di estensione .
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

OnErrorDeploymentOrOnErrorDeploymentExtended

Nome Descrizione Valore
deploymentName Distribuzione da usare in caso di errore. corda
digitare Distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nome Descrizione Valore
contentVersion Se incluso, deve corrispondere a ContentVersion nel modello. corda
Uri URI del file di parametri. stringa (obbligatorio)
Nome Descrizione Valore
contentVersion Se incluso, deve corrispondere a ContentVersion nel modello. corda
Id ID risorsa di una specifica di modello. Utilizzare la proprietà ID o URI, ma non entrambi. corda
queryString Stringa di query (ad esempio, un token di firma di accesso condiviso) da usare con l'URI templateLink. corda
relativePath 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 corda
Uri URI del modello da distribuire. Usare l'URI o la proprietà ID, ma non entrambi. corda

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa delle distribuzioni può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Resources/deployments, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2023-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "expressionEvaluationOptions": {
      "scope": "string"
    },
    "mode": "string",
    "onErrorDeployment": {
      "deploymentName": "string",
      "type": "string"
    },
    "parameters": {
      "{customized property}": {
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "value": {}
      }
    },
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

DebugSetting

Nome Descrizione Valore
detailLevel 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. corda

DeploymentParameter

Nome Descrizione Valore
riferimento Informazioni di riferimento sul parametro di Azure Key Vault. KeyVaultParameterReference
valore Valore di input per il parametro . qualunque

DeploymentPropertiesOrDeploymentPropertiesExtended

Nome Descrizione Valore
debugSetting Impostazione di debug della distribuzione. DebugSetting
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. ExpressionEvaluationOptions
modo 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. 'Complete'
'Incremental' (obbligatorio)
onErrorDeployment Distribuzione in caso di comportamento dell'errore. OnErrorDeploymentOrOnErrorDeploymentExtended
Parametri 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. DeploymentPropertiesParameters
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. ParametersLink
sagoma 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. qualunque
templateLink URI del modello. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe. TemplateLink

DeploymentPropertiesParameters

Nome Descrizione Valore

DeploymentTag

Nome Descrizione Valore

ExpressionEvaluationOptions

Nome Descrizione Valore
portata Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato. 'Interno'
'NotSpecified'
'Outer'

KeyVaultParameterReference

Nome Descrizione Valore
keyVault Informazioni di riferimento su Azure Key Vault. KeyVaultReference (obbligatorio)
secretName Nome del segreto di Azure Key Vault. stringa (obbligatorio)
secretVersion Versione del segreto di Azure Key Vault. corda

KeyVaultReference

Nome Descrizione Valore
Id ID risorsa di Azure Key Vault. stringa (obbligatorio)

Microsoft.Resources/deployments

Nome Descrizione Valore
apiVersion Versione dell'API '2023-07-01'
ubicazione Percorso in cui archiviare i dati di distribuzione. corda
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[-\w\._\(\)]+$ (obbligatorio)
proprietà Proprietà di distribuzione. DeploymentPropertiesOrDeploymentPropertiesExtended (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.Resources/deployments'

OnErrorDeploymentOrOnErrorDeploymentExtended

Nome Descrizione Valore
deploymentName Distribuzione da usare in caso di errore. corda
digitare Distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nome Descrizione Valore
contentVersion Se incluso, deve corrispondere a ContentVersion nel modello. corda
Uri URI del file di parametri. stringa (obbligatorio)
Nome Descrizione Valore
contentVersion Se incluso, deve corrispondere a ContentVersion nel modello. corda
Id ID risorsa di una specifica di modello. Utilizzare la proprietà ID o URI, ma non entrambi. corda
queryString Stringa di query (ad esempio, un token di firma di accesso condiviso) da usare con l'URI templateLink. corda
relativePath 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 corda
Uri URI del modello da distribuire. Usare l'URI o la proprietà ID, ma non entrambi. corda

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa delle distribuzioni può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Resources/deployments, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2023-07-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      expressionEvaluationOptions = {
        scope = "string"
      }
      mode = "string"
      onErrorDeployment = {
        deploymentName = "string"
        type = "string"
      }
      parameters = {
        {customized property} = {
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          value = ?
        }
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
    }
  })
}

Valori delle proprietà

DebugSetting

Nome Descrizione Valore
detailLevel 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. corda

DeploymentParameter

Nome Descrizione Valore
riferimento Informazioni di riferimento sul parametro di Azure Key Vault. KeyVaultParameterReference
valore Valore di input per il parametro . qualunque

DeploymentPropertiesOrDeploymentPropertiesExtended

Nome Descrizione Valore
debugSetting Impostazione di debug della distribuzione. DebugSetting
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. ExpressionEvaluationOptions
modo 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. 'Complete'
'Incremental' (obbligatorio)
onErrorDeployment Distribuzione in caso di comportamento dell'errore. OnErrorDeploymentOrOnErrorDeploymentExtended
Parametri 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. DeploymentPropertiesParameters
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. ParametersLink
sagoma 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. qualunque
templateLink URI del modello. Usare la proprietà templateLink o la proprietà del modello, ma non entrambe. TemplateLink

DeploymentPropertiesParameters

Nome Descrizione Valore

DeploymentTag

Nome Descrizione Valore

ExpressionEvaluationOptions

Nome Descrizione Valore
portata Ambito da usare per la valutazione di parametri, variabili e funzioni in un modello annidato. 'Interno'
'NotSpecified'
'Outer'

KeyVaultParameterReference

Nome Descrizione Valore
keyVault Informazioni di riferimento su Azure Key Vault. KeyVaultReference (obbligatorio)
secretName Nome del segreto di Azure Key Vault. stringa (obbligatorio)
secretVersion Versione del segreto di Azure Key Vault. corda

KeyVaultReference

Nome Descrizione Valore
Id ID risorsa di Azure Key Vault. stringa (obbligatorio)

Microsoft.Resources/deployments

Nome Descrizione Valore
ubicazione Percorso in cui archiviare i dati di distribuzione. corda
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[-\w\._\(\)]+$ (obbligatorio)
parent_id ID della risorsa a cui applicare la risorsa di estensione. stringa (obbligatorio)
proprietà Proprietà di distribuzione. DeploymentPropertiesOrDeploymentPropertiesExtended (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.Resources/deployments@2023-07-01"

OnErrorDeploymentOrOnErrorDeploymentExtended

Nome Descrizione Valore
deploymentName Distribuzione da usare in caso di errore. corda
digitare Distribuzione sul tipo di comportamento degli errori. I valori possibili sono LastSuccessful e SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Nome Descrizione Valore
contentVersion Se incluso, deve corrispondere a ContentVersion nel modello. corda
Uri URI del file di parametri. stringa (obbligatorio)
Nome Descrizione Valore
contentVersion Se incluso, deve corrispondere a ContentVersion nel modello. corda
Id ID risorsa di una specifica di modello. Utilizzare la proprietà ID o URI, ma non entrambi. corda
queryString Stringa di query (ad esempio, un token di firma di accesso condiviso) da usare con l'URI templateLink. corda
relativePath 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 corda
Uri URI del modello da distribuire. Usare l'URI o la proprietà ID, ma non entrambi. corda