deviceEnrollmentWindowsHelloForBusinessConfiguration の作成
[アーティクル] 08/01/2024
13 人の共同作成者
フィードバック
この記事の内容
名前空間: microsoft.graph
注: Intune 用 Microsoft Graph API には、テナントの有効な Intune ライセンス が必要です。
新しい deviceEnrollmentWindowsHelloForBusinessConfiguration オブジェクトを作成します。
この API は、次の国内クラウド展開 で使用できます。
グローバル サービス
米国政府機関 L4
米国政府機関 L5 (DOD)
21Vianet が運営する中国
✅
✅
✅
✅
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可 」を参照してください。
アクセス許可の種類
アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)
DeviceManagementServiceConfig.ReadWrite.All、DeviceManagementConfiguration.ReadWrite.All
委任 (個人用 Microsoft アカウント)
サポートされていません。
アプリケーション
DeviceManagementServiceConfig.ReadWrite.All、DeviceManagementConfiguration.ReadWrite.All
HTTP 要求
POST /deviceManagement/deviceEnrollmentConfigurations
ヘッダー
値
Authorization
ベアラー {token}。 必須です。
認証と認可 についての詳細をご覧ください。
承諾
application/json
要求本文
要求本文で、deviceEnrollmentWindowsHelloForBusinessConfiguration オブジェクトの JSON 表記を指定します。
次の表に、deviceEnrollmentWindowsHelloForBusinessConfiguration の作成時に必要なプロパティを示します。
プロパティ
型
説明
id
String
deviceEnrollmentConfiguration から継承されたアカウントの一意識別子
displayName
String
deviceEnrollmentConfiguration から継承されたデバイス登録構成の表示名
説明
String
deviceEnrollmentConfiguration から継承されたデバイス登録構成の説明
priority
Int32
優先度は、登録構成が割り当てられている複数のグループにユーザーが存在する場合に使用されます。 ユーザーは、優先度が最も低い値の構成にのみ適用されます。
deviceEnrollmentConfiguration からの継承
createdDateTime
DateTimeOffset
deviceEnrollmentConfiguration から継承されたデバイス登録構成の UTC で作成された日付時刻
lastModifiedDateTime
DateTimeOffset
デバイス登録構成の UTC での最終変更日時 deviceEnrollmentConfiguration から継承
version
Int32
deviceEnrollmentConfiguration から継承されたデバイス登録構成のバージョン
pinMinimumLength
Int32
Windows Hello for Business PIN に必要な最小文字数を制御します。 この値は、4 ~ 127 の範囲で、最大 PIN に設定されている値以下である必要があります。
pinMaximumLength
Int32
Windows Hello for Business PIN に許可される最大文字数を制御します。 この値は、4 ~ 127 の範囲で指定する必要があります。 この値は、最小 PIN に設定されている値以上である必要があります。
pinUppercaseCharactersUsage
windowsHelloForBusinessPinUsage
Windows Hello for Business PIN で大文字を使用する機能を制御します。 許可すると大文字を使用できます。一方、必ず存在します。 [許可しない] に設定した場合、大文字は許可されません。 可能な値は allowed
、required
、disallowed
です。
pinLowercaseCharactersUsage
windowsHelloForBusinessPinUsage
Windows Hello for Business PIN で小文字を使用する機能を制御します。 許可すると小文字を使用できます。一方、必ず存在します。 [許可しない] に設定した場合、小文字は許可されません。 可能な値は allowed
、required
、disallowed
です。
pinSpecialCharactersUsage
windowsHelloForBusinessPinUsage
Windows Hello for Business PIN で特殊文字を使用する機能を制御します。 Allowed は特殊文字の使用を許可しますが、Required はそれらが存在することを保証します。 [許可なし] に設定した場合、特殊文字は許可されません。 可能な値は allowed
、required
、disallowed
です。
state
enablement
デバイスをWindows Hello for Business用に構成するかどうかを制御します。 を無効に設定した場合、必要に応じて Azure Active Directory 参加済み携帯電話を除き、ユーザーはWindows Hello for Businessをプロビジョニングできません。 [未構成] に設定した場合、Intuneはクライアントの既定値をオーバーライドしません。 可能な値は notConfigured
、enabled
、disabled
です。
securityDeviceRequired
ブール型
プロビジョニングWindows Hello for Businessにトラステッド プラットフォーム モジュール (TPM) を必要とするかどうかを制御します。 TPM には、保存されているデータを他のデバイスで使用できないという追加のセキュリティ上の利点があります。 False に設定すると、使用可能な TPM がない場合でも、すべてのデバイスでWindows Hello for Businessをプロビジョニングできます。
unlockWithBiometricsEnabled
ブール型
Windows Hello for Business PIN の代わりに、顔や指紋などの生体認証ジェスチャの使用を制御します。 False に設定した場合、生体認証ジェスチャは許可されません。 エラーが発生した場合でも、ユーザーは PIN をバックアップとして構成する必要があります。
remotePassportEnabled
ブール型
リモート Windows Hello for Businessの使用を制御します。 リモート Windows Hello for Businessを使用すると、ポータブルで登録済みのデバイスをデスクトップ認証のコンパニオンとして使用できます。 デスクトップは Azure AD 参加済みで、コンパニオン デバイスには Windows Hello for Business PIN が必要です。
pinPreviousBlockCount
Int32
ユーザーが過去の PIN を使用できないようにする機能を制御します。 これは 0 から 50 の間で設定する必要があります。これには、ユーザーの現在の PIN が含まれます。 0 に設定した場合、以前の PIN は格納されません。 PIN のリセットによって PIN 履歴は保持されません。
pinExpirationInDays
Int32
システムがユーザーに変更を要求する前に PIN を使用できる期間 (日数) を制御します。 これは、0 から 730 までの範囲で設定する必要があります。 0 に設定すると、ユーザーの PIN は期限切れになりません
enhancedBiometricsState
enablement
それをサポートするデバイスで顔認識にスプーフィング対策機能を使用する機能を制御します。 を無効に設定した場合、なりすまし対策機能は許可されません。 [未構成] に設定されている場合、ユーザーはスプーフィング対策を使用するかどうかを選択できます。 可能な値は notConfigured
、enabled
、disabled
です。
応答
成功した場合、このメソッドは 201 Created
応答コードと、応答本文で deviceEnrollmentWindowsHelloForBusinessConfiguration オブジェクトを返します。
例
要求
以下は、要求の例です。
POST https://graph.microsoft.com/v1.0/deviceManagement/deviceEnrollmentConfigurations
Content-type: application/json
Content-length: 629
{
"@odata.type": "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",
"displayName": "Display Name value",
"description": "Description value",
"priority": 8,
"version": 7,
"pinMinimumLength": 0,
"pinMaximumLength": 0,
"pinUppercaseCharactersUsage": "required",
"pinLowercaseCharactersUsage": "required",
"pinSpecialCharactersUsage": "required",
"state": "enabled",
"securityDeviceRequired": true,
"unlockWithBiometricsEnabled": true,
"remotePassportEnabled": true,
"pinPreviousBlockCount": 5,
"pinExpirationInDays": 3,
"enhancedBiometricsState": "enabled"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new DeviceEnrollmentWindowsHelloForBusinessConfiguration
{
OdataType = "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",
DisplayName = "Display Name value",
Description = "Description value",
Priority = 8,
Version = 7,
PinMinimumLength = 0,
PinMaximumLength = 0,
PinUppercaseCharactersUsage = WindowsHelloForBusinessPinUsage.Required,
PinLowercaseCharactersUsage = WindowsHelloForBusinessPinUsage.Required,
PinSpecialCharactersUsage = WindowsHelloForBusinessPinUsage.Required,
State = Enablement.Enabled,
SecurityDeviceRequired = true,
UnlockWithBiometricsEnabled = true,
RemotePassportEnabled = true,
PinPreviousBlockCount = 5,
PinExpirationInDays = 3,
EnhancedBiometricsState = Enablement.Enabled,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.DeviceEnrollmentConfigurations.PostAsync(requestBody);
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
mgc device-management device-enrollment-configurations create --body '{\
"@odata.type": "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",\
"displayName": "Display Name value",\
"description": "Description value",\
"priority": 8,\
"version": 7,\
"pinMinimumLength": 0,\
"pinMaximumLength": 0,\
"pinUppercaseCharactersUsage": "required",\
"pinLowercaseCharactersUsage": "required",\
"pinSpecialCharactersUsage": "required",\
"state": "enabled",\
"securityDeviceRequired": true,\
"unlockWithBiometricsEnabled": true,\
"remotePassportEnabled": true,\
"pinPreviousBlockCount": 5,\
"pinExpirationInDays": 3,\
"enhancedBiometricsState": "enabled"\
}\
'
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewDeviceEnrollmentConfiguration()
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName)
description := "Description value"
requestBody.SetDescription(&description)
priority := int32(8)
requestBody.SetPriority(&priority)
version := int32(7)
requestBody.SetVersion(&version)
pinMinimumLength := int32(0)
requestBody.SetPinMinimumLength(&pinMinimumLength)
pinMaximumLength := int32(0)
requestBody.SetPinMaximumLength(&pinMaximumLength)
pinUppercaseCharactersUsage := graphmodels.REQUIRED_WINDOWSHELLOFORBUSINESSPINUSAGE
requestBody.SetPinUppercaseCharactersUsage(&pinUppercaseCharactersUsage)
pinLowercaseCharactersUsage := graphmodels.REQUIRED_WINDOWSHELLOFORBUSINESSPINUSAGE
requestBody.SetPinLowercaseCharactersUsage(&pinLowercaseCharactersUsage)
pinSpecialCharactersUsage := graphmodels.REQUIRED_WINDOWSHELLOFORBUSINESSPINUSAGE
requestBody.SetPinSpecialCharactersUsage(&pinSpecialCharactersUsage)
state := graphmodels.ENABLED_ENABLEMENT
requestBody.SetState(&state)
securityDeviceRequired := true
requestBody.SetSecurityDeviceRequired(&securityDeviceRequired)
unlockWithBiometricsEnabled := true
requestBody.SetUnlockWithBiometricsEnabled(&unlockWithBiometricsEnabled)
remotePassportEnabled := true
requestBody.SetRemotePassportEnabled(&remotePassportEnabled)
pinPreviousBlockCount := int32(5)
requestBody.SetPinPreviousBlockCount(&pinPreviousBlockCount)
pinExpirationInDays := int32(3)
requestBody.SetPinExpirationInDays(&pinExpirationInDays)
enhancedBiometricsState := graphmodels.ENABLED_ENABLEMENT
requestBody.SetEnhancedBiometricsState(&enhancedBiometricsState)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
deviceEnrollmentConfigurations, err := graphClient.DeviceManagement().DeviceEnrollmentConfigurations().Post(context.Background(), requestBody, nil)
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
DeviceEnrollmentWindowsHelloForBusinessConfiguration deviceEnrollmentConfiguration = new DeviceEnrollmentWindowsHelloForBusinessConfiguration();
deviceEnrollmentConfiguration.setOdataType("#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration");
deviceEnrollmentConfiguration.setDisplayName("Display Name value");
deviceEnrollmentConfiguration.setDescription("Description value");
deviceEnrollmentConfiguration.setPriority(8);
deviceEnrollmentConfiguration.setVersion(7);
deviceEnrollmentConfiguration.setPinMinimumLength(0);
deviceEnrollmentConfiguration.setPinMaximumLength(0);
deviceEnrollmentConfiguration.setPinUppercaseCharactersUsage(WindowsHelloForBusinessPinUsage.Required);
deviceEnrollmentConfiguration.setPinLowercaseCharactersUsage(WindowsHelloForBusinessPinUsage.Required);
deviceEnrollmentConfiguration.setPinSpecialCharactersUsage(WindowsHelloForBusinessPinUsage.Required);
deviceEnrollmentConfiguration.setState(Enablement.Enabled);
deviceEnrollmentConfiguration.setSecurityDeviceRequired(true);
deviceEnrollmentConfiguration.setUnlockWithBiometricsEnabled(true);
deviceEnrollmentConfiguration.setRemotePassportEnabled(true);
deviceEnrollmentConfiguration.setPinPreviousBlockCount(5);
deviceEnrollmentConfiguration.setPinExpirationInDays(3);
deviceEnrollmentConfiguration.setEnhancedBiometricsState(Enablement.Enabled);
DeviceEnrollmentConfiguration result = graphClient.deviceManagement().deviceEnrollmentConfigurations().post(deviceEnrollmentConfiguration);
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
const deviceEnrollmentConfiguration = {
'@odata.type': '#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration',
displayName: 'Display Name value',
description: 'Description value',
priority: 8,
version: 7,
pinMinimumLength: 0,
pinMaximumLength: 0,
pinUppercaseCharactersUsage: 'required',
pinLowercaseCharactersUsage: 'required',
pinSpecialCharactersUsage: 'required',
state: 'enabled',
securityDeviceRequired: true,
unlockWithBiometricsEnabled: true,
remotePassportEnabled: true,
pinPreviousBlockCount: 5,
pinExpirationInDays: 3,
enhancedBiometricsState: 'enabled'
};
await client.api('/deviceManagement/deviceEnrollmentConfigurations')
.post(deviceEnrollmentConfiguration);
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\DeviceEnrollmentWindowsHelloForBusinessConfiguration;
use Microsoft\Graph\Generated\Models\WindowsHelloForBusinessPinUsage;
use Microsoft\Graph\Generated\Models\Enablement;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new DeviceEnrollmentWindowsHelloForBusinessConfiguration();
$requestBody->setOdataType('#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration');
$requestBody->setDisplayName('Display Name value');
$requestBody->setDescription('Description value');
$requestBody->setPriority(8);
$requestBody->setVersion(7);
$requestBody->setPinMinimumLength(0);
$requestBody->setPinMaximumLength(0);
$requestBody->setPinUppercaseCharactersUsage(new WindowsHelloForBusinessPinUsage('required'));
$requestBody->setPinLowercaseCharactersUsage(new WindowsHelloForBusinessPinUsage('required'));
$requestBody->setPinSpecialCharactersUsage(new WindowsHelloForBusinessPinUsage('required'));
$requestBody->setState(new Enablement('enabled'));
$requestBody->setSecurityDeviceRequired(true);
$requestBody->setUnlockWithBiometricsEnabled(true);
$requestBody->setRemotePassportEnabled(true);
$requestBody->setPinPreviousBlockCount(5);
$requestBody->setPinExpirationInDays(3);
$requestBody->setEnhancedBiometricsState(new Enablement('enabled'));
$result = $graphServiceClient->deviceManagement()->deviceEnrollmentConfigurations()->post($requestBody)->wait();
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
Import-Module Microsoft.Graph.DeviceManagement.Enrollment
$params = @{
"@odata.type" = "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration"
displayName = "Display Name value"
description = "Description value"
priority = 8
version = 7
pinMinimumLength =
pinMaximumLength =
pinUppercaseCharactersUsage = "required"
pinLowercaseCharactersUsage = "required"
pinSpecialCharactersUsage = "required"
state = "enabled"
securityDeviceRequired = $true
unlockWithBiometricsEnabled = $true
remotePassportEnabled = $true
pinPreviousBlockCount =
pinExpirationInDays =
enhancedBiometricsState = "enabled"
}
New-MgDeviceManagementDeviceEnrollmentConfiguration -BodyParameter $params
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.device_enrollment_windows_hello_for_business_configuration import DeviceEnrollmentWindowsHelloForBusinessConfiguration
from msgraph.generated.models.windows_hello_for_business_pin_usage import WindowsHelloForBusinessPinUsage
from msgraph.generated.models.enablement import Enablement
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = DeviceEnrollmentWindowsHelloForBusinessConfiguration(
odata_type = "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",
display_name = "Display Name value",
description = "Description value",
priority = 8,
version = 7,
pin_minimum_length = 0,
pin_maximum_length = 0,
pin_uppercase_characters_usage = WindowsHelloForBusinessPinUsage.Required,
pin_lowercase_characters_usage = WindowsHelloForBusinessPinUsage.Required,
pin_special_characters_usage = WindowsHelloForBusinessPinUsage.Required,
state = Enablement.Enabled,
security_device_required = True,
unlock_with_biometrics_enabled = True,
remote_passport_enabled = True,
pin_previous_block_count = 5,
pin_expiration_in_days = 3,
enhanced_biometrics_state = Enablement.Enabled,
)
result = await graph_client.device_management.device_enrollment_configurations.post(request_body)
プロジェクトに SDK を追加 し、authProvider インスタンスを作成 する方法の詳細については、SDK のドキュメント を参照してください。
応答
以下は、応答の例です。 注: 簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。 実際の呼び出しではすべてのプロパティが返されます。
HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 801
{
"@odata.type": "#microsoft.graph.deviceEnrollmentWindowsHelloForBusinessConfiguration",
"id": "3068e0cd-e0cd-3068-cde0-6830cde06830",
"displayName": "Display Name value",
"description": "Description value",
"priority": 8,
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"version": 7,
"pinMinimumLength": 0,
"pinMaximumLength": 0,
"pinUppercaseCharactersUsage": "required",
"pinLowercaseCharactersUsage": "required",
"pinSpecialCharactersUsage": "required",
"state": "enabled",
"securityDeviceRequired": true,
"unlockWithBiometricsEnabled": true,
"remotePassportEnabled": true,
"pinPreviousBlockCount": 5,
"pinExpirationInDays": 3,
"enhancedBiometricsState": "enabled"
}