Criar deviceTemplate

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Criar um novo deviceTemplate usado para identificar atributos e gerenciar um grupo de dispositivos com características semelhantes.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) DeviceTemplate.Create DeviceTemplate.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application DeviceTemplate.Create DeviceTemplate.ReadWrite.All

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Administrador de Dispositivo de Nuvem
  • Administrador de Dispositivo IoT
  • Usuários - proprietários do objeto de modelo de dispositivo

Solicitação HTTP

POST /directory/templates/deviceTemplates

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto deviceTemplate .

Você pode especificar as propriedades a seguir ao criar um deviceTemplate.

Propriedade Tipo Descrição
deviceAuthority Cadeia de caracteres Um nome definido pelo locatário para a parte responsável por provisionar e gerenciar dispositivos no locatário do Microsoft Entra. Por exemplo, a Tailwind Traders (o fabricante) fabrica câmeras de segurança instaladas em prédios de clientes e gerenciadas pela Lakeshore Retail (a autoridade do dispositivo). Esse valor é fornecido ao cliente pela autoridade do dispositivo (fabricante ou revendedor). Obrigatório.
fabricante Cadeia de caracteres Nome do fabricante. Obrigatório.
modelo Cadeia de caracteres Nome do modelo. Obrigatório.
mutualTlsOauthConfigurationId Cadeia de caracteres ID do objeto do mutualTlsOauthConfiguration. Esse valor não será necessário se certificados autoassinados forem usados em vez de certificados raiz confiáveis. Opcional.
mutualTlsOauthConfigurationTenantId Cadeia de caracteres ID (ID do locatário para autoridade do dispositivo) do locatário que contém o mutualTlsOauthConfiguration. Esse valor não será necessário se certificados autoassinados forem usados em vez de certificados raiz confiáveis. Opcional.
operatingSystem Cadeia de caracteres Tipo de sistema operacional. Opcional.
owners@odata.bind String collection Lista de IDs para os proprietários adicionarem ao modelo de dispositivo. Há suporte apenas para os seguintes tipos directoryObject como proprietários: entidades de serviço, usuários ou aplicativos. Opcional.

Resposta

Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um objeto deviceTemplate no corpo da resposta. Se ocorrer uma falha de validação durante as etapas de validação do certificado, o método retornará um 400 Bad Request junto com a mensagem "Não é possível validar o certificado do dispositivo".

Para obter mais informações, consulte Tipos de recursos e respostas de erro do Microsoft Graph.

Exemplos

Exemplo 1: Criar um novo modelo de dispositivo

O exemplo a seguir mostra como criar um novo deviceTemplate.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/directory/templates/deviceTemplates
Content-Type: application/json
Content-length: 106

{
  "mutualTlsOauthConfigurationId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "mutualTlsOauthConfigurationTenantId": "00001111-aaaa-2222-bbbb-3333cccc4445",
  "deviceAuthority": "Lakeshore Retail",
  "manufacturer": "Tailwind Traders",
  "model": "DeepFreezerModelAB",
  "operatingSystem": "WindowsIoT"
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/templates/deviceTemplates/$entity",
  "id": "c0ff9329-3596-4ece-8aa9-3dd23a925356",
  "mutualTlsOauthConfigurationId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "mutualTlsOauthConfigurationTenantId": "00001111-aaaa-2222-bbbb-3333cccc4445",
  "deletedDateTime": null,
  "deviceAuthority": "Lakeshore Retail",
  "manufacturer": "Tailwind Traders",
  "model": "DeepFreezerModelAB",
  "operatingSystem": "WindowsIoT"
}

Exemplo 2: Criar um modelo de dispositivo com um proprietário

O exemplo a seguir mostra como criar um novo deviceTemplate com um proprietário.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/directory/templates/deviceTemplates
Content-Type: application/json
Content-length: 106

{
  "mutualTlsOauthConfigurationId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "mutualTlsOauthConfigurationTenantId": "00001111-aaaa-2222-bbbb-3333cccc4445",
  "deviceAuthority": "Lakeshore Retail",
  "manufacturer": "Tailwind Traders",
  "model": "DeepFreezerModelAB",
  "operatingSystem": "WindowsIoT",
  "owners@odata.bind": [
    "https://graph.microsoft.com/beta/users/aaaaaaaa-bbbb-cccc-1111-222222222222"
  ]
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#directory/templates/deviceTemplates/$entity",
  "id": "c0ff9329-3596-4ece-8aa9-3dd23a925356",
  "mutualTlsOauthConfigurationId": "00001111-aaaa-2222-bbbb-3333cccc4444",
  "mutualTlsOauthConfigurationTenantId": "00001111-aaaa-2222-bbbb-3333cccc4445",
  "deletedDateTime": null,
  "deviceAuthority": "Lakeshore Retail",
  "manufacturer": "Tailwind Traders",
  "model": "DeepFreezerModelAB",
  "operatingSystem": "WindowsIoT"
}