ZIP ファイルで RSAT 証明書をフェッチする

Lifecycle Services Environment API を使用して、Microsoft Dynamics Lifecycle Services を通じて環境の Regression Suite Automation Tool (RSAT) 証明書バンドルをフェッチできます。 この API は、プライベート証明書パスワード用の Base 64 エンコードされた zip ファイルと Base 64 エンコードされたパスワードを返します。

この zip の使用についての完全なプロセスは、Regression Suite Automation Tool のインストールとコンフィギュレーション ページで確認できます。

Permissions

API アプリケーション

この API を呼び出すには、次のアクセス許可の 1 つが必要です。 アクセス許可およびその選択方法の詳細については、データベース移動 API - 認証を参照してください。

ライフサイクル サービス

ライフサイクル サービスでは、API OAuth 認証で使用されるユーザーをプロジェクト所有者または環境管理者としてプロジェクトに追加する必要があります。 ユーザーは、プロジェクトへの招待を受け入れる必要があります。

HTTP 要求

次の GET エンドポイントを使用して、環境の RSAT 証明書用の zip ファイルをフェッチします。

環境別の RSAT 証明書をフェッチする

GET /environmentinfo/v1/rsatdownload/project/{projectId}/environment/{environmentId}

要求ヘッダー

HTTP 要求のヘッダーで次のヘッダー値を使用します。

要求本文

このメソッドには、要求本文を指定しません。

応答

HTTP

正しく認証されていない場合を除き、応答は常に「200 OK」応答になります。 アクションの成功または失敗を検証するには、IsSuccess プロパティを使用してください。

データ

応答の例

プロジェクト レベルの要求に対する正常な応答

{
    "Data": {
        "CertificateZipEncoded": "<base 64-encoded zip>",
        "CertificateSecretEncoded": "<base 64-encoded password>",
        "CertificateThumbprint": "AA11BB22CC33DD44EE55FF66AA77BB88CC99DD00",
        "ExpirationDateTimeUTC": "Sunday, September 4, 2022 4:00:00 AM",
        "ExpirationISODateTimeUTC": "2022-09-04T04:00:00Z",
        "Filename": "RSATCertificate_TestEnv1_20210805-100102.zip"
    },
    "IsSuccess": true,
    "OperationActivityId": "2234bff0-432d-478b-a5ac-1ccb529ee698",
    "ErrorMessage": null,
    "VersionEOL": "9999-12-31T23:59:59.9999999"
}

PowerShell を使用したデータ解析

次のサンプル スクリプトは、Lifecycle Services API と通信して、RSAT 証明書の zip ファイルをローカル コンピューターにダウンロードします。 プライベート証明書のパスワードがコンソール ウィンドウに表示されます。 アクセス トークンを指定する必要があります。

# Basic Lifecycle Services API RSAT certificate zip download script
#
# This will download the RSAT certificate bundle for an environment
# to the current directory and display the private certificate's password
# in the console.
#
# The user used in the API authentication must be added to the
# project as an Environment Admin or Project Owner

# Configuration
$accessToken = "{access token string}";
$projId = {project id integer};
$envId = "{environment id GUID}"
$baseLCSAPI = "lcsapi.lcs.dynamics.com";

$url = "https://$baseLCSAPI/environmentinfo/v1/rsatdownload/project/$projId/environment/$envId"
 
$headers = @{
    "Authorization" = "Bearer $accessToken"
    "x-ms-version" = "2017-09-15"
    "Content-Type" = "application/json"
}

# Reset variable between executions
$certificateResponse = $null 
$shouldRetry = $false

do {
    $shouldRetry = $false

    try {
        # GET request to Lifecycle Services API
        $certificateResponse = Invoke-RestMethod $url -Method 'GET' -Headers $headers
    } catch {
        # Check if this is a HTTP 429 error
        if ($_.Exception.Response.StatusCode.value__ -eq 429) {

            # Too many requests for this environment, wait and retry
            $shouldRetry = $true
            $retrySeconds = [int]$_.Exception.Response.Headers['Retry-After']
            Write-Host "Too many requests - Retrying in $retrySeconds seconds"
            Start-Sleep -Seconds $retrySeconds
        } else {
            throw
        }
    }
} while($shouldRetry)

if ((-not $certificateResponse.IsSuccess) -or ($certificateResponse.Data -eq $null)) {
    Write-Host $certificateResponse.ErrorMessage
    throw
}

$fileName = $certificateResponse.Data.Filename
$certificateZip = [System.Convert]::FromBase64String($certificateResponse.Data.CertificateZipEncoded)
$certificateSecret = [System.Text.Encoding]::ASCII.GetString(
                            [System.Convert]::FromBase64String(
                                $certificateResponse.Data.CertificateSecretEncoded))

# Save the zip to the local disk.
# Could add unzipping in memory and install certificates to correct local certificate stores.
Set-Content $fileName -Value $certificateZip -Encoding Byte

Write-Host "Certificate bundle downloaded to $fileName with private certificate password $certificateSecret"

レート制限

要求の負荷分散を向上させるために、この API にはレート制限があります。 これらの制限は、Lifecycle Services Web インターフェイスとも共有されます。

• 各環境に対して 1 分間で 1 回の呼び出し