Microsoft. Servidores SQL/jobAgents/TargetGroups 2025-01-01

Definición de recurso Bicep

El tipo de recurso servers/jobAgents/targetGroups se puede implementar con las operaciones que tienen como destino:

  • Grupos de recursos - Véase grupos de recursos c1

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Ejemplos de uso

Muestras de Bicep

Un ejemplo básico de implementación de Elastic Job Target Group.

param resourceName string = 'acctest0001'
param location string = 'centralus'
@secure()
@description('The administrator login password for the SQL server')
param administratorLoginPassword string
@secure()
@description('The password for the SQL job credential')
param jobCredentialPassword string

resource server 'Microsoft.Sql/servers@2023-08-01-preview' = {
  name: '${resourceName}-server'
  location: location
  properties: {
    administratorLogin: '4dm1n157r470r'
    administratorLoginPassword: administratorLoginPassword
    minimalTlsVersion: '1.2'
    publicNetworkAccess: 'Enabled'
    restrictOutboundNetworkAccess: 'Disabled'
    version: '12.0'
  }
}

resource database 'Microsoft.Sql/servers/databases@2023-08-01-preview' = {
  name: '${resourceName}-db'
  location: location
  parent: server
  sku: {
    name: 'S1'
  }
  properties: {
    autoPauseDelay: 0
    collation: 'SQL_Latin1_General_CP1_CI_AS'
    createMode: 'Default'
    elasticPoolId: ''
    encryptionProtectorAutoRotation: false
    highAvailabilityReplicaCount: 0
    isLedgerOn: false
    licenseType: ''
    maintenanceConfigurationId: '/subscriptions/${subscription().subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default'
    minCapacity: 0
    readScale: 'Disabled'
    requestedBackupStorageRedundancy: 'Geo'
    sampleName: ''
    secondaryType: ''
    zoneRedundant: false
  }
}

resource jobAgent 'Microsoft.Sql/servers/jobAgents@2023-08-01-preview' = {
  name: '${resourceName}-job-agent'
  location: location
  parent: server
  sku: {
    name: 'JA100'
  }
  properties: {
    databaseId: database.id
  }
}

resource credential 'Microsoft.Sql/servers/jobAgents/credentials@2023-08-01-preview' = {
  name: '${resourceName}-job-credential'
  parent: jobAgent
  properties: {
    password: jobCredentialPassword
    username: 'testusername'
  }
}

resource targetGroup 'Microsoft.Sql/servers/jobAgents/targetGroups@2023-08-01-preview' = {
  name: '${resourceName}-target-group'
  parent: jobAgent
  properties: {
    members: []
  }
}

Formato de recurso

Para crear un Microsoft. Recurso Sql/servers/jobAgents/targetGroups, añade el siguiente Bicep a tu plantilla.

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

Valores de propiedad

Microsoft. Sql/servidores/agentes_empleo/grupos-destino

Nombre Descripción Importancia
nombre El nombre del recurso string (obligatorio)
parent En Bicep, puedes especificar el recurso padre para un recurso hijo. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: servers/jobAgents
Propiedades Propiedades de recursos. JobTargetGroupProperties

JobTarget

Nombre Descripción Importancia
databaseName Nombre de la base de datos de destino. cuerda / cadena
elasticPoolName Nombre del grupo elástico de destino. cuerda / cadena
membershipType Indica si el destino está incluido o excluido del grupo. 'Exclude'
'Include'
refreshCredential Identificador de recurso de la credencial que se usa durante la ejecución del trabajo para conectarse al destino y determinar la lista de bases de datos dentro del destino. cuerda / cadena
serverName Nombre del servidor de destino. cuerda / cadena
shardMapName Mapa de particiones de destino. cuerda / cadena
tipo Tipo de destino. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obligatorio)

JobTargetGroupProperties

Nombre Descripción Importancia
Miembros Miembros del grupo de destino. JobTarget[] (obligatorio)

Definición de recursos de plantilla de ARM

El tipo de recurso servers/jobAgents/targetGroups se puede implementar con las operaciones que tienen como destino:

Ejemplos de uso

Formato de recurso

Para crear un Microsoft. Recurso Sql/servers/jobAgents/targetGroups, añade el siguiente JSON a tu plantilla.

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

Valores de propiedad

Microsoft. Sql/servidores/agentes_empleo/grupos-destino

Nombre Descripción Importancia
apiVersion La versión de api '2025-01-01'
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades de recursos. JobTargetGroupProperties
tipo El tipo de recurso 'Microsoft. Sql/servidores/agentes-de_empleo/grupos-destinatario

JobTarget

Nombre Descripción Importancia
databaseName Nombre de la base de datos de destino. cuerda / cadena
elasticPoolName Nombre del grupo elástico de destino. cuerda / cadena
membershipType Indica si el destino está incluido o excluido del grupo. 'Exclude'
'Include'
refreshCredential Identificador de recurso de la credencial que se usa durante la ejecución del trabajo para conectarse al destino y determinar la lista de bases de datos dentro del destino. cuerda / cadena
serverName Nombre del servidor de destino. cuerda / cadena
shardMapName Mapa de particiones de destino. cuerda / cadena
tipo Tipo de destino. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obligatorio)

JobTargetGroupProperties

Nombre Descripción Importancia
Miembros Miembros del grupo de destino. JobTarget[] (obligatorio)

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso servers/jobAgents/targetGroups se puede implementar con las operaciones que tienen como destino:

  • Grupos de recursos Para una lista de propiedades modificadas en cada versión de la API, consulte registro de cambios.

Ejemplos de uso

Ejemplos de Terraform

Un ejemplo básico de implementación de Elastic Job Target Group.

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

Formato de recurso

Para crear un Microsoft. Recurso Sql/servers/jobAgents/targetGroups, añade el siguiente Terraform a tu plantilla.

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

Valores de propiedad

Microsoft. Sql/servidores/agentes_empleo/grupos-destino

Nombre Descripción Importancia
nombre El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: servers/jobAgents
Propiedades Propiedades de recursos. JobTargetGroupProperties
tipo El tipo de recurso "Microsoft. Sql/servidores/agentesEmpleo/targetGroups@2025-01-01"

JobTarget

Nombre Descripción Importancia
databaseName Nombre de la base de datos de destino. cuerda / cadena
elasticPoolName Nombre del grupo elástico de destino. cuerda / cadena
membershipType Indica si el destino está incluido o excluido del grupo. 'Exclude'
'Include'
refreshCredential Identificador de recurso de la credencial que se usa durante la ejecución del trabajo para conectarse al destino y determinar la lista de bases de datos dentro del destino. cuerda / cadena
serverName Nombre del servidor de destino. cuerda / cadena
shardMapName Mapa de particiones de destino. cuerda / cadena
tipo Tipo de destino. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obligatorio)

JobTargetGroupProperties

Nombre Descripción Importancia
Miembros Miembros del grupo de destino. JobTarget[] (obligatorio)