tipo de recurso bulkUpload

Artigo
04/09/2024

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.

Representa a capacidade do serviço de sincronização Microsoft Entra para processar uploads em massa. Para obter mais informações, confira Conceitos de provisionamento de entrada controlados por API.

Métodos

Método	Tipo de retorno	Descrição
Executar bulkUpload	Nenhum	Execute um novo upload em massa usando o trabalho de sincronização.

Propriedades

O tipo de recurso bulkUpload aceita as seguintes propriedades no conteúdo:

O parâmetro de esquemas no nível raiz que deve ser definido como urn:ietf:params:scim:api:messages:2.0:BulkRequest. Obrigatório. O bloco JSON a seguir mostra uma representação do parâmetro de esquemas .
```
"schemas": [
  "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
]
```
O parâmetro Operações contém uma matriz de pares de valor-chave. Cada solicitação pode conter no máximo 50 operações de usuário sob esse parâmetro. Os pares de valor-chave a seguir são necessários em cada objeto na matriz.
- a chave do método deve ser definida como POST
Observação

Quando a chave do método for definida como POST, o serviço de provisionamento determinará a operação correta a ser executada no destino (criar/atualizar/habilitar/desabilitar) com base na configuração de mapeamento de atributo. Por exemplo, se você tiver definido {externalId,employeeId} como o par de identificador correspondente, o serviço de provisionamento marcar se um usuário com o employeeId existir no Microsoft Entra ID. Se ele não existir, o serviço de provisionamento criará o usuário. Se ele existir, o serviço de provisionamento atualizará o registro de usuário.
- chave de caminho sempre definida como o valor /Users
- bulkId key set to a unique ID value. Por exemplo, se os dados forem provenientes de uma fonte de RH, você poderá definir esse valor para employeeId o qual é garantido ser exclusivo no sistema de RH.
- objeto data. Obrigatório. O objeto de dados deve ter os seguintes objetos:
- A schemas matriz sob o data objeto deve ter os esquemas: urn:ietf:params:scim:schemas:core:2.0:User e urn:ietf:params:scim:schemas:extension:enterprise:2.0:User representar o URI do esquema SCIM para o Recurso de Usuário Principal e a Extensão de Usuário Empresarial, respectivamente. Você pode incluir nomes de esquema scim personalizados adicionais no caso de extensões de atributo.
- externalId key set to a unique identifier in the source system. Por exemplo, employeeId ou personId ou studentId.
O exemplo JSON a seguir mostra um exemplo de um objeto Operations .
```
{
    "method": "POST",
    "bulkId": "d63f4f30-a198-43db-a34d-f72bfa1f551e",
    "path": "/Users",
    "data": {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "externalId": "EMP1830"
  ... [You may include other SCIM attributes and extensions under the data object.]
    }
  }    
```

Relações

Nenhum

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "@odata.type": "#microsoft.graph.bulkUpload"
}