DeclaredConfiguration CSP

O modelo MDM primário é aquele em que o servidor MDM é o único responsável pela orquestração e manutenção contínua do estado do dispositivo para cenários de configuração. Esse comportamento resulta em tráfego de rede intenso e alta latência de rede devido ao modelo de configuração síncrona baseado no padrão OMA-DM Syncml. Também é propenso a erros, pois o servidor precisa de um conhecimento profundo do cliente.

O modelo de gerenciamento de dispositivo de configuração declarada do Windows (WinDC) requer que o servidor forneça todos os valores de configuração ao dispositivo para a configuração do cenário. O servidor os envia de forma assíncrona em lotes por meio do CSP DeclaredConfiguration.

• Durante a sessão OMA-DM iniciada pelo cliente, o servidor WinDC envia uma configuração ou um documento WinDC de inventário para o cliente por meio do URI do CSP DeclaredConfiguration. Se o dispositivo verificar se a sintaxe do documento está correta, a pilha de clientes enviará a solicitação ao orquestrador para processar a solicitação de forma assíncrona. Em seguida, a pilha do cliente sai e retorna o controle de volta ao serviço WinDC. Esse comportamento permite que o dispositivo processe a solicitação de forma assíncrona.

• No cliente, se houver alguma solicitação em andamento ou concluída, ele envia um alerta genérico para o servidor. Esse alerta resume o status, o estado e o progresso de cada documento. Cada solicitação HTTPS do cliente para o servidor WinDC OMA-DM inclui este resumo.

• O servidor WinDC usa o alerta genérico para determinar quais solicitações são concluídas com êxito ou com erros. Em seguida, o servidor pode recuperar de forma síncrona os resultados do processo do documento WinDC por meio do URI do CSP DeclaredConfiguration.

A lista a seguir mostra os nós do provedor de serviços de configuração DeclaredConfiguration:

• ./Device/Vendor/MSFT/DeclaredConfiguration
  • Host
    • Concluída
      • Documentos
        • {DocID}
          • Documento
          • Propriedades
            • Abandonado
      • Resultados
        • {DocID}
          • Documento
    • Inventário
      • Documentos
        • {DocID}
          • Documento
      • Resultados
        • {DocID}
          • Documento
  • ManagementServiceConfiguration
    • Resolução de conflitos

Host

./Device/Vendor/MSFT/DeclaredConfiguration/Host

O nó interno do host indica que o destino da solicitação de configuração ou da solicitação de inventário é o sistema operacional host. Esse nó é para escopo caso os enclaves sejam direcionados para configuração.

Propriedades da estrutura de descrição:

Host/Completo

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete

Esse nó interno indica que a configuração tem valores de definições distintos e é independente com pares completos de definição e valor que não contêm espaços reservados que precisam ser resolvidos posteriormente com dados adicionais. A solicitação está pronta para ser processada no estado em que se encontra.

O fluxo do servidor para o cliente da solicitação Concluir é o mesmo que uma solicitação de Inventário .

Propriedades da estrutura de descrição:

Host/Complete/Documents

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents

O nó Documentos indica que a configuração está na forma de um documento, que é uma coleção de configurações usadas para configurar um cenário pela pilha de Configuração Declarada.

Propriedades da estrutura de descrição:

Host/Complete/Documents/{DocID}

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/{DocID}

Identifica exclusivamente o documento de configuração. Nenhum outro documento pode ter essa ID. A ID deve ser um GUID.

Propriedades da estrutura de descrição:

Host/Complete/Documents/{DocID}/Document

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/{DocID}/Document

O valor do nó Documento é um documento baseado em XML que contém uma coleção de configurações e valores para configurar o cenário especificado. A pilha de Configuração Declarada verifica a sintaxe do documento, a pilha marca o documento a ser processado de forma assíncrona pelo cliente. Em seguida, a pilha retorna o controle de volta ao serviço OMA-DM. A pilha, por sua vez, processa a solicitação de forma assíncrona. Abaixo está um exemplo de uma configuração de estado desejada especificada usando o URI de configuração declarada ./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Document.

Propriedades da estrutura de descrição:

Host/Complete/Documents/{DocID}/Properties

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/{DocID}/Properties

O nó Propriedades encapsula a lista de propriedades que se aplicam ao documento especificado referenciado por [DocID].

Propriedades da estrutura de descrição:

Host/Complete/Documents/{DocID}/Properties/Abandoned

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/{DocID}/Properties/Abandoned

O nó Abandonado permite que o servidor OMA-DM indique que o documento não é mais gerenciado.

Propriedades da estrutura de descrição:

Valores Permitidos:

Host/Complete/Results

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Results

O nó Results indica que isso faz parte do caminho de URI que retornará um documento XML que contém os resultados da solicitação de configuração.

Propriedades da estrutura de descrição:

Host/Complete/Results/{DocID}

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Results/{DocID}

Identifica exclusivamente o documento de configuração no qual os resultados da solicitação de configuração serão retornados.

Propriedades da estrutura de descrição:

Host/Complete/Results/{DocID}/Document

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Results/{DocID}/Document

O valor do nó Document é um documento baseado em XML que contém uma coleção de resultados de configuração da solicitação de configuração especificada por [DocId].

Propriedades da estrutura de descrição:

Host/Inventário

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory

O nó interno Inventário indica que se trata de uma solicitação de inventário. Os valores de configuração a serem recuperados são especificados em um documento XML por meio do nó folha do documento.

O fluxo do servidor para o cliente da solicitação de Inventário é o mesmo que a solicitação Complete .

Propriedades da estrutura de descrição:

Host/Inventário/Documentos

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Documents

O nó Documentos indica que a solicitação de inventário está na forma de um documento, que é uma coleção de configurações usadas para recuperar seus valores.

Propriedades da estrutura de descrição:

Host/Inventory/Documents/{DocID}

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Documents/{DocID}

Identifica exclusivamente o documento de inventário. Nenhum outro documento pode ter essa ID. A ID deve ser um GUID.

Propriedades da estrutura de descrição:

Host/Inventory/Documents/{DocID}/Document

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Documents/{DocID}/Document

O valor do nó Document é um documento baseado em XML que contém uma coleção de configurações que serão usadas para recuperar seus valores. A pilha de Configuração Declarada verifica a sintaxe do documento, a pilha marca o documento a ser processado de forma assíncrona pelo cliente. Em seguida, a pilha retorna o controle de volta ao serviço OMA-DM. A pilha, por sua vez, processa a solicitação de forma assíncrona. Abaixo está um exemplo de uma configuração de estado desejada especificada usando o URI de configuração declarada./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Document.

Propriedades da estrutura de descrição:

Host/Inventory/Results

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Results

O nó Results indica que isso faz parte do caminho de URI que retornará um documento XML contendo os resultados da solicitação de inventário.

Propriedades da estrutura de descrição:

Host/Inventory/Results/{DocID}

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Results/{DocID}

Identifica exclusivamente o documento de inventário. Nenhum outro documento pode ter essa ID. A ID deve ser um GUID.

Propriedades da estrutura de descrição:

Host/Inventory/Results/{DocID}/Document

./Device/Vendor/MSFT/DeclaredConfiguration/Host/Inventory/Results/{DocID}/Document

O valor do nó Documento é um documento baseado em XML que contém uma coleção de resultados de configuração da solicitação de inventário especificada por [DocId].

Propriedades da estrutura de descrição:

ManagementServiceConfiguration

./Device/Vendor/MSFT/DeclaredConfiguration/ManagementServiceConfiguration

O nó ManagementServiceConfiguration usado para controlar determinados comportamentos da Configuração Declarada do Windows.

Propriedades da estrutura de descrição:

ManagementServiceConfiguration/ConflictResolution

./Device/Vendor/MSFT/DeclaredConfiguration/ManagementServiceConfiguration/ConflictResolution

Esse nó controla a ativação e desativação da resolução de conflitos.

Propriedades da estrutura de descrição:

Valores Permitidos:

DeclaredConfiguration OMA URI

Uma solicitação WinDC é enviada usando um OMA-URI semelhante a ./Device/Vendor/MSFT/DeclaredConfiguration/Host/[Complete|Inventory]/Documents/{DocID}/Document.

• O URI é prefixado com um escopo direcionado (User ou Device).
• {DocID} é um identificador exclusivo para o estado desejado do cenário de configuração. Todo documento deve ter uma ID, que deve ser um GUID.
• A solicitação pode ser uma solicitação de Inventário ou Conclusão .

O URI a seguir é um exemplo de uma solicitação Complete : ./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Document

Documento WinDC

<DeclaredConfiguration
    schema="1.0"
    context="Device"
    id="27FEA311-68B9-4320-9FC4-296F6FDFAFE2"
    checksum="99925209110918B67FE962460137AA3440AFF4DB6ABBE15C8F499682457B9999"
    osdefinedscenario="MSFTExtensibilityMIProviderConfig">
    ... {Configuration Data} ...
</DeclaredConfiguration>

A <DeclaredConfiguration> marca XML especifica os detalhes do documento WinDC a ser processado. O documento pode fazer parte de uma solicitação de configuração ou de inventário. O CSP DeclaredConfiguration tem dois URIs para permitir a especificação de uma configuração ou uma solicitação de inventário .

Esta marca tem os seguintes atributos:

O CSP DeclaredConfiguration valida de forma síncrona o lote de configurações descritas pelo <DeclaredConfiguration> elemento, que representa o documento WinDC. Ele verifica a sintaxe correta com base no esquema XML do WinDC. Se houver um erro de sintaxe, o CSP retornará um erro imediatamente de volta ao servidor como parte da sessão OMA-DM atual. Se a marca de sintaxe for aprovada, a solicitação será passada para um serviço do Windows. O serviço do Windows tenta de forma assíncrona a configuração de estado desejada do cenário especificado. Este processo libera o servidor para fazer outro trabalho, portanto, a baixa latência do protocolo WinDC. O serviço de cliente do Windows, o orquestrador, é responsável por conduzir a configuração do dispositivo com base no estado desejado fornecido pelo servidor. O serviço também mantém esse estado durante todo o tempo de vida até que o servidor o remova ou modifique.

O processamento real da solicitação gira em torno da osdefinedscenario tag e dos dados de configuração especificados no documento. Para obter mais informações, consulte:

• Documento WinDC para acesso a recursos
• Documento WinDC para extensibilidade

Alerta genérico do WinDC

Em cada resposta do cliente à solicitação do servidor, o cliente constrói um alerta WinDC. Este alerta resume o estado de cada um dos documentos que o serviço Windows processou. O XML a seguir é um alerta de exemplo:

<Alert>
  <CmdID>1</CmdID>
  <Data>1224</Data>
  <Item>
    <Meta>
      <Type xmlns="syncml:metinf">com.microsoft.mdm.declaredconfigurationdocuments</Type>
    </Meta>
    <Data>
      <DeclaredConfigurations schema="1.0">
        <DeclaredConfiguration context="Device"
                               id="27FEA311-68B9-4320-9FC4-296F6FDFAFE2"
                               checksum="99925209110918B67FE962460137AA3440AFF4DB6ABBE15C8F499682457B9999"
                               result_checksum="EE4F1636201B0D39F71654427E420E625B9459EED17ACCEEE1AC9B358F4283FD"
                               state="60" />
      </DeclaredConfigurations>
    </Data>
  </Item>
</Alert>

Neste exemplo, há um documento WinDC listado no resumo do alerta. O resumo do alerta lista todos os documentos que a pilha do cliente está processando, seja uma solicitação de configuração ou inventário. Ele descreve o contexto do documento que especifica o escopo de como o documento é aplicado. O valor do contexto deve ser Device.

O atributo state tem um valor de , que indica que o documento foi processado 60com êxito.

Estados do WinDC

A classe a seguir define os valores de estado:

enum class DCCSPURIState :unsigned long
{
    NotDefined = 0, // transient
    ConfigRequest = 1, // transient
    ConfigInprogress = 2, // transient
    ConfigInProgressAsyncPending = 3, // transient: Async operation is performed but pending results
    DeleteRequest = 10,  // transient
    DeleteInprogress = 11,  // transient

    GetRequest = 20,  // transient
    GetInprogress = 21,  // transient

    ConstructURIStorageSuccess = 40, // transient

    ConfigCompletedSuccess = 60, // permanent
    ConfigCompletedError = 61, // permanent
    ConfigInfraError = 62, // permanent
    ConfigCompletedSuccessNoRefresh = 63, // permanent

    DeleteCompletedSuccess = 70, // permanent
    DeleteCompletedError = 71, // permanent
    DeleteInfraError = 72, // permanent

    GetCompletedSuccess = 80, // permanent
    GetCompletedError = 81, // permanent
    GetInfraError = 82 // permanent
};

Exemplos de SyncML

• Exemplos de SyncML para acesso a recursos
• Exemplos de SyncML para extensibilidade

Abandonar um documento WinDC

O abandono de um recurso ocorre quando determinados recursos não estão mais direcionados a um usuário ou grupo. Em vez de excluir o recurso no dispositivo, o servidor pode optar por abandonar o documento WinDC. Um recurso abandonado permanece no dispositivo, mas interrompe a atualização do documento WinDC que lida com o controle de desvio. Além disso, a propriedade do recurso é transferida para o MDM, o que significa que o mesmo recurso pode ser modificado por meio do canal MDM herdado novamente.

Este exemplo demonstra como abandonar um documento WinDC, definindo a propriedade Abandoned como 1.

<SyncML xmlns="SYNCML:SYNCML1.1">
  <SyncBody>
    <Replace>
    <CmdID>2</CmdID>
    <Item>
        <Meta>
            <Format>int</Format>
            <Type>text/plain</Type>
        </Meta>
        <Target>
            <LocURI>./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Properties/Abandoned</LocURI>
        </Target>
        <Data>1</Data>
    </Item>
    </Replace>
    <Final/>
  </SyncBody>
</SyncML>

Cancelar o abandono de um documento WinDC

O cancelamento do abandono do documento faz com que o documento seja aplicado imediatamente, transferindo a propriedade do recurso de volta para o gerenciamento do WinDC e impedindo que o canal MDM herdado gerencie os canais novamente.

Este exemplo demonstra como cancelar o abandono de um documento WinDC, definindo a propriedade Abandoned como 0.

<?xml version="1.0" encoding="utf-8"?>
<SyncML xmlns="SYNCML:SYNCML1.1">
  <SyncBody>
    <Replace>
      <CmdID>10</CmdID>
      <Item>
        <Target>
          <LocURI>./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/DCA000B5-397D-40A1-AABF-40B25078A7F9/Properties/Abandoned</LocURI>
        </Target>
        <Meta>
          <Format xmlns="syncml:metinf">int</Format>
        </Meta>
        <Data>0</Data>
      </Item>
    </Replace>
    <Final />
  </SyncBody>
</SyncML>

Excluir um documento WinDC

A exclusão do SyncML do documento remove apenas o documento, mas todas as configurações persistem no dispositivo. Este exemplo demonstra como excluir um documento.

<?xml version="1.0" encoding="utf-8"?>
<SyncML xmlns="SYNCML:SYNCML1.1">
<SyncBody>
    <Delete>
        <CmdID>2</CmdID>
        <Item>
        <Target>
            <LocURI>./Device/Vendor/MSFT/DeclaredConfiguration/Host/Complete/Documents/27FEA311-68B9-4320-9FC4-296F6FDFAFE2/Document</LocURI>
        </Target>
        </Item>
    </Delete>
    <Final/>
    </SyncBody>
</SyncML>

Artigos relacionados

Referência de provedor de serviços de configuração