次の方法で共有


法的タグを管理する方法

この記事では、法的タグとは何か、および、その Azure Data Manager for Energy インスタンスでの管理方法について説明します。

法的タグ は、データ インジェストとエンタイトルメント サービスの法的ステータスを表すエンティティであり、データへのユーザー アクセスを定義します。 ユーザーはエンタイトルメントを使用してデータを管理するアクセス権を持つことができますが、法的タグを使用して特定の法的要件を満たす必要があります。 法的タグは、Azure Data Manager for Energy インスタンスにデータを取り込む方法を制御する必要なプロパティのコレクションです。

Azure Data Manager for Energy インスタンスでは、データ パーティション レベルで DefaultCountryCodes.json 構成ファイルに従って許可されている countryOfOrigin に対してのみ、法的タグを作成できます。 このファイルは、OSDU により定義されており、ユーザーは編集できません。

Azure Cloud Bash で curl コマンドを実行して、Azure Data Manager for Energy インスタンスの特定のデータ パーティションの法的タグを作成します。

    curl --location --request POST 'https://<URI>/api/legal/v1/legaltags' \
    --header 'data-partition-id: <data-partition-id>' \
    --header 'Authorization: Bearer <access_token>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "name": "<legal-tag-name>",
        "description": "<legal-tag-description>",
        "properties": {
            "contractId": "<contract-id>",
            "countryOfOrigin": ["<country-of-origin>"],
            "dataType": "<data-type>",
            "expirationDate": "<expiration-ID>",
            "exportClassification": "<export-classification>",
            "originator": "<originator>",
            "personalData": "<personal-data>",
            "securityClassification": "Public"
        }
    }'

要求のサンプル

"dp1" という名前のデータ パーティションを持つ medstest という名前の Azure Data Manager for Energy インスタンスについて考えてみましょう。

    curl --location --request POST 'https://medstest.energy.azure.com/api/legal/v1/legaltags' \
    --header 'data-partition-id: medstest-dp1' \
    --header 'Authorization: Bearer  eyxxxxxxx.........................' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "name": "medstest-dp1-legal-tag",
        "description": "Azure Data Manager for Energy Legal Tag",
        "properties": {
            "contractId": "A1234",
            "countryOfOrigin": ["US"],
            "dataType": "Public Domain Data",
            "expirationDate": "2099-01-25",
            "exportClassification": "EAR99",
            "originator": "MyCompany",
            "personalData": "No Personal Data",
            "securityClassification": "Public"
        }
    }'

サンプル応答

    {
        "name": "medsStest-dp1-legal-tag",
        "description": "Azure Data Manager for Energy Legal Tag",
        "properties": {
        "countryOfOrigin": [
            "US"
        ],
        "contractId": "A1234",
        "expirationDate": "2099-01-25",
        "originator": "MyCompany",
        "dataType": "Public Domain Data",
        "securityClassification": "Public",
        "personalData": "No Personal Data",
        "exportClassification": "EAR99"
    }
}

発信元の国は ISO Alpha2 形式に従う必要があります。

この API は、 data-partition-id がまだ存在しない場合、これを内部的に追加します。 たとえば、要求の名前が legal-tag の場合、作成される法的タグ名の <instancename>-<data-partition-id>-legal-tag になります。

    curl --location --request POST 'https://medstest.energy.azure.com/api/legal/v1/legaltags' \
    --header 'data-partition-id: medstest-dp1' \
    --header 'Authorization: Bearer  eyxxxxxxx.........................' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "name": "legal-tag",
        "description": "Azure Data Manager for Energy Legal Tag",
        "properties": {
            "contractId": "A1234",
            "countryOfOrigin": ["US"],
            "dataType": "Public Domain Data",
            "expirationDate": "2099-01-25",
            "exportClassification": "EAR99",
            "originator": "MyCompany",
            "personalData": "No Personal Data",
            "securityClassification": "Public"
        }
    }'

サンプルの応答には data-partition-id が法的なタグ名に追加されています。

    {
        "name": "medstest-dp1-legal-tag",
        "description": "Azure Data Manager for Energy Legal Tag",
        "properties": {
        "countryOfOrigin": [
            "US"
        ],
        "contractId": "A1234",
        "expirationDate": "2099-01-25",
        "originator": "MyCompany",
        "dataType": "Public Domain Data",
        "securityClassification": "Public",
        "personalData": "No Personal Data",
        "exportClassification": "EAR99"
    }
}

Azure Cloud Bash で curl コマンドを実行して、Azure Data Manager for Energy インスタンスのデータ パーティションに関連付けられている法的タグを取得します。

    curl --location --request GET 'https://<URI>/api/legal/v1/legaltags/<legal-tag-name>' \
    --header 'data-partition-id: <data-partition-id>' \
    --header 'Authorization: Bearer <access_token>'

要求のサンプル

"dp1" という名前のデータ パーティションを持つ medstest という名前の Azure Data Manager for Energy インスタンスについて考えてみましょう。

    curl --location --request GET 'https://medstest.energy.azure.com/api/legal/v1/legaltags/medstest-dp1-legal-tag' \
    --header 'data-partition-id: medstest-dp1' \
    --header 'Authorization: Bearer eyxxxxxxx.........................'

サンプル応答

    {
    "name": "medstest-dp1-legal-tag",
    "description": "Azure Data Manager for Energy Legal Tag",
    "properties": {
        "countryOfOrigin": [
        "US"
        ],
        "contractId": "A1234",
        "expirationDate": "2099-01-25",
        "originator": "MyCompany",
        "dataType": "Public Domain Data",
        "securityClassification": "Public",
        "personalData": "No Personal Data",
        "exportClassification": "EAR99"
    }
    }

次のステップ