Condividi tramite


Microsoft. Sql servers/jobAgents/jobs/steps 2022-08-01-preview

Definizione della risorsa Bicep

Il tipo di risorsa servers/jobAgents/jobs/steps può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

Per creare un Microsoft. Risorse Sql/server/jobAgents/jobs/steps, aggiungi il seguente Bicep al tuo template.

resource symbolicname 'Microsoft.Sql/servers/jobAgents/jobs/steps@2022-08-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    action: {
      source: 'string'
      type: 'string'
      value: 'string'
    }
    credential: 'string'
    executionOptions: {
      initialRetryIntervalSeconds: int
      maximumRetryIntervalSeconds: int
      retryAttempts: int
      retryIntervalBackoffMultiplier: int
      timeoutSeconds: int
    }
    output: {
      credential: 'string'
      databaseName: 'string'
      resourceGroupName: 'string'
      schemaName: 'string'
      serverName: 'string'
      subscriptionId: 'string'
      tableName: 'string'
      type: 'string'
    }
    stepId: int
    targetGroup: 'string'
  }
}

Valori delle proprietà

Microsoft. Sql/server/jobAgent/jobs/steps

Name Description Value
name Nome della risorsa stringa (obbligatorio)
parent In Bicep, puoi specificare la risorsa genitore per una risorsa figlia. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: servers/jobAgents/jobs
properties Proprietà delle risorse. JobStepProperties

JobStepAction

Name Description Value
source Origine dell'azione da eseguire. 'Inline'
type Tipo di azione eseguita dal passaggio del processo. 'TSql'
value Valore dell'azione, ad esempio il testo dello script T-SQL da eseguire. stringa (obbligatorio)

JobStepExecutionOptions

Name Description Value
initialRetryIntervalSeconds Ritardo iniziale tra i tentativi per l'esecuzione del passaggio del processo. int
maximumRetryIntervalSeconds Quantità massima di tempo di attesa tra i tentativi per l'esecuzione del passaggio del processo. int
retryAttempts Numero massimo di tentativi di ripetizione del passaggio del processo se il primo tentativo ha esito negativo. int
retryIntervalBackoffMultiplier Moltiplicatore backoff per il tempo tra i tentativi. int
timeoutSeconds Timeout di esecuzione per il passaggio del processo. int

JobStepOutput

Name Description Value
credential ID risorsa della credenziale da usare per connettersi alla destinazione di output. stringa (obbligatorio)
databaseName Database di destinazione dell'output. stringa (obbligatorio)
resourceGroupName Gruppo di risorse di destinazione di output. string
schemaName Schema di destinazione dell'output. string
serverName Nome del server di destinazione di output. stringa (obbligatorio)
subscriptionId ID sottoscrizione di destinazione di output. string

Constraints:
Lunghezza minima = 36
Lunghezza massima = 36
Modello = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName Tabella di destinazione dell'output. stringa (obbligatorio)
type Tipo di destinazione di output. 'SqlDatabase'

JobStepProperties

Name Description Value
action Payload dell'azione del passaggio del processo. JobStepAction (obbligatorio)
credential ID risorsa delle credenziali del processo che verranno usate per connettersi alle destinazioni. stringa (obbligatorio)
executionOptions Opzioni di esecuzione per il passaggio del processo. JobStepExecutionOptions
output Proprietà di destinazione di output del passaggio del processo. JobStepOutput
stepId Indice del passaggio del processo all'interno del processo. Se non specificato durante la creazione del passaggio di processo, verrà creato come ultimo passaggio. Se non specificato durante l'aggiornamento del passaggio del processo, l'ID passaggio non viene modificato. int
targetGroup ID risorsa del gruppo di destinazione in cui verrà eseguito il passaggio del processo. stringa (obbligatorio)

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa servers/jobAgents/jobs/steps può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

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

Formato risorsa

Per creare un Microsoft. Risorsa Sql/servers/jobAgents/jobs/steps, aggiungi il seguente JSON al tuo template.

{
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
  "apiVersion": "2022-08-01-preview",
  "name": "string",
  "properties": {
    "action": {
      "source": "string",
      "type": "string",
      "value": "string"
    },
    "credential": "string",
    "executionOptions": {
      "initialRetryIntervalSeconds": "int",
      "maximumRetryIntervalSeconds": "int",
      "retryAttempts": "int",
      "retryIntervalBackoffMultiplier": "int",
      "timeoutSeconds": "int"
    },
    "output": {
      "credential": "string",
      "databaseName": "string",
      "resourceGroupName": "string",
      "schemaName": "string",
      "serverName": "string",
      "subscriptionId": "string",
      "tableName": "string",
      "type": "string"
    },
    "stepId": "int",
    "targetGroup": "string"
  }
}

Valori delle proprietà

Microsoft. Sql/server/jobAgent/jobs/steps

Name Description Value
apiVersion Versione dell'API '2022-08-01-preview'
name Nome della risorsa stringa (obbligatorio)
properties Proprietà delle risorse. JobStepProperties
type Tipo di risorsa 'Microsoft. Sql/server/jobAgent/jobs/passi

JobStepAction

Name Description Value
source Origine dell'azione da eseguire. 'Inline'
type Tipo di azione eseguita dal passaggio del processo. 'TSql'
value Valore dell'azione, ad esempio il testo dello script T-SQL da eseguire. stringa (obbligatorio)

JobStepExecutionOptions

Name Description Value
initialRetryIntervalSeconds Ritardo iniziale tra i tentativi per l'esecuzione del passaggio del processo. int
maximumRetryIntervalSeconds Quantità massima di tempo di attesa tra i tentativi per l'esecuzione del passaggio del processo. int
retryAttempts Numero massimo di tentativi di ripetizione del passaggio del processo se il primo tentativo ha esito negativo. int
retryIntervalBackoffMultiplier Moltiplicatore backoff per il tempo tra i tentativi. int
timeoutSeconds Timeout di esecuzione per il passaggio del processo. int

JobStepOutput

Name Description Value
credential ID risorsa della credenziale da usare per connettersi alla destinazione di output. stringa (obbligatorio)
databaseName Database di destinazione dell'output. stringa (obbligatorio)
resourceGroupName Gruppo di risorse di destinazione di output. string
schemaName Schema di destinazione dell'output. string
serverName Nome del server di destinazione di output. stringa (obbligatorio)
subscriptionId ID sottoscrizione di destinazione di output. string

Constraints:
Lunghezza minima = 36
Lunghezza massima = 36
Modello = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName Tabella di destinazione dell'output. stringa (obbligatorio)
type Tipo di destinazione di output. 'SqlDatabase'

JobStepProperties

Name Description Value
action Payload dell'azione del passaggio del processo. JobStepAction (obbligatorio)
credential ID risorsa delle credenziali del processo che verranno usate per connettersi alle destinazioni. stringa (obbligatorio)
executionOptions Opzioni di esecuzione per il passaggio del processo. JobStepExecutionOptions
output Proprietà di destinazione di output del passaggio del processo. JobStepOutput
stepId Indice del passaggio del processo all'interno del processo. Se non specificato durante la creazione del passaggio di processo, verrà creato come ultimo passaggio. Se non specificato durante l'aggiornamento del passaggio del processo, l'ID passaggio non viene modificato. int
targetGroup ID risorsa del gruppo di destinazione in cui verrà eseguito il passaggio del processo. stringa (obbligatorio)

Esempi di utilizzo

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa servers/jobAgents/jobs/steps può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

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

Formato risorsa

Per creare un Microsoft. Risorsa sql/server/jobAgents/jobs/steps, aggiungi il seguente Terraform al tuo template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/jobAgents/jobs/steps@2022-08-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      action = {
        source = "string"
        type = "string"
        value = "string"
      }
      credential = "string"
      executionOptions = {
        initialRetryIntervalSeconds = int
        maximumRetryIntervalSeconds = int
        retryAttempts = int
        retryIntervalBackoffMultiplier = int
        timeoutSeconds = int
      }
      output = {
        credential = "string"
        databaseName = "string"
        resourceGroupName = "string"
        schemaName = "string"
        serverName = "string"
        subscriptionId = "string"
        tableName = "string"
        type = "string"
      }
      stepId = int
      targetGroup = "string"
    }
  }
}

Valori delle proprietà

Microsoft. Sql/server/jobAgent/jobs/steps

Name Description Value
name Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servers/jobAgents/jobs
properties Proprietà delle risorse. JobStepProperties
type Tipo di risorsa "Microsoft. Sql/server/jobAgents/jobs/steps@2022-08-01-anteprima"

JobStepAction

Name Description Value
source Origine dell'azione da eseguire. 'Inline'
type Tipo di azione eseguita dal passaggio del processo. 'TSql'
value Valore dell'azione, ad esempio il testo dello script T-SQL da eseguire. stringa (obbligatorio)

JobStepExecutionOptions

Name Description Value
initialRetryIntervalSeconds Ritardo iniziale tra i tentativi per l'esecuzione del passaggio del processo. int
maximumRetryIntervalSeconds Quantità massima di tempo di attesa tra i tentativi per l'esecuzione del passaggio del processo. int
retryAttempts Numero massimo di tentativi di ripetizione del passaggio del processo se il primo tentativo ha esito negativo. int
retryIntervalBackoffMultiplier Moltiplicatore backoff per il tempo tra i tentativi. int
timeoutSeconds Timeout di esecuzione per il passaggio del processo. int

JobStepOutput

Name Description Value
credential ID risorsa della credenziale da usare per connettersi alla destinazione di output. stringa (obbligatorio)
databaseName Database di destinazione dell'output. stringa (obbligatorio)
resourceGroupName Gruppo di risorse di destinazione di output. string
schemaName Schema di destinazione dell'output. string
serverName Nome del server di destinazione di output. stringa (obbligatorio)
subscriptionId ID sottoscrizione di destinazione di output. string

Constraints:
Lunghezza minima = 36
Lunghezza massima = 36
Modello = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName Tabella di destinazione dell'output. stringa (obbligatorio)
type Tipo di destinazione di output. 'SqlDatabase'

JobStepProperties

Name Description Value
action Payload dell'azione del passaggio del processo. JobStepAction (obbligatorio)
credential ID risorsa delle credenziali del processo che verranno usate per connettersi alle destinazioni. stringa (obbligatorio)
executionOptions Opzioni di esecuzione per il passaggio del processo. JobStepExecutionOptions
output Proprietà di destinazione di output del passaggio del processo. JobStepOutput
stepId Indice del passaggio del processo all'interno del processo. Se non specificato durante la creazione del passaggio di processo, verrà creato come ultimo passaggio. Se non specificato durante l'aggiornamento del passaggio del processo, l'ID passaggio non viene modificato. int
targetGroup ID risorsa del gruppo di destinazione in cui verrà eseguito il passaggio del processo. stringa (obbligatorio)

Esempi di utilizzo

Esempi di Terraform

Un esempio di base di distribuzione di Elastic Job Step.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

variable "administrator_login_password" {
  type        = string
  sensitive   = true
  description = "The administrator login password for the SQL server"
}

variable "job_credential_password" {
  type        = string
  sensitive   = true
  description = "The password for the SQL job credential"
}

data "azapi_client_config" "current" {}

locals {
  maintenance_config_id = "/subscriptions/${data.azapi_client_config.current.subscription_id}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "server" {
  type      = "Microsoft.Sql/servers@2023-08-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-server"
  location  = var.location
  body = {
    properties = {
      administratorLogin            = "4dm1n157r470r"
      administratorLoginPassword    = var.administrator_login_password
      minimalTlsVersion             = "1.2"
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = "Disabled"
      version                       = "12.0"
    }
  }
}

resource "azapi_resource" "database" {
  type      = "Microsoft.Sql/servers/databases@2023-08-01-preview"
  parent_id = azapi_resource.server.id
  name      = "${var.resource_name}-db"
  location  = var.location
  body = {
    properties = {
      collation                  = "SQL_Latin1_General_CP1_CI_AS"
      createMode                 = "Default"
      maintenanceConfigurationId = local.maintenance_config_id
    }
    sku = {
      name = "S1"
    }
  }
}

resource "azapi_resource" "jobAgent" {
  type      = "Microsoft.Sql/servers/jobAgents@2023-08-01-preview"
  parent_id = azapi_resource.server.id
  name      = "${var.resource_name}-job-agent"
  location  = var.location
  body = {
    properties = {
      databaseId = azapi_resource.database.id
    }
    sku = {
      name = "JA100"
    }
  }
}

resource "azapi_resource" "job" {
  type      = "Microsoft.Sql/servers/jobAgents/jobs@2023-08-01-preview"
  parent_id = azapi_resource.jobAgent.id
  name      = "${var.resource_name}-job"
  body = {
    properties = {
      description = ""
    }
  }
}

resource "azapi_resource" "credential" {
  type      = "Microsoft.Sql/servers/jobAgents/credentials@2023-08-01-preview"
  parent_id = azapi_resource.jobAgent.id
  name      = "${var.resource_name}-job-credential"
  body = {
    properties = {
      password = var.job_credential_password
      username = "testusername"
    }
  }
}

resource "azapi_resource" "targetGroup" {
  type      = "Microsoft.Sql/servers/jobAgents/targetGroups@2023-08-01-preview"
  parent_id = azapi_resource.jobAgent.id
  name      = "${var.resource_name}-target-group"
  body = {
    properties = {
      members = []
    }
  }
}

resource "azapi_resource" "step" {
  type      = "Microsoft.Sql/servers/jobAgents/jobs/steps@2023-08-01-preview"
  parent_id = azapi_resource.job.id
  name      = "${var.resource_name}-job-step"
  body = {
    properties = {
      action = {
        value = "IF NOT EXISTS (SELECT * FROM sys.objects WHERE [name] = N'Person')\n  CREATE TABLE Person (\n    FirstName NVARCHAR(50),\n    LastName NVARCHAR(50),\n  );\n"
      }
      credential = azapi_resource.credential.id
      executionOptions = {
        initialRetryIntervalSeconds    = 1
        maximumRetryIntervalSeconds    = 120
        retryAttempts                  = 10
        retryIntervalBackoffMultiplier = 2
        timeoutSeconds                 = 43200
      }
      stepId      = 1
      targetGroup = azapi_resource.targetGroup.id
    }
  }
}