Partilhar via


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.

Crie um novo deviceTemplate utilizado para identificar atributos e gerir um grupo de dispositivos com características semelhantes.

Esta API está disponível nas seguintes implementações de cloud nacionais.

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

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
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

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação:

  • Administrador de Dispositivos na Cloud
  • Administrador de Dispositivos IoT
  • Utilizadores – 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 do pedido, forneça uma representação JSON do objeto deviceTemplate .

Pode especificar as seguintes propriedades quando criar um deviceTemplate.

Propriedade Tipo Descrição
deviceAuthority Cadeia de caracteres Um nome definido pelo inquilino para a parte responsável pelo aprovisionamento e gestão de dispositivos no inquilino Microsoft Entra. Por exemplo, a Tailwind Traders (o fabricante) faz câmaras de segurança instaladas em edifícios de clientes e geridas pelo Lakeshore Retail (a autoridade do dispositivo). Este 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 de objeto da mutualTlsOauthConfiguration. Este valor não é necessário se forem utilizados certificados autoassinados em vez de certificados de raiz fidedigna. Opcional.
mutualTlsOauthConfigurationTenantId Cadeia de caracteres ID (ID do inquilino da autoridade do dispositivo) do inquilino que contém mutualTlsOauthConfiguration. Este valor não é necessário se forem utilizados certificados autoassinados em vez de certificados de raiz fidedigna. Opcional.
operatingSystem Cadeia de caracteres Tipo de sistema operativo. Opcional.
owners@odata.bind String collection Lista de IDs para os proprietários adicionarem ao modelo de dispositivo. Apenas os seguintes tipos de directoryObject são suportados como proprietários: principais de serviço, utilizadores ou aplicações. Opcional.

Resposta

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

Para obter mais informações, veja Respostas de erro e tipos de recursos do Microsoft Graph.

Exemplos

Exemplo 1: Criar um novo modelo de dispositivo

O exemplo seguinte 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 seguinte 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"
}