Partilhar via


bulkUpload resource type (Tipo de recurso bulkUpload)

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 do Microsoft Entra para processar carregamentos em massa. Para obter mais informações, veja Conceitos de aprovisionamento de entrada baseados em API.

Métodos

Método Tipo de retorno Descrição
Executar o carregamento em massa Nenhum Execute um novo carregamento em massa com a tarefa de sincronização.

Propriedades

O tipo de recurso bulkUpload aceita as seguintes propriedades no payload:

  • O parâmetro de esquemas no nível de raiz que tem de ser definido como urn:ietf:params:scim:api:messages:2.0:BulkRequest. Obrigatório. O bloco JSON seguinte 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 chave-valor. Cada pedido pode conter um máximo de 50 operações de utilizador neste parâmetro. Os seguintes pares chave-valor são necessários em cada objeto na matriz.

    • a chave do método tem de ser definida como POST

    Observação

    Quando a chave do método está definida como POST, o serviço de aprovisionamento determinará a operação correta a executar no destino (criar/atualizar/ativar/desativar) com base na configuração de mapeamento de atributos. Por exemplo, se tiver definido {externalId,employeeId} como o par de identificadores correspondentes, o serviço de aprovisionamento verificará se existe um utilizador com o employeeId no ID do Microsoft Entra. Se não existir, o serviço de aprovisionamento irá criar o utilizador. Se existir, o serviço de aprovisionamento atualizará o registo do utilizador.

    • chave de caminho sempre definida para o valor/Users
    • chave bulkId definida para um valor de ID exclusivo. Por exemplo, se os dados forem provenientes de uma origem de RH, pode definir este valor para employeeId o qual é garantido que é exclusivo no sistema de RH.
    • objeto de dados. Obrigatório. O objeto de dados tem de ter os seguintes objetos:
    • A schemas matriz sob o data objeto tem de 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 Utilizador Principal e a Extensão de Utilizador Empresarial, respetivamente. Pode incluir nomes de esquema SCIM personalizados adicionais no caso de extensões de atributos.
    • externalId key set to a unique identifier in the source system. Por exemplo, employeeId ou personId ou studentId.

    O exemplo JSON seguinte mostra um exemplo de um objeto Operações .

    {
        "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

A representação JSON seguinte mostra o tipo de recurso.

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