Tutoriel : créer, mettre à jour et répertorier les paramètres de gestion environnement (version préliminaire)

[Cet article fait partie de la documentation préliminaire et peut faire l’objet de modifications.]

Ce didacticiel montre comment utiliser l’API (version préliminaire) pour créer, mettre à jour et répertorier les paramètres de gestion environnement. Power Platform

Dans ce didacticiel, découvrez comment :

1. Authentifiez-vous à l’aide de l’API Power Platform .
2. Créer une nouvelle valeur de paramètre.
3. Répertoriez toutes les valeurs des paramètres de gestion pour environnement.
4. Mettre à jour une valeur de paramètre.

À titre d’exemple de ce scénario, un client peut souhaiter activer les restrictions IP de signature d’accès partagé au stockage (SAS) et la journalisation des appels SAS. ...

Important

• Cette fonctionnalité est en version préliminaire.
• Les fonctionnalités en version préliminaire ne sont pas destinées à une utilisation en production et peuvent être restreintes. Ces fonctionnalités sont disponibles avant une publication officielle afin que les clients puissent y accéder de façon anticipée et fournir des commentaires.

Étape 1. Authentifier à l’aide de l’API Power Platform

Utilisez le script PowerShell suivant pour authentifier avec l’API Power Platform.

Import-Module "MSAL.PS"
$AuthResult = Get-MsalToken -ClientId '49676daf-ff23-4aac-adcc-55472d4e2ce0' -Scope 'https://api.powerplatform.com/.default'
$Headers = @{Authorization = "Bearer $($AuthResult.AccessToken)"}

Étape 2. Créer une nouvelle valeur de paramètre

Utilisez le script PowerShell suivant pour créer une nouvelle valeur de paramètre pour les restrictions IP de la signature d’accès partagé de stockage (SAS) et la capacité de journalisation d’audit associée. Ces deux paramètres sont désactivés, cependant, nous les mettrons à jour ultérieurement pour les activer.

#Set your environment ID
$environmentId = "ENV_ID_HERE"

# Please uncomment the values that need to be updated
$EnvironmentManagementSettings = @{
    "EnableIpBasedStorageAccessSignatureRule" = $false
    "LoggingEnabledForIpBasedStorageAccessSignature" = $false
}

$body = $json = $EnvironmentManagementSettings | ConvertTo-Json

try 
{
    # Create the new setting value
    Write-Host "Invoking Create Management Setting for Environment $environmentId with body $body"
    $apiResponse = Invoke-WebRequest -Method Post -Uri "https://api.powerplatform.com/environmentmanagement/environments/$environmentId/settings/?api-version=2022-03-01-preview" -Headers $Headers -Body $body

    Write-Host "Operation Status: $apiResponse.StatusDescription"
} 
catch 
{
    # Dig into the exception to get the Response details.
    Write-Host "Response CorrelationId:" $_.Exception.Response.Headers["x-ms-correlation-id"]
    Write-Host "StatusCode:" $_.Exception.Response.StatusCode.value__ 
    Write-Host "StatusDescription:" $_.Exception.Response.StatusDescription
    $result = $_.Exception.Response.GetResponseStream()
        $reader = New-Object System.IO.StreamReader($result)
        $reader.BaseStream.Position = 0
        $reader.DiscardBufferedData()
        $responseBody = $reader.ReadToEnd();

        Write-Host $responseBody
}

Pour en savoir plus sur la référence API, consultez la section Power Platform Paramètres de gestion environnement - Créer des paramètres de gestion environnement .

Étape 3. Répertoriez tous les paramètres de gestion pour le environnement

Utilisez le script PowerShell suivant pour répertorier tous les paramètres précédemment créés pour ce environnement.

#Set your environment ID
$environmentId = "ENV_ID_HERE"

try 
{
    # Create the new setting value
    Write-Host "Invoking List Management Settings for Environment $environmentId"
    $apiResponse = Invoke-WebRequest -Method Get -Uri "https://api.powerplatform.com/environmentmanagement/environments/$environmentId/settings/?api-version=2022-03-01-preview&$select=EnableIpBasedStorageAccessSignatureRule,LoggingEnabledForIpBasedStorageAccessSignature" -Headers $Headers

    Write-Host $apiResponse
} 
catch 
{
    # Dig into the exception to get the Response details.
    Write-Host "Response CorrelationId:" $_.Exception.Response.Headers["x-ms-correlation-id"]
    Write-Host "StatusCode:" $_.Exception.Response.StatusCode.value__ 
    Write-Host "StatusDescription:" $_.Exception.Response.StatusDescription
    $result = $_.Exception.Response.GetResponseStream()
        $reader = New-Object System.IO.StreamReader($result)
        $reader.BaseStream.Position = 0
        $reader.DiscardBufferedData()
        $responseBody = $reader.ReadToEnd();

        Write-Host $responseBody
}

Pour en savoir plus sur la référence API, consultez la section Power Platform Paramètres de gestion environnement - Liste des paramètres de gestion environnement .

Étape 4. Mettre à jour une valeur de paramètre

Utilisez le script PowerShell suivant pour mettre à jour une valeur de paramètre précédemment définie. Dans ce étape, vous activez la journalisation pour la signature d’accès partagé au stockage (SAS).

#Set your environment ID
$environmentId = "ENV_ID_HERE"

# Please uncomment the values that need to be updated
$EnvironmentManagementSettings = @{
    "LoggingEnabledForIpBasedStorageAccessSignature" = $true
}

$body = $json = $EnvironmentManagementSettings | ConvertTo-Json

try 
{
    # Updating the setting value
    Write-Host "Invoking Update Management Setting for Environment $environmentId with body $body"
    $apiResponse = Invoke-WebRequest -Method Patch -Uri "https://api.powerplatform.com/environmentmanagement/environments/$environmentId/settings/?api-version=2022-03-01-preview" -Headers $Headers -Body $body

    Write-Host "Operation Status: $apiResponse.StatusDescription"
} 
catch 
{
    # Dig into the exception to get the Response details.
    Write-Host "Response CorrelationId:" $_.Exception.Response.Headers["x-ms-correlation-id"]
    Write-Host "StatusCode:" $_.Exception.Response.StatusCode.value__ 
    Write-Host "StatusDescription:" $_.Exception.Response.StatusDescription
    $result = $_.Exception.Response.GetResponseStream()
        $reader = New-Object System.IO.StreamReader($result)
        $reader.BaseStream.Position = 0
        $reader.DiscardBufferedData()
        $responseBody = $reader.ReadToEnd();

        Write-Host $responseBody
}

Pour en savoir plus sur la référence API, consultez la section Power Platform Paramètres de gestion environnement - Mise à jour des paramètres de gestion environnement .

Informations associées

environnement Paramètres de gestion