Partilhar via


Microsoft.Sql servers/jobAgents/targetGroups 2022-05-01-preview

Definição de recursos do bíceps

O tipo de recurso servers/jobAgents/targetGroups pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Sql/servers/jobAgents/targetGroups, adicione o seguinte Bicep ao seu modelo.

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

Valores de propriedade

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
name O nome do recurso string (obrigatório)
elemento principal No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para recurso do tipo: servers/jobAgents
properties Propriedades do recurso. JobTargetGroupProperties

JobTarget

Name Description Value
databaseName O nome do banco de dados de destino. cadeia (de caracteres)
elasticPoolName O nome do pool elástico de destino. cadeia (de caracteres)
membershipType Se o alvo está incluído ou excluído do grupo. 'Exclude'
'Include'
refreshCredential A ID de recurso da credencial usada durante a execução do trabalho para se conectar ao destino e determinar a lista de bancos de dados dentro do destino. cadeia (de caracteres)
serverName O nome do servidor de destino. cadeia (de caracteres)
shardMapName O mapa de estilhaços de destino. cadeia (de caracteres)
tipo O tipo de destino. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obrigatório)

JobTargetGroupProperties

Name Description Value
members Membros do grupo-alvo. JobTarget[] (obrigatório)

Definição de recurso de modelo ARM

O tipo de recurso servers/jobAgents/targetGroups pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Sql/servers/jobAgents/targetGroups, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
apiVersion A versão api '2022-05-01-preview'
name O nome do recurso string (obrigatório)
properties Propriedades do recurso. JobTargetGroupProperties
tipo O tipo de recurso 'Microsoft.Sql/servers/jobAgents/targetGroups'

JobTarget

Name Description Value
databaseName O nome do banco de dados de destino. cadeia (de caracteres)
elasticPoolName O nome do pool elástico de destino. cadeia (de caracteres)
membershipType Se o alvo está incluído ou excluído do grupo. 'Exclude'
'Include'
refreshCredential A ID de recurso da credencial usada durante a execução do trabalho para se conectar ao destino e determinar a lista de bancos de dados dentro do destino. cadeia (de caracteres)
serverName O nome do servidor de destino. cadeia (de caracteres)
shardMapName O mapa de estilhaços de destino. cadeia (de caracteres)
tipo O tipo de destino. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obrigatório)

JobTargetGroupProperties

Name Description Value
members Membros do grupo-alvo. JobTarget[] (obrigatório)

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso servers/jobAgents/targetGroups pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Sql/servers/jobAgents/targetGroups, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

Microsoft.Sql/servers/jobAgents/targetGroups

Name Description Value
name O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: servers/jobAgents
properties Propriedades do recurso. JobTargetGroupProperties
tipo O tipo de recurso "Microsoft.Sql/servers/jobAgents/targetGroups@2022-05-01-preview"

JobTarget

Name Description Value
databaseName O nome do banco de dados de destino. cadeia (de caracteres)
elasticPoolName O nome do pool elástico de destino. cadeia (de caracteres)
membershipType Se o alvo está incluído ou excluído do grupo. 'Exclude'
'Include'
refreshCredential A ID de recurso da credencial usada durante a execução do trabalho para se conectar ao destino e determinar a lista de bancos de dados dentro do destino. cadeia (de caracteres)
serverName O nome do servidor de destino. cadeia (de caracteres)
shardMapName O mapa de estilhaços de destino. cadeia (de caracteres)
tipo O tipo de destino. 'SqlDatabase'
'SqlElasticPool'
'SqlServer'
'SqlShardMap'
'TargetGroup' (obrigatório)

JobTargetGroupProperties

Name Description Value
members Membros do grupo-alvo. JobTarget[] (obrigatório)

Exemplos de uso

Amostras Terraform

Um exemplo básico de implantação do 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 = []
    }
  }
}