Del via

Opprette en SQL-database i Microsoft Fabric via REST API

  • Artikkel

Gjelder for:✅SQL-database i Microsoft Fabric

Fabric-plattformen har et rikt sett med REST-API-er som kan brukes til å distribuere og administrere ressurser. Disse API-ene kan brukes til å distribuere Fabric SQL-databaser. Denne artikkelen og eksempelskriptet viser et grunnleggende PowerShell-skript som kan brukes til å distribuere en Fabric SQL-database og legge til data i den.

Forutsetning

Opprette en ny SQL-database via REST-API

Dette eksempelskriptet bruker Connect-AzAccountet alias az login for å be om legitimasjon. Den bruker denne legitimasjonen til å hente et tilgangstoken som skal brukes for REST-API-kall. SQLCMD bruker konteksten for kontoen som ble gitt til Connect-AzAccount.

Skriptet oppretter en database med navnet påloggede brukerens alias og datoen. REST-API-en returnerer for øyeblikket ikke en status, så vi må gjenta og kontrollere at databasen skal opprettes. Når databasen er opprettet, brukes SQLCMD til å opprette noen objekter og deretter spørre etter deres eksistens. Til slutt sletter vi databasen.

Erstatt <your workspace id> med ID-en for fabric-arbeidsområdet i skriptet nedenfor. Du kan enkelt finne ID-en for et arbeidsområde i nettadressen, det er den unike strengen i to / tegn etter /groups/ i nettleservinduet. Eksempel: 11aa111-a11a-1111-1abc-aa1111aaaa i https://fabric.microsoft.com/groups/11aa111-a11a-1111-1abc-aa1111aaaa/.

Dette skriptet demonstrerer:

  1. Hent et tilgangstoken ved hjelp av Get-AzAccessToken og konvertere det fra en sikker streng. Hvis du bruker PowerShell 7, er ConvertFrom-SecureString også et alternativ.
  2. Opprett en ny SQL-database ved hjelp av Elementer – Opprett element-API-.
  3. Vis alle SQL-databaser i et stoffarbeidsområde.
  4. Koble til databasen med SQLCMD- for å kjøre et skript for å opprette et objekt.
  5. Slett databasen ved hjelp av Elementer - Slett element-API-.
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)
}

Relatert innhold