Pracovní prostory Microsoft.Synapse / firewallRules 2021-06-01

Definice prostředku Bicep

Typ prostředku pracovních prostorů nebo pravidel brány firewall je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Příklady použití

Ukázky Bicep

Základní příklad nasazení pravidla brány firewall 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'
  }
}

Ověřené moduly Azure

K nasazení tohoto typu prostředku je možné použít následující ověřené moduly Azure.

Module Popis
Azure Synapse Analytics Workspace - Firewall Rule AVM Child Module for Azure Synapse Analytics Workspace - Firewall Rule

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Synapse/workspaces/firewallRules, přidejte do šablony následující bicep.

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

Hodnoty vlastností

Microsoft.Synapse/pracovní prostory/firewallRules

Jméno Popis Hodnota
Jméno Název prostředku string (povinné)
nadřazený objekt V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: pracovních prostorů
vlastnosti Vlastnosti pravidla brány firewall protokolu IP IpFirewallRuleProperties

IpFirewallRuleProperties

Jméno Popis Hodnota
Adresa endIpAddress Koncová IP adresa pravidla brány firewall. Musí to být formát IPv4. Musí být větší než nebo rovno hodnotě startIpAddress. řetězec
startIpAddress Počáteční IP adresa pravidla brány firewall. Musí být formát IPv4. řetězec

Definice prostředku šablony ARM

Typ prostředku pracovních prostorů nebo pravidel brány firewall je možné nasadit s operacemi, které cílí:

Příklady použití

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Synapse/workspaces/firewallRules, přidejte do šablony následující JSON.

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

Hodnoty vlastností

Microsoft.Synapse/pracovní prostory/firewallRules

Jméno Popis Hodnota
Verze rozhraní apiVersion Verze rozhraní API '2021-06-01'
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti pravidla brány firewall protokolu IP IpFirewallRuleProperties
typ Typ prostředku Microsoft.Synapse/workspaces/firewallRules

IpFirewallRuleProperties

Jméno Popis Hodnota
Adresa endIpAddress Koncová IP adresa pravidla brány firewall. Musí to být formát IPv4. Musí být větší než nebo rovno hodnotě startIpAddress. řetězec
startIpAddress Počáteční IP adresa pravidla brány firewall. Musí být formát IPv4. řetězec

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku pracovních prostorů nebo pravidel brány firewall je možné nasadit s operacemi, které cílí:

  • Skupiny zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.

Příklady použití

Ukázky Terraformu

Základní příklad nasazení pravidla brány firewall 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    = ["*"]
}

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.Synapse/workspaces/firewallRules, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

Microsoft.Synapse/pracovní prostory/firewallRules

Jméno Popis Hodnota
Jméno Název prostředku string (povinné)
ID rodiče ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: pracovních prostorů
vlastnosti Vlastnosti pravidla brány firewall protokolu IP IpFirewallRuleProperties
typ Typ prostředku Microsoft.Synapse/workspaces/firewallRules@2021-06-01

IpFirewallRuleProperties

Jméno Popis Hodnota
Adresa endIpAddress Koncová IP adresa pravidla brány firewall. Musí to být formát IPv4. Musí být větší než nebo rovno hodnotě startIpAddress. řetězec
startIpAddress Počáteční IP adresa pravidla brány firewall. Musí být formát IPv4. řetězec