指定された顧客の構成ポリシーを更新する

[アーティクル]
09/11/2024

適用対象: パートナーセンター

指定した顧客の指定した構成ポリシーを更新する方法。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、スタンドアロンの App と App+User の両方の資格情報を使用した認証がサポートされています。
顧客 ID です (customer-tenant-id)。顧客の ID がわからない場合は、パートナーセンターで [顧客] ワークスペースを選択し、 次に顧客 の一覧から [顧客]、[ アカウント] の順に選択して、その ID を検索できます。顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。
ポリシー識別子。

C#

指定した顧客の既存の構成ポリシーを更新するには、次のコードスニペットに示すように、新しい ConfigurationPolicy オブジェクトをインスタンス化します。この新しいオブジェクトの値は、既存のオブジェクト内の対応する値を置き換えます。次に、顧客 ID を指定して IAggregatePartner.Customers.ById メソッドを呼び出して、指定した顧客に対する操作へのインターフェイスを取得します。次に、ポリシー ID を指定して ConfigurationPolicies.ById メソッドを呼び出して、指定されたポリシーの構成ポリシー操作へのインターフェイスを取得します。最後に、Patch メソッドまたは PatchAsync メソッドを呼び出して、構成ポリシーを更新します。

IAggregatePartner partnerOperations;
string selectedCustomerId;
string selectedConfigurationPolicyId;

ConfigurationPolicy configPolicyToBeUpdated = new ConfigurationPolicy()
{
    Name= "Test Config Policy",
    Id = selectedConfigurationPolicyId,
    PolicySettings = new List<PolicySettingsType>() {
        PolicySettingsType.OobeUserNotLocalAdmin,
        PolicySettingsType.RemoveOemPreinstalls }
};

ConfigurationPolicy updatedConfigurationPolicy =
    partnerOperations.Customers.ById(selectedCustomerId).ConfigurationPolicies.ById(selectedConfigurationPolicyId).Patch(configPolicyToBeUpdated);

サンプル: コンソールテストアプリ。 プロジェクト: パートナーセンター SDK サンプル クラス: UpdateConfigurationPolicy.cs

REST 要求

要求の構文

認証方法	要求 URI
PUT	{baseURL}/v1/customers/{customer-id}/policies/{policy-id} HTTP/1.1

URI パラメーター

要求を作成するときは、次のパスパラメーターを使用します。

名前	Type	必須	説明
customer-id	string	はい	顧客を識別する GUID 形式の文字列。
policy-id	string	はい	更新するポリシーを識別する GUID 形式の文字列。

要求ヘッダー

詳細については、「パートナーセンター REST ヘッダー」を参照してください。

[要求本文]

要求本文には、ポリシー情報を提供するオブジェクトが含まれている必要があります。

名前	Type	必須	更新可能	説明
id	string	はい	いいえ	ポリシーを識別する GUID 形式の文字列。
name	string	はい	はい	ポリシーのフレンドリ名。
category	string	はい	いいえ	ポリシーカテゴリ。
description	string	いいえ	はい	ポリシーの説明。
devicesAssigned	number	いいえ	いいえ	デバイスの数。
policySettings	文字列の配列	はい	はい	ポリシー設定: "none","remove_oem_preinstalls","oobe_user_not_local_admin","skip_express_settings","skip _oem_registration,"skip_eula"

要求の例

PUT https://api.partnercenter.microsoft.com/v1/customers/47021739-3426-40bf-9601-61b4b6d7c793/policies/56edf752-ee77-4fd8-b7f5-df1f74a3a9ac HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e88d014d-ab70-41de-90a0-f7fd1797267d
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Content-Length: 256
Content-Type: application/json
Host: api.partnercenter.microsoft.com

{
    "id": "56edf752-ee77-4fd8-b7f5-df1f74a3a9ac",
    "name": "Windows test policy",
    "category": "o_o_b_e",
    "description": "Test policy creation from API",
    "devicesAssigned": 0,
    "policySettings": ["skip_express_settings"]
}

REST 応答

成功した場合、応答本文には新しいポリシーの ConfigurationPolicy リソースが含まれます。

応答の成功とエラーのコード

各応答には、成功または失敗を示す HTTP ステータスコードと、追加のデバッグ情報が付属しています。このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワークトレースツールを使用します。完全な一覧については、パートナーセンターの REST エラーコードに関する記事を参照してください。

応答の例

HTTP/1.1 200 OK
Content-Length: 421
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: cb1fa1f3-1381-45d9-99c5-511e5d3efa7c
MS-CV: YrLe3w6BbUSMt1fi.0
MS-ServerId: 030020344
Date: Tue, 25 Jul 2017 18:10:29 GMT

{
    "id": "56edf752-ee77-4fd8-b7f5-df1f74a3a9ac",
    "name": "Windows test policy",
    "category": "o_o_b_e",
    "description": "Test policy creation from API",
    "devicesAssigned": 0,
    "policySettings": ["skip_express_settings"],
    "createdDate": "2017-01-01T00:00:00",
    "lastModifiedDate": "2017-07-25T18:10:15",
    "attributes": {
        "objectType": "ConfigurationPolicy"
    }
}

次の方法で共有