Microsoft.GuestConfiguration guestConfigurationAssignments 2021-01-25

Definizione di risorsa Bicep

Il tipo di risorsa guestConfigurationAssignments è una risorsa di estensione , il che significa che è possibile applicarlo a un'altra risorsa.

Utilizzare la proprietà scope in questa risorsa per impostare l'ambito per questa risorsa. Vedere Impostare l'ambito sulle risorse di estensione in Bicep.

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

Formato risorsa

Per creare una risorsa Microsoft.GuestConfiguration/guestConfigurationAssignments, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25' = {
  name: 'string'
  location: 'string'
  scope: resourceSymbolicName
  properties: {
    context: 'string'
    guestConfiguration: {
      assignmentType: 'string'
      configurationParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationProtectedParameter: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      configurationSetting: {
        actionAfterReboot: 'string'
        allowModuleOverwrite: bool
        configurationMode: 'string'
        configurationModeFrequencyMins: int
        rebootIfNeeded: bool
        refreshFrequencyMins: int
      }
      contentHash: 'string'
      contentUri: 'string'
      kind: 'DSC'
      name: 'string'
      version: 'string'
    }
    latestAssignmentReport: {
      assignment: {
        configuration: {}
      }
      resources: [
        {
          reasons: [
            {
            }
          ]
        }
      ]
      vm: {}
    }
    vmssVMList: [
      {
      }
    ]
  }
}

Valori delle proprietà

guestConfigurationAssignments

Nome Descrizione Valore
nome Nome della risorsa stringa (obbligatorio)
ubicazione Area in cui si trova la macchina virtuale. corda
portata Usare quando si crea una risorsa di estensione in un ambito diverso dall'ambito di distribuzione. Risorsa di destinazione

Per Bicep, impostare questa proprietà sul nome simbolico della risorsa per applicare la risorsa di estensione .
proprietà Proprietà dell'assegnazione di configurazione guest. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nome Descrizione Valore
contesto Origine che ha avviato l'assegnazione di configurazione guest. Ad esempio: Criteri di Azure corda
guestConfiguration Configurazione guest da assegnare. GuestConfigurationNavigation
latestAssignmentReport Ultimo report sull'assegnazione della configurazione guest segnalata. AssignmentReport
vmssVMList Elenco dei dati di conformità delle macchine virtuali per il set di scalabilità di macchine virtuali VmssvmInfo[]

GuestConfigurationNavigation

Nome Descrizione Valore
assignmentType Specifica il tipo di assegnazione e l'esecuzione della configurazione. I valori possibili sono Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'Audit'
'DeployAndAutoCorrect'
configurationParameter Parametri di configurazione per la configurazione guest. ConfigurationParameter[]
configurationProtectedParameter Parametri di configurazione protetti per la configurazione guest. ConfigurationParameter[]
configurationSetting Impostazione di configurazione per la configurazione guest. ConfigurationSetting
contentHash Hash combinato del pacchetto di configurazione guest e dei parametri di configurazione. corda
contentUri URI della risorsa di archiviazione in cui viene caricato il pacchetto di configurazione guest. corda
gentile Tipo di configurazione guest. Ad esempio:DSC 'DSC'
nome Nome della configurazione guest. corda
Versione Versione della configurazione guest. corda

ConfigurationParameter

Nome Descrizione Valore
nome Nome del parametro di configurazione. corda
valore Valore del parametro di configurazione. corda

ConfigurationSetting

Nome Descrizione Valore
actionAfterReboot Specifica cosa accade dopo un riavvio durante l'applicazione di una configurazione. I valori possibili sono ContinueConfiguration e StopConfiguration 'ContinueConfiguration'
'StopConfiguration'
allowModuleOverwrite Se true: le nuove configurazioni scaricate dal servizio di pull possono sovrascrivere quelle precedenti nel nodo di destinazione. In caso contrario, false Bool
configurationMode Specifica in che modo Gestione configurazione locale applica effettivamente la configurazione ai nodi di destinazione. I valori possibili sono ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'ApplyOnly'
configurationModeFrequencyMins Con quale frequenza, in minuti, viene verificata e applicata la configurazione corrente. Questa proprietà viene ignorata se la proprietà ConfigurationMode è impostata su ApplyOnly. Il valore predefinito è 15. Int
rebootIfNeeded Impostare su true per riavviare automaticamente il nodo dopo l'applicazione di una configurazione che richiede il riavvio. In caso contrario, sarà necessario riavviare manualmente il nodo per qualsiasi configurazione che lo richiede. Il valore predefinito è false. Per usare questa impostazione quando viene applicato una condizione di riavvio da un elemento diverso da DSC (ad esempio Windows Installer), combinare questa impostazione con il modulo xPendingReboot. Bool
refreshFrequencyMins Intervallo di tempo, espresso in minuti, in cui Gestione configurazione locale controlla un servizio di pull per ottenere configurazioni aggiornate. Questo valore viene ignorato se Gestione configurazione locale non è configurata in modalità pull. Il valore predefinito è 30. Int

AssignmentReport

Nome Descrizione Valore
incarico Dettagli di configurazione dell'assegnazione della configurazione guest. AssignmentInfo
risorse Elenco di risorse per le quali viene verificata la conformità dell'assegnazione della configurazione guest. AssignmentReportResource[]
Vm Informazioni sulla macchina virtuale. VMInfo

AssignmentInfo

Nome Descrizione Valore
configurazione Informazioni sulla configurazione. ConfigurationInfo

ConfigurationInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

AssignmentReportResource

Nome Descrizione Valore
Motivi Motivo di conformità e codice motivo per una risorsa. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

VMInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

VmssvmInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma Descrizione
macchine virtuali IIS & vm di SQL Server 2014

Distribuire in Azure
Creare server Web Windows 2012 R2 IIS 1 o 2 e un back-end di SQL Server 2014 nella rete virtuale.
macchina virtuale Windows con di base sicura di Azure

Distribuire in Azure
Il modello crea una macchina virtuale che esegue Windows Server in una nuova rete virtuale, con un indirizzo IP pubblico. Dopo aver distribuito il computer, viene installata l'estensione di configurazione guest e viene applicata la baseline sicura di Azure per Windows Server. Se la configurazione dei computer deriva, è possibile riapplicare le impostazioni distribuendo di nuovo il modello.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa guestConfigurationAssignments è una risorsa di estensione , il che significa che è possibile applicarlo a un'altra risorsa.

Utilizzare la proprietà scope in questa risorsa per impostare l'ambito per questa risorsa. Vedere Impostare l'ambito sulle risorse di estensione nei modelli di Resource Manager.

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

Formato risorsa

Per creare una risorsa Microsoft.GuestConfiguration/guestConfigurationAssignments, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.GuestConfiguration/guestConfigurationAssignments",
  "apiVersion": "2021-01-25",
  "name": "string",
  "location": "string",
  "scope": "string",
  "properties": {
    "context": "string",
    "guestConfiguration": {
      "assignmentType": "string",
      "configurationParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationProtectedParameter": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "configurationSetting": {
        "actionAfterReboot": "string",
        "allowModuleOverwrite": "bool",
        "configurationMode": "string",
        "configurationModeFrequencyMins": "int",
        "rebootIfNeeded": "bool",
        "refreshFrequencyMins": "int"
      },
      "contentHash": "string",
      "contentUri": "string",
      "kind": "DSC",
      "name": "string",
      "version": "string"
    },
    "latestAssignmentReport": {
      "assignment": {
        "configuration": {}
      },
      "resources": [
        {
          "reasons": [
            {
            }
          ]
        }
      ],
      "vm": {}
    },
    "vmssVMList": [
      {
      }
    ]
  }
}

Valori delle proprietà

guestConfigurationAssignments

Nome Descrizione Valore
digitare Tipo di risorsa 'Microsoft.GuestConfiguration/guestConfigurationAssignments'
apiVersion Versione dell'API della risorsa '2021-01-25'
nome Nome della risorsa stringa (obbligatorio)
ubicazione Area in cui si trova la macchina virtuale. corda
portata Usare quando si crea una risorsa di estensione in un ambito diverso dall'ambito di distribuzione. Risorsa di destinazione

Per JSON, impostare il valore sul nome completo della risorsa per applicare la risorsa di estensione .
proprietà Proprietà dell'assegnazione di configurazione guest. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nome Descrizione Valore
contesto Origine che ha avviato l'assegnazione di configurazione guest. Ad esempio: Criteri di Azure corda
guestConfiguration Configurazione guest da assegnare. GuestConfigurationNavigation
latestAssignmentReport Ultimo report sull'assegnazione della configurazione guest segnalata. AssignmentReport
vmssVMList Elenco dei dati di conformità delle macchine virtuali per il set di scalabilità di macchine virtuali VmssvmInfo[]

GuestConfigurationNavigation

Nome Descrizione Valore
assignmentType Specifica il tipo di assegnazione e l'esecuzione della configurazione. I valori possibili sono Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'Audit'
'DeployAndAutoCorrect'
configurationParameter Parametri di configurazione per la configurazione guest. ConfigurationParameter[]
configurationProtectedParameter Parametri di configurazione protetti per la configurazione guest. ConfigurationParameter[]
configurationSetting Impostazione di configurazione per la configurazione guest. ConfigurationSetting
contentHash Hash combinato del pacchetto di configurazione guest e dei parametri di configurazione. corda
contentUri URI della risorsa di archiviazione in cui viene caricato il pacchetto di configurazione guest. corda
gentile Tipo di configurazione guest. Ad esempio:DSC 'DSC'
nome Nome della configurazione guest. corda
Versione Versione della configurazione guest. corda

ConfigurationParameter

Nome Descrizione Valore
nome Nome del parametro di configurazione. corda
valore Valore del parametro di configurazione. corda

ConfigurationSetting

Nome Descrizione Valore
actionAfterReboot Specifica cosa accade dopo un riavvio durante l'applicazione di una configurazione. I valori possibili sono ContinueConfiguration e StopConfiguration 'ContinueConfiguration'
'StopConfiguration'
allowModuleOverwrite Se true: le nuove configurazioni scaricate dal servizio di pull possono sovrascrivere quelle precedenti nel nodo di destinazione. In caso contrario, false Bool
configurationMode Specifica in che modo Gestione configurazione locale applica effettivamente la configurazione ai nodi di destinazione. I valori possibili sono ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. 'ApplyAndAutoCorrect'
'ApplyAndMonitor'
'ApplyOnly'
configurationModeFrequencyMins Con quale frequenza, in minuti, viene verificata e applicata la configurazione corrente. Questa proprietà viene ignorata se la proprietà ConfigurationMode è impostata su ApplyOnly. Il valore predefinito è 15. Int
rebootIfNeeded Impostare su true per riavviare automaticamente il nodo dopo l'applicazione di una configurazione che richiede il riavvio. In caso contrario, sarà necessario riavviare manualmente il nodo per qualsiasi configurazione che lo richiede. Il valore predefinito è false. Per usare questa impostazione quando viene applicato una condizione di riavvio da un elemento diverso da DSC (ad esempio Windows Installer), combinare questa impostazione con il modulo xPendingReboot. Bool
refreshFrequencyMins Intervallo di tempo, espresso in minuti, in cui Gestione configurazione locale controlla un servizio di pull per ottenere configurazioni aggiornate. Questo valore viene ignorato se Gestione configurazione locale non è configurata in modalità pull. Il valore predefinito è 30. Int

AssignmentReport

Nome Descrizione Valore
incarico Dettagli di configurazione dell'assegnazione della configurazione guest. AssignmentInfo
risorse Elenco di risorse per le quali viene verificata la conformità dell'assegnazione della configurazione guest. AssignmentReportResource[]
Vm Informazioni sulla macchina virtuale. VMInfo

AssignmentInfo

Nome Descrizione Valore
configurazione Informazioni sulla configurazione. ConfigurationInfo

ConfigurationInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

AssignmentReportResource

Nome Descrizione Valore
Motivi Motivo di conformità e codice motivo per una risorsa. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

VMInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

VmssvmInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma Descrizione
macchine virtuali IIS & vm di SQL Server 2014

Distribuire in Azure
Creare server Web Windows 2012 R2 IIS 1 o 2 e un back-end di SQL Server 2014 nella rete virtuale.
macchina virtuale Windows con di base sicura di Azure

Distribuire in Azure
Il modello crea una macchina virtuale che esegue Windows Server in una nuova rete virtuale, con un indirizzo IP pubblico. Dopo aver distribuito il computer, viene installata l'estensione di configurazione guest e viene applicata la baseline sicura di Azure per Windows Server. Se la configurazione dei computer deriva, è possibile riapplicare le impostazioni distribuendo di nuovo il modello.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa guestConfigurationAssignments è una risorsa di estensione , il che significa che è possibile applicarlo a un'altra risorsa.

Utilizzare la proprietà parent_id in questa risorsa per impostare l'ambito per questa risorsa.

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

Formato risorsa

Per creare una risorsa Microsoft.GuestConfiguration/guestConfigurationAssignments, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"
  name = "string"
  location = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      context = "string"
      guestConfiguration = {
        assignmentType = "string"
        configurationParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationProtectedParameter = [
          {
            name = "string"
            value = "string"
          }
        ]
        configurationSetting = {
          actionAfterReboot = "string"
          allowModuleOverwrite = bool
          configurationMode = "string"
          configurationModeFrequencyMins = int
          rebootIfNeeded = bool
          refreshFrequencyMins = int
        }
        contentHash = "string"
        contentUri = "string"
        kind = "DSC"
        name = "string"
        version = "string"
      }
      latestAssignmentReport = {
        assignment = {
          configuration = {}
        }
        resources = [
          {
            reasons = [
              {
              }
            ]
          }
        ]
        vm = {}
      }
      vmssVMList = [
        {
        }
      ]
    }
  })
}

Valori delle proprietà

guestConfigurationAssignments

Nome Descrizione Valore
digitare Tipo di risorsa "Microsoft.GuestConfiguration/guestConfigurationAssignments@2021-01-25"
nome Nome della risorsa stringa (obbligatorio)
ubicazione Area in cui si trova la macchina virtuale. corda
parent_id ID della risorsa a cui applicare la risorsa di estensione. stringa (obbligatorio)
proprietà Proprietà dell'assegnazione di configurazione guest. GuestConfigurationAssignmentProperties

GuestConfigurationAssignmentProperties

Nome Descrizione Valore
contesto Origine che ha avviato l'assegnazione di configurazione guest. Ad esempio: Criteri di Azure corda
guestConfiguration Configurazione guest da assegnare. GuestConfigurationNavigation
latestAssignmentReport Ultimo report sull'assegnazione della configurazione guest segnalata. AssignmentReport
vmssVMList Elenco dei dati di conformità delle macchine virtuali per il set di scalabilità di macchine virtuali VmssvmInfo[]

GuestConfigurationNavigation

Nome Descrizione Valore
assignmentType Specifica il tipo di assegnazione e l'esecuzione della configurazione. I valori possibili sono Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect e ApplyAndMonitor. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"Audit"
"DeployAndAutoCorrect"
configurationParameter Parametri di configurazione per la configurazione guest. ConfigurationParameter[]
configurationProtectedParameter Parametri di configurazione protetti per la configurazione guest. ConfigurationParameter[]
configurationSetting Impostazione di configurazione per la configurazione guest. ConfigurationSetting
contentHash Hash combinato del pacchetto di configurazione guest e dei parametri di configurazione. corda
contentUri URI della risorsa di archiviazione in cui viene caricato il pacchetto di configurazione guest. corda
gentile Tipo di configurazione guest. Ad esempio:DSC "DSC"
nome Nome della configurazione guest. corda
Versione Versione della configurazione guest. corda

ConfigurationParameter

Nome Descrizione Valore
nome Nome del parametro di configurazione. corda
valore Valore del parametro di configurazione. corda

ConfigurationSetting

Nome Descrizione Valore
actionAfterReboot Specifica cosa accade dopo un riavvio durante l'applicazione di una configurazione. I valori possibili sono ContinueConfiguration e StopConfiguration "ContinueConfiguration"
"StopConfiguration"
allowModuleOverwrite Se true: le nuove configurazioni scaricate dal servizio di pull possono sovrascrivere quelle precedenti nel nodo di destinazione. In caso contrario, false Bool
configurationMode Specifica in che modo Gestione configurazione locale applica effettivamente la configurazione ai nodi di destinazione. I valori possibili sono ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. "ApplyAndAutoCorrect"
"ApplyAndMonitor"
"ApplyOnly"
configurationModeFrequencyMins Con quale frequenza, in minuti, viene verificata e applicata la configurazione corrente. Questa proprietà viene ignorata se la proprietà ConfigurationMode è impostata su ApplyOnly. Il valore predefinito è 15. Int
rebootIfNeeded Impostare su true per riavviare automaticamente il nodo dopo l'applicazione di una configurazione che richiede il riavvio. In caso contrario, sarà necessario riavviare manualmente il nodo per qualsiasi configurazione che lo richiede. Il valore predefinito è false. Per usare questa impostazione quando viene applicato una condizione di riavvio da un elemento diverso da DSC (ad esempio Windows Installer), combinare questa impostazione con il modulo xPendingReboot. Bool
refreshFrequencyMins Intervallo di tempo, espresso in minuti, in cui Gestione configurazione locale controlla un servizio di pull per ottenere configurazioni aggiornate. Questo valore viene ignorato se Gestione configurazione locale non è configurata in modalità pull. Il valore predefinito è 30. Int

AssignmentReport

Nome Descrizione Valore
incarico Dettagli di configurazione dell'assegnazione della configurazione guest. AssignmentInfo
risorse Elenco di risorse per le quali viene verificata la conformità dell'assegnazione della configurazione guest. AssignmentReportResource[]
Vm Informazioni sulla macchina virtuale. VMInfo

AssignmentInfo

Nome Descrizione Valore
configurazione Informazioni sulla configurazione. ConfigurationInfo

ConfigurationInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

AssignmentReportResource

Nome Descrizione Valore
Motivi Motivo di conformità e codice motivo per una risorsa. AssignmentReportResourceComplianceReason[]

AssignmentReportResourceComplianceReason

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

VMInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

VmssvmInfo

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.