Sdílet prostřednictvím

Vytvoření databáze SQL v Microsoft Fabric prostřednictvím rozhraní REST API

  • Článek

Platí pro:✅SQL Database v Microsoft Fabric

Platforma Fabric má bohatou sadu rozhraní REST API, která je možné použít k nasazení a správě prostředků. Tato rozhraní API je možné použít k nasazení databází SQL Infrastruktury. Tento článek a ukázkový skript demonstrují základní skript PowerShellu, který se dá použít k nasazení databáze SQL Fabric a přidání dat do ní.

Požadavky

  • Potřebujete existující kapacitu Fabric. Pokud ne, spusťte zkušební verzi Fabric.
  • Ujistěte se, že v prostředcích infrastruktury povolíte databázi SQL pomocí nastavení tenanta portálu pro správu.
  • Vytvořte nový pracovní prostor nebo použijte existující pracovní prostor Fabric.
  • Abyste mohli vytvořit databázi SQL, musíte být členem role správce nebo člena pracovního prostoru.
  • Nainstalujte verzi jazyka GoCMD. Spusťte winget install sqlcmd windows a nainstalujte ho. Další operační systémy najdete v tématu aka.ms/go-sqlcmd.
  • Modul Az PowerShell. Spusťte Install-Module az v PowerShellu a nainstalujte ho.

Vytvoření nové databáze SQL prostřednictvím rozhraní REST API

Tento ukázkový skript používá Connect-AzAccountalias výzvy k zadání přihlašovacích az login údajů. Tyto přihlašovací údaje používá k získání přístupového tokenu, který se použije pro volání rozhraní REST API. SQLCMD používá kontext účtu, který byl předán Connect-AzAccount.

Skript vytvoří databázi s názvem alias přihlášeného uživatele a datem. V současné době rozhraní REST API nevrací stav, takže musíme opakovat smyčku a zkontrolovat vytvoření databáze. Po vytvoření databáze se SQLCMD použije k vytvoření některých objektů a následnému dotazování na jejich existenci. Nakonec databázi odstraníme.

V následujícím skriptu nahraďte <your workspace id> ID pracovního prostoru Fabric. ID pracovního prostoru můžete snadno najít v adrese URL. Jedná se o jedinečný řetězec uvnitř dvou / znaků za /groups/ oknem prohlížeče. Například 11aa111-a11a-1111-1abc-aa1111aaaa v .https://fabric.microsoft.com/groups/11aa111-a11a-1111-1abc-aa1111aaaa/

Tento skript ukazuje:

  1. Přístupový token načtěte pomocí Get-AzAccessToken a jej převedete ze zabezpečeného řetězce. Pokud používáte verzi PowerShell 7, ConvertFrom-SecureString je také jednou z možností.
  2. Vytvořte novou databázi SQL pomocí Items - Create Item API.
  3. Seznam SQL databází ve Fatě pracovního prostoru.
  4. Připojte se k databázi pomocí SQLCMD ke spuštění skriptu pro vytvoření objektu.
  5. Odstraňte databázi pomocí Položek – rozhraní API pro odstranění položek.
Import-Module Az.Accounts

Connect-AzAccount

$workspaceid = '<your workspace id>'

$databaseid = $null 
$headers = $null
$responseHeaders = $null 

# 1. Get the access token and add it to the headers

$access_token = (Get-AzAccessToken -AsSecureString -ResourceUrl https://api.fabric.microsoft.com) 

$ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($access_token.Token)

try {

    $headers = @{ 
       Authorization = $access_token.Type + ' ' + ([System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr))
    }

    $access_token.UserId -match('^[^@]+') | Out-Null

    # 2. Create the database and wait for it to be created.

    $body = @{
        displayName = $matches[0] + (Get-Date -Format "MMddyyyy")
        type = "SQLDatabase"
        description = "Created using public api"
    }

    $parameters = @{
        Method="Post"
        Headers=$headers
        ContentType="application/json"
        Body=($body | ConvertTo-Json)
        Uri = 'https://api.fabric.microsoft.com/v1/workspaces/' + $workspaceid + '/items'
    }

    Invoke-RestMethod @parameters -ErrorAction Stop

    $databases = (Invoke-RestMethod -Headers $headers -Uri https://api.fabric.microsoft.com/v1/workspaces/$($workspaceid)/SqlDatabases).value
    $databaseid = $databases.Where({$_.displayName -eq $body.displayName}).id

    While($databaseid -eq $null)
    {
        Write-Host 'Waiting on database create.'
        Start-Sleep 30
        $databases = (Invoke-RestMethod -Headers $headers -Uri https://api.fabric.microsoft.com/v1/workspaces/$($workspaceid)/SqlDatabases).value
        $databaseid = $databases.Where({$_.displayName -eq $body.displayName}).id
    }

    # 3. List all SQL databases in a Fabric workspace

    Write-Host 'Listing databases in workspace.'

    Invoke-RestMethod -Headers $headers -Uri https://api.fabric.microsoft.com/v1/workspaces/$($workspaceid)/items?type=SQlDatabase | select -ExpandProperty Value | ft

    $databaseProperties = (Invoke-RestMethod -Headers $headers -Uri https://api.fabric.microsoft.com/v1/workspaces/$($workspaceid)/SqlDatabases/$($databaseid) | select -ExpandProperty Properties)

    #4. Connnect to the database and create a table

    Write-Host 'Attempting to connect to the database.'

    sqlcmd.exe -S $databaseProperties.ServerFqdn -d $databaseProperties.DatabaseName -G -Q 'create table test2 
       ( 
       id int 
       )' 

    #5. Delete the database

    $parameters = @{
        Method="Delete"
        Headers=$headers
        ContentType="application/json"
        Body=($body | ConvertTo-Json)
        Uri = 'https://api.fabric.microsoft.com/v1/workspaces/' + $workspaceid + '/items/' + $databaseid
    }

    Invoke-RestMethod @parameters

    Write-Output 'Cleaned up:' $body.displayName
 
 } finally {
    # The following lines ensure that sensitive data is not left in memory.
    $headers = [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr)
    $parameters = [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr)
}

Související obsah