Condividi tramite

Microsoft.SQL server/jobAgents/targetGroups

Definizione di risorsa Bicep

Il tipo di risorsa servers/jobAgents/targetGroups 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 una risorsa Microsoft.Sql/servers/jobAgents/targetGroups, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Sql/servers/jobAgents/targetGroups@2024-11-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    members: [
      {
        databaseName: 'string'
        elasticPoolName: 'string'
        membershipType: 'string'
        refreshCredential: 'string'
        serverName: 'string'
        shardMapName: 'string'
        type: 'string'
      }
    ]
  }
}

Valori delle proprietà

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
name Nome della risorsa stringa (obbligatorio)
parent In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È 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: server/jobAgents
properties Proprietà delle risorse. JobTargetGroupProperties

JobTarget

Name Description Value
databaseName Nome del database di destinazione. string
elasticPoolName Nome del pool elastico di destinazione. string
membershipType Indica se la destinazione è inclusa o esclusa dal gruppo. 'Exclude'
'Include'
refreshCredential ID risorsa delle credenziali usate durante l'esecuzione del processo per connettersi alla destinazione e determinare l'elenco di database all'interno della destinazione. string
serverName Nome del server di destinazione. string
shardMapName Mappa partizioni di destinazione. string
type Tipo di destinazione. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obbligatorio)

JobTargetGroupProperties

Name Description Value
members Membri del gruppo di destinazione. JobTarget[] (obbligatorio)

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa servers/jobAgents/targetGroups 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 una risorsa Microsoft.Sql/servers/jobAgents/targetGroups, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.Sql/servers/jobAgents/targetGroups",
  "apiVersion": "2024-11-01-preview",
  "name": "string",
  "properties": {
    "members": [
      {
        "databaseName": "string",
        "elasticPoolName": "string",
        "membershipType": "string",
        "refreshCredential": "string",
        "serverName": "string",
        "shardMapName": "string",
        "type": "string"
      }
    ]
  }
}

Valori delle proprietà

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
apiVersion Versione dell'API '2024-11-01-preview'
name Nome della risorsa stringa (obbligatorio)
properties Proprietà delle risorse. JobTargetGroupProperties
type Tipo di risorsa 'Microsoft.Sql/servers/jobAgents/targetGroups'

JobTarget

Name Description Value
databaseName Nome del database di destinazione. string
elasticPoolName Nome del pool elastico di destinazione. string
membershipType Indica se la destinazione è inclusa o esclusa dal gruppo. 'Exclude'
'Include'
refreshCredential ID risorsa delle credenziali usate durante l'esecuzione del processo per connettersi alla destinazione e determinare l'elenco di database all'interno della destinazione. string
serverName Nome del server di destinazione. string
shardMapName Mappa partizioni di destinazione. string
type Tipo di destinazione. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obbligatorio)

JobTargetGroupProperties

Name Description Value
members Membri del gruppo di destinazione. JobTarget[] (obbligatorio)

Esempi di utilizzo

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa servers/jobAgents/targetGroups 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 una risorsa Microsoft.Sql/servers/jobAgents/targetGroups, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/jobAgents/targetGroups@2024-11-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      members = [
        {
          databaseName = "string"
          elasticPoolName = "string"
          membershipType = "string"
          refreshCredential = "string"
          serverName = "string"
          shardMapName = "string"
          type = "string"
        }
      ]
    }
  }
}

Valori delle proprietà

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
name Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: server/jobAgents
properties Proprietà delle risorse. JobTargetGroupProperties
type Tipo di risorsa "Microsoft.Sql/servers/jobAgents/targetGroups@2024-11-01-preview"

JobTarget

Name Description Value
databaseName Nome del database di destinazione. string
elasticPoolName Nome del pool elastico di destinazione. string
membershipType Indica se la destinazione è inclusa o esclusa dal gruppo. 'Exclude'
'Include'
refreshCredential ID risorsa delle credenziali usate durante l'esecuzione del processo per connettersi alla destinazione e determinare l'elenco di database all'interno della destinazione. string
serverName Nome del server di destinazione. string
shardMapName Mappa partizioni di destinazione. string
type Tipo di destinazione. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obbligatorio)

JobTargetGroupProperties

Name Description Value
members Membri del gruppo di destinazione. JobTarget[] (obbligatorio)

Esempi di utilizzo

Esempi di Terraform

Un esempio di base di distribuzione del gruppo di destinazione dei processi elastici.

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

provider "azapi" {
  skip_provider_registration = false
}

data "azapi_client_config" "current" {}

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

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

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

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 = {
      autoPauseDelay                   = 0
      collation                        = "SQL_Latin1_General_CP1_CI_AS"
      createMode                       = "Default"
      elasticPoolId                    = ""
      encryptionProtectorAutoRotation  = false
      highAvailabilityReplicaCount     = 0
      isLedgerOn                       = false
      licenseType                      = ""
      maintenanceConfigurationId       = "/subscriptions/${data.azapi_client_config.current.subscription_id}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"
      minCapacity                      = 0
      readScale                        = "Disabled"
      requestedBackupStorageRedundancy = "Geo"
      sampleName                       = ""
      secondaryType                    = ""
      zoneRedundant                    = false
    }
    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" "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 = []
    }
  }
}
  • Last updated on