Udostępnij za pośrednictwem

Microsoft.Synapse workspaces 2019-06-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu obszarów roboczych można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Synapse/workspaces, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Synapse/workspaces@2019-06-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    connectivityEndpoints: {
      {customized property}: 'string'
    }
    defaultDataLakeStorage: {
      accountUrl: 'string'
      filesystem: 'string'
    }
    encryption: {
      cmk: {
        key: {
          keyVaultUrl: 'string'
          name: 'string'
        }
      }
    }
    managedResourceGroupName: 'string'
    managedVirtualNetwork: 'string'
    managedVirtualNetworkSettings: {
      allowedAadTenantIdsForLinking: [
        'string'
      ]
      linkedAccessCheckOnTargetResource: bool
      preventDataExfiltration: bool
    }
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    purviewConfiguration: {
      purviewResourceId: 'string'
    }
    sqlAdministratorLogin: 'string'
    sqlAdministratorLoginPassword: 'string'
    virtualNetworkProfile: {
      computeSubnetId: 'string'
    }
    workspaceRepositoryConfiguration: {
      accountName: 'string'
      clientId: 'string'
      clientSecret: {
        byoaSecretAkvUrl: 'string'
        byoaSecretName: 'string'
      }
      collaborationBranch: 'string'
      hostName: 'string'
      lastCommitId: 'string'
      projectName: 'string'
      repositoryName: 'string'
      rootFolder: 'string'
      tenantId: 'string'
      type: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

CustomerManagedKeyDetails

Nazwa Opis Wartość
klucz Obiekt klucza obszaru roboczego WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nazwa Opis Wartość
accountUrl Adres URL konta struna
system plików Nazwa systemu plików struna

EncryptionDetails

Nazwa Opis Wartość
cmk Szczegóły klucza zarządzanego przez klienta CustomerManagedKeyDetails

GitHubClientSecret

Nazwa Opis Wartość
byoaSecretAkvUrl Bring your own app client secret AKV URL struna
byoaSecretName Używanie własnej nazwy wpisu tajnego klienta aplikacji w usłudze AKV struna

Identyfikator zarządzany

Nazwa Opis Wartość
typ Typ tożsamości zarządzanej dla obszaru roboczego "Brak"
"SystemAssigned"

ManagedVirtualNetworkSettings

Nazwa Opis Wartość
allowedAadTenantIdsForLinking Dozwolone identyfikatory dzierżawy usługi Aad na potrzeby łączenia string[]
linkedAccessCheckOnTargetResource Sprawdzanie dostępu połączonego w zasobie docelowym Bool
preventDataExfiltration Zapobieganie eksfiltracji danych Bool

Microsoft.Synapse/workspaces

Nazwa Opis Wartość
tożsamość Tożsamość obszaru roboczego ManagedIdentity
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości zasobu obszaru roboczego WorkspaceWłaściwości
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

PrivateEndpoint

Nazwa Opis Wartość

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości Właściwości połączenia prywatnego punktu końcowego. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
privateEndpoint Prywatny punkt końcowy, do którego należy połączenie. PrivateEndpoint
privateLinkServiceConnectionState Stan połączenia prywatnego punktu końcowego. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
opis Opis połączenia usługi private link. struna
stan Stan połączenia usługi private link. struna

PurviewConfiguration

Nazwa Opis Wartość
purviewResourceId Identyfikator zasobu usługi Purview struna

TrackedResourceTags

Nazwa Opis Wartość

VirtualNetworkProfile

Nazwa Opis Wartość
computeSubnetId Identyfikator podsieci używany do obliczeń w obszarze roboczym struna

WorkspaceKeyDetails

Nazwa Opis Wartość
keyVaultUrl Adres URL magazynu kluczy podrzędnych klucza obszaru roboczego struna
nazwa Nazwa podsób klucza obszaru roboczego struna

Właściwości obszaru roboczego

Nazwa Opis Wartość
connectivityEndpoints Punkty końcowe łączności WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage Szczegóły domyślnego konta usługi Data Lake Storage obszaru roboczego DataLakeStorageAccountDetails
szyfrowanie Szczegóły szyfrowania obszaru roboczego EncryptionDetails
managedResourceGroupName Zarządzana grupa zasobów obszaru roboczego. Nazwa grupy zasobów jednoznacznie identyfikuje grupę zasobów w ramach identyfikatora subskrypcji użytkownika. Nazwa grupy zasobów nie może być dłuższa niż 90 znaków i musi być znakiem alfanumerycznym (Char.IsLetterOrDigit()) i "-", "_", "(", ")" i". Należy pamiętać, że nazwa nie może kończyć się ciągiem "". struna
managedVirtualNetwork Ustawienie tej wartości na wartość "default" zapewni, że wszystkie obliczenia dla tego obszaru roboczego są w sieci wirtualnej zarządzanej w imieniu użytkownika. struna
managedVirtualNetworkSettings Ustawienia zarządzanej sieci wirtualnej ManagedVirtualNetworkSettings
privateEndpointConnections Połączenia prywatnego punktu końcowego z obszarem roboczym PrivateEndpointConnection[]
purviewConfiguration Konfiguracja usługi Purview PurviewConfiguration
sqlAdministratorLogin Logowanie do obszaru roboczego administrator usługi SQL Active Directory struna
sqlAdministratorLoginPassword Hasło logowania administratora SQL struna
virtualNetworkProfile Profil sieci wirtualnej VirtualNetworkProfile
workspaceRepositoryConfiguration Ustawienia integracji z usługą Git WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nazwa Opis Wartość

Konfiguracja repozytorium obszaru roboczego

Nazwa Opis Wartość
accountName Nazwa konta struna
clientId GitHub bring your own app client id struna
clientSecret Usługa GitHub dostarcza własne informacje o wpisie tajnym klienta aplikacji. GitHubClientSecret
collaborationBranch Gałąź współpracy struna
nazwa hosta Nazwa hosta usługi GitHub Enterprise. Na przykład: https://github.mydomain.com struna
lastCommitId Ostatni identyfikator zatwierdzenia struna
nazwa projektu Nazwa projektu usługi VSTS struna
repositoryName Nazwa repozytorium struna
folder główny Folder główny do użycia w repozytorium struna
tenantId Identyfikator dzierżawy usługi VSTS struna

Ograniczenia:
Minimalna długość = 36
Maksymalna długość = 36
Wzorzec = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
typ Typ konfiguracji identyfikatora repozytorium obszaru roboczego. Przykładowy obszar roboczyVSTSConfiguration, workspaceGitHubConfiguration struna

Definicja zasobu szablonu usługi ARM

Typ zasobu obszarów roboczych można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Synapse/workspaces, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Synapse/workspaces",
  "apiVersion": "2019-06-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "connectivityEndpoints": {
      "{customized property}": "string"
    },
    "defaultDataLakeStorage": {
      "accountUrl": "string",
      "filesystem": "string"
    },
    "encryption": {
      "cmk": {
        "key": {
          "keyVaultUrl": "string",
          "name": "string"
        }
      }
    },
    "managedResourceGroupName": "string",
    "managedVirtualNetwork": "string",
    "managedVirtualNetworkSettings": {
      "allowedAadTenantIdsForLinking": [ "string" ],
      "linkedAccessCheckOnTargetResource": "bool",
      "preventDataExfiltration": "bool"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "purviewConfiguration": {
      "purviewResourceId": "string"
    },
    "sqlAdministratorLogin": "string",
    "sqlAdministratorLoginPassword": "string",
    "virtualNetworkProfile": {
      "computeSubnetId": "string"
    },
    "workspaceRepositoryConfiguration": {
      "accountName": "string",
      "clientId": "string",
      "clientSecret": {
        "byoaSecretAkvUrl": "string",
        "byoaSecretName": "string"
      },
      "collaborationBranch": "string",
      "hostName": "string",
      "lastCommitId": "string",
      "projectName": "string",
      "repositoryName": "string",
      "rootFolder": "string",
      "tenantId": "string",
      "type": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

CustomerManagedKeyDetails

Nazwa Opis Wartość
klucz Obiekt klucza obszaru roboczego WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nazwa Opis Wartość
accountUrl Adres URL konta struna
system plików Nazwa systemu plików struna

EncryptionDetails

Nazwa Opis Wartość
cmk Szczegóły klucza zarządzanego przez klienta CustomerManagedKeyDetails

GitHubClientSecret

Nazwa Opis Wartość
byoaSecretAkvUrl Bring your own app client secret AKV URL struna
byoaSecretName Używanie własnej nazwy wpisu tajnego klienta aplikacji w usłudze AKV struna

Identyfikator zarządzany

Nazwa Opis Wartość
typ Typ tożsamości zarządzanej dla obszaru roboczego "Brak"
"SystemAssigned"

ManagedVirtualNetworkSettings

Nazwa Opis Wartość
allowedAadTenantIdsForLinking Dozwolone identyfikatory dzierżawy usługi Aad na potrzeby łączenia string[]
linkedAccessCheckOnTargetResource Sprawdzanie dostępu połączonego w zasobie docelowym Bool
preventDataExfiltration Zapobieganie eksfiltracji danych Bool

Microsoft.Synapse/workspaces

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2019-06-01-preview"
tożsamość Tożsamość obszaru roboczego ManagedIdentity
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości zasobu obszaru roboczego WorkspaceWłaściwości
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.Synapse/workspaces"

PrivateEndpoint

Nazwa Opis Wartość

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości Właściwości połączenia prywatnego punktu końcowego. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
privateEndpoint Prywatny punkt końcowy, do którego należy połączenie. PrivateEndpoint
privateLinkServiceConnectionState Stan połączenia prywatnego punktu końcowego. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
opis Opis połączenia usługi private link. struna
stan Stan połączenia usługi private link. struna

PurviewConfiguration

Nazwa Opis Wartość
purviewResourceId Identyfikator zasobu usługi Purview struna

TrackedResourceTags

Nazwa Opis Wartość

VirtualNetworkProfile

Nazwa Opis Wartość
computeSubnetId Identyfikator podsieci używany do obliczeń w obszarze roboczym struna

WorkspaceKeyDetails

Nazwa Opis Wartość
keyVaultUrl Adres URL magazynu kluczy podrzędnych klucza obszaru roboczego struna
nazwa Nazwa podsób klucza obszaru roboczego struna

Właściwości obszaru roboczego

Nazwa Opis Wartość
connectivityEndpoints Punkty końcowe łączności WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage Szczegóły domyślnego konta usługi Data Lake Storage obszaru roboczego DataLakeStorageAccountDetails
szyfrowanie Szczegóły szyfrowania obszaru roboczego EncryptionDetails
managedResourceGroupName Zarządzana grupa zasobów obszaru roboczego. Nazwa grupy zasobów jednoznacznie identyfikuje grupę zasobów w ramach identyfikatora subskrypcji użytkownika. Nazwa grupy zasobów nie może być dłuższa niż 90 znaków i musi być znakiem alfanumerycznym (Char.IsLetterOrDigit()) i "-", "_", "(", ")" i". Należy pamiętać, że nazwa nie może kończyć się ciągiem "". struna
managedVirtualNetwork Ustawienie tej wartości na wartość "default" zapewni, że wszystkie obliczenia dla tego obszaru roboczego są w sieci wirtualnej zarządzanej w imieniu użytkownika. struna
managedVirtualNetworkSettings Ustawienia zarządzanej sieci wirtualnej ManagedVirtualNetworkSettings
privateEndpointConnections Połączenia prywatnego punktu końcowego z obszarem roboczym PrivateEndpointConnection[]
purviewConfiguration Konfiguracja usługi Purview PurviewConfiguration
sqlAdministratorLogin Logowanie do obszaru roboczego administrator usługi SQL Active Directory struna
sqlAdministratorLoginPassword Hasło logowania administratora SQL struna
virtualNetworkProfile Profil sieci wirtualnej VirtualNetworkProfile
workspaceRepositoryConfiguration Ustawienia integracji z usługą Git WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nazwa Opis Wartość

Konfiguracja repozytorium obszaru roboczego

Nazwa Opis Wartość
accountName Nazwa konta struna
clientId GitHub bring your own app client id struna
clientSecret Usługa GitHub dostarcza własne informacje o wpisie tajnym klienta aplikacji. GitHubClientSecret
collaborationBranch Gałąź współpracy struna
nazwa hosta Nazwa hosta usługi GitHub Enterprise. Na przykład: https://github.mydomain.com struna
lastCommitId Ostatni identyfikator zatwierdzenia struna
nazwa projektu Nazwa projektu usługi VSTS struna
repositoryName Nazwa repozytorium struna
folder główny Folder główny do użycia w repozytorium struna
tenantId Identyfikator dzierżawy usługi VSTS struna

Ograniczenia:
Minimalna długość = 36
Maksymalna długość = 36
Wzorzec = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
typ Typ konfiguracji identyfikatora repozytorium obszaru roboczego. Przykładowy obszar roboczyVSTSConfiguration, workspaceGitHubConfiguration struna

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
weryfikacji koncepcji usługi Azure Synapse

wdrażanie w usłudze Azure		 Ten szablon tworzy środowisko weryfikacji koncepcji dla usługi Azure Synapse, w tym pule SQL i opcjonalne pule platformy Apache Spark

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu obszarów roboczych można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Synapse/workspaces, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces@2019-06-01-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      connectivityEndpoints = {
        {customized property} = "string"
      }
      defaultDataLakeStorage = {
        accountUrl = "string"
        filesystem = "string"
      }
      encryption = {
        cmk = {
          key = {
            keyVaultUrl = "string"
            name = "string"
          }
        }
      }
      managedResourceGroupName = "string"
      managedVirtualNetwork = "string"
      managedVirtualNetworkSettings = {
        allowedAadTenantIdsForLinking = [
          "string"
        ]
        linkedAccessCheckOnTargetResource = bool
        preventDataExfiltration = bool
      }
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              description = "string"
              status = "string"
            }
          }
        }
      ]
      purviewConfiguration = {
        purviewResourceId = "string"
      }
      sqlAdministratorLogin = "string"
      sqlAdministratorLoginPassword = "string"
      virtualNetworkProfile = {
        computeSubnetId = "string"
      }
      workspaceRepositoryConfiguration = {
        accountName = "string"
        clientId = "string"
        clientSecret = {
          byoaSecretAkvUrl = "string"
          byoaSecretName = "string"
        }
        collaborationBranch = "string"
        hostName = "string"
        lastCommitId = "string"
        projectName = "string"
        repositoryName = "string"
        rootFolder = "string"
        tenantId = "string"
        type = "string"
      }
    }
  })
}

Wartości właściwości

CustomerManagedKeyDetails

Nazwa Opis Wartość
klucz Obiekt klucza obszaru roboczego WorkspaceKeyDetails

DataLakeStorageAccountDetails

Nazwa Opis Wartość
accountUrl Adres URL konta struna
system plików Nazwa systemu plików struna

EncryptionDetails

Nazwa Opis Wartość
cmk Szczegóły klucza zarządzanego przez klienta CustomerManagedKeyDetails

GitHubClientSecret

Nazwa Opis Wartość
byoaSecretAkvUrl Bring your own app client secret AKV URL struna
byoaSecretName Używanie własnej nazwy wpisu tajnego klienta aplikacji w usłudze AKV struna

Identyfikator zarządzany

Nazwa Opis Wartość
typ Typ tożsamości zarządzanej dla obszaru roboczego "Brak"
"SystemAssigned"

ManagedVirtualNetworkSettings

Nazwa Opis Wartość
allowedAadTenantIdsForLinking Dozwolone identyfikatory dzierżawy usługi Aad na potrzeby łączenia string[]
linkedAccessCheckOnTargetResource Sprawdzanie dostępu połączonego w zasobie docelowym Bool
preventDataExfiltration Zapobieganie eksfiltracji danych Bool

Microsoft.Synapse/workspaces

Nazwa Opis Wartość
tożsamość Tożsamość obszaru roboczego ManagedIdentity
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości zasobu obszaru roboczego WorkspaceWłaściwości
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.Synapse/workspaces@2019-06-01-preview"

PrivateEndpoint

Nazwa Opis Wartość

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości Właściwości połączenia prywatnego punktu końcowego. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
privateEndpoint Prywatny punkt końcowy, do którego należy połączenie. PrivateEndpoint
privateLinkServiceConnectionState Stan połączenia prywatnego punktu końcowego. PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Nazwa Opis Wartość
opis Opis połączenia usługi private link. struna
stan Stan połączenia usługi private link. struna

PurviewConfiguration

Nazwa Opis Wartość
purviewResourceId Identyfikator zasobu usługi Purview struna

TrackedResourceTags

Nazwa Opis Wartość

VirtualNetworkProfile

Nazwa Opis Wartość
computeSubnetId Identyfikator podsieci używany do obliczeń w obszarze roboczym struna

WorkspaceKeyDetails

Nazwa Opis Wartość
keyVaultUrl Adres URL magazynu kluczy podrzędnych klucza obszaru roboczego struna
nazwa Nazwa podsób klucza obszaru roboczego struna

Właściwości obszaru roboczego

Nazwa Opis Wartość
connectivityEndpoints Punkty końcowe łączności WorkspacePropertiesConnectivityEndpoints
defaultDataLakeStorage Szczegóły domyślnego konta usługi Data Lake Storage obszaru roboczego DataLakeStorageAccountDetails
szyfrowanie Szczegóły szyfrowania obszaru roboczego EncryptionDetails
managedResourceGroupName Zarządzana grupa zasobów obszaru roboczego. Nazwa grupy zasobów jednoznacznie identyfikuje grupę zasobów w ramach identyfikatora subskrypcji użytkownika. Nazwa grupy zasobów nie może być dłuższa niż 90 znaków i musi być znakiem alfanumerycznym (Char.IsLetterOrDigit()) i "-", "_", "(", ")" i". Należy pamiętać, że nazwa nie może kończyć się ciągiem "". struna
managedVirtualNetwork Ustawienie tej wartości na wartość "default" zapewni, że wszystkie obliczenia dla tego obszaru roboczego są w sieci wirtualnej zarządzanej w imieniu użytkownika. struna
managedVirtualNetworkSettings Ustawienia zarządzanej sieci wirtualnej ManagedVirtualNetworkSettings
privateEndpointConnections Połączenia prywatnego punktu końcowego z obszarem roboczym PrivateEndpointConnection[]
purviewConfiguration Konfiguracja usługi Purview PurviewConfiguration
sqlAdministratorLogin Logowanie do obszaru roboczego administrator usługi SQL Active Directory struna
sqlAdministratorLoginPassword Hasło logowania administratora SQL struna
virtualNetworkProfile Profil sieci wirtualnej VirtualNetworkProfile
workspaceRepositoryConfiguration Ustawienia integracji z usługą Git WorkspaceRepositoryConfiguration

WorkspacePropertiesConnectivityEndpoints

Nazwa Opis Wartość

Konfiguracja repozytorium obszaru roboczego

Nazwa Opis Wartość
accountName Nazwa konta struna
clientId GitHub bring your own app client id struna
clientSecret Usługa GitHub dostarcza własne informacje o wpisie tajnym klienta aplikacji. GitHubClientSecret
collaborationBranch Gałąź współpracy struna
nazwa hosta Nazwa hosta usługi GitHub Enterprise. Na przykład: https://github.mydomain.com struna
lastCommitId Ostatni identyfikator zatwierdzenia struna
nazwa projektu Nazwa projektu usługi VSTS struna
repositoryName Nazwa repozytorium struna
folder główny Folder główny do użycia w repozytorium struna
tenantId Identyfikator dzierżawy usługi VSTS struna

Ograniczenia:
Minimalna długość = 36
Maksymalna długość = 36
Wzorzec = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
typ Typ konfiguracji identyfikatora repozytorium obszaru roboczego. Przykładowy obszar roboczyVSTSConfiguration, workspaceGitHubConfiguration struna