Áreas de trabajo de Microsoft.Synapse/firewallRules 2021-06-01

Definición de recursos de Bicep

El tipo de recurso workspaces/firewallRules se puede implementar con operaciones que tienen como destino:

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

Ejemplos de uso

Ejemplos de Bicep

Un ejemplo básico de implementación de la regla de firewall de Synapse.

@description('The SQL administrator login for the Synapse workspace')
param sqlAdministratorLogin string
@secure()
@description('The SQL administrator login password for the Synapse workspace')
param sqlAdministratorLoginPassword string
param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource blobService 'Microsoft.Storage/storageAccounts/blobServices@2022-09-01' existing = {
  name: 'default'
  parent: storageAccount
}

resource container 'Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01' = {
  name: resourceName
  parent: blobService
  properties: {
    metadata: {
      key: 'value'
    }
  }
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2021-09-01' = {
  name: resourceName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
  properties: {}
}

resource workspace 'Microsoft.Synapse/workspaces@2021-06-01' = {
  name: resourceName
  location: location
  properties: {
    defaultDataLakeStorage: {
      accountUrl: storageAccount.properties.primaryEndpoints.dfs
      filesystem: container.name
    }
    managedVirtualNetwork: ''
    publicNetworkAccess: 'Enabled'
    sqlAdministratorLogin: sqlAdministratorLogin
    sqlAdministratorLoginPassword: sqlAdministratorLoginPassword
  }
}

resource firewallRule 'Microsoft.Synapse/workspaces/firewallRules@2021-06-01' = {
  name: 'AllowAll'
  parent: workspace
  properties: {
    endIpAddress: '255.255.255.255'
    startIpAddress: '0.0.0.0'
  }
}

Módulos comprobados de Azure

Los siguientes módulos comprobados de Azure se pueden usar para implementar este tipo de recurso.

Module Descripción
Azure Synapse Analytics Workspace - Firewall Rule AVM Child Module for Azure Synapse Analytics Workspace - Firewall Rule

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/firewallRules, agregue la siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.Synapse/workspaces/firewallRules@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    endIpAddress: 'string'
    startIpAddress: 'string'
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/firewallRules

Nombre Descripción Valor
nombre El nombre del recurso string (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. 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: áreas de trabajo
Propiedades Propiedades de la regla de firewall de IP ipFirewallRuleProperties

IpFirewallRuleProperties

Nombre Descripción Valor
endIpAddress Dirección IP final de la regla de firewall. Debe tener el formato IPv4. Debe ser mayor o igual que startIpAddress cuerda
startIpAddress Dirección IP inicial de la regla de firewall. Debe tener el formato IPv4. cuerda

Definición de recursos de plantilla de ARM

El tipo de recurso workspaces/firewallRules se puede implementar con operaciones que tienen como destino:

Ejemplos de uso

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/firewallRules, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.Synapse/workspaces/firewallRules",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "endIpAddress": "string",
    "startIpAddress": "string"
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/firewallRules

Nombre Descripción Valor
apiVersion La versión de api '2021-06-01'
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades de la regla de firewall de IP ipFirewallRuleProperties
tipo El tipo de recurso "Microsoft.Synapse/workspaces/firewallRules"

IpFirewallRuleProperties

Nombre Descripción Valor
endIpAddress Dirección IP final de la regla de firewall. Debe tener el formato IPv4. Debe ser mayor o igual que startIpAddress cuerda
startIpAddress Dirección IP inicial de la regla de firewall. Debe tener el formato IPv4. cuerda

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso workspaces/firewallRules se puede implementar con 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 la regla de firewall de Synapse.

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

variable "sql_administrator_login" {
  type        = string
  description = "The SQL administrator login for the Synapse workspace"
}

variable "sql_administrator_login_password" {
  type        = string
  description = "The SQL administrator login password for the Synapse workspace"
  sensitive   = true
}

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

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2022-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

data "azapi_resource" "blobService" {
  type      = "Microsoft.Storage/storageAccounts/blobServices@2022-09-01"
  parent_id = azapi_resource.storageAccount.id
  name      = "default"
}

resource "azapi_resource" "container" {
  type      = "Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
  name      = var.resource_name
  parent_id = data.azapi_resource.blobService.id
  body = {
    properties = {
      metadata = {
        key = "value"
      }
    }
  }
  response_export_values = ["*"]
}

resource "azapi_resource" "workspace" {
  type      = "Microsoft.Synapse/workspaces@2021-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      defaultDataLakeStorage = {
        accountUrl = azapi_resource.storageAccount.output.properties.primaryEndpoints.dfs
        filesystem = azapi_resource.container.name
      }

      managedVirtualNetwork         = ""
      publicNetworkAccess           = "Enabled"
      sqlAdministratorLogin         = var.sql_administrator_login
      sqlAdministratorLoginPassword = var.sql_administrator_login_password
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "firewallRule" {
  type      = "Microsoft.Synapse/workspaces/firewallRules@2021-06-01"
  parent_id = azapi_resource.workspace.id
  name      = "AllowAll"
  body = {
    properties = {
      endIpAddress   = "255.255.255.255"
      startIpAddress = "0.0.0.0"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Formato de recurso

Para crear un recurso Microsoft.Synapse/workspaces/firewallRules, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/firewallRules@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      endIpAddress = "string"
      startIpAddress = "string"
    }
  }
}

Valores de propiedad

Microsoft.Synapse/workspaces/firewallRules

Nombre Descripción Valor
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: áreas de trabajo
Propiedades Propiedades de la regla de firewall de IP ipFirewallRuleProperties
tipo El tipo de recurso "Microsoft.Synapse/workspaces/firewallRules@2021-06-01"

IpFirewallRuleProperties

Nombre Descripción Valor
endIpAddress Dirección IP final de la regla de firewall. Debe tener el formato IPv4. Debe ser mayor o igual que startIpAddress cuerda
startIpAddress Dirección IP inicial de la regla de firewall. Debe tener el formato IPv4. cuerda