Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Note
- Esta é uma versão preliminar do recurso.
- Os recursos de versão preliminar não foram criados para uso em ambientes de produção e podem ter funcionalidade restrita. Esses recursos estão disponíveis antes de um lançamento oficial para que os clientes possam obter acesso antecipado e fornecer comentários.
Este artigo descreve os comandos disponíveis na CLI do Dataverse. Cada comando dá suporte a uma --help opção que lista seu uso, opções e exemplos. Os comandos que retornam dados dão suporte a uma --json opção de saída JSON bruta que é útil em scripts.
As seguintes opções globais podem ser usadas com qualquer comando:
| Opção | Description |
|---|---|
--log-level <level> |
Defina o nível de registro em log: Trace, , Debug, Information, Warning, Errorou Critical. Padrão: Warning. |
--log-file |
Faça logon em um arquivo no diretório temporário em vez do console. |
--context <value> |
Contexto de operação acrescentado ao User-Agent. Você também pode definir a variável de DATAVERSE_OPERATION_CONTEXT ambiente. |
| Command | Description |
|---|---|
api describe |
Descrever uma API |
api invoke |
Invocar uma API pelo nome |
api list |
Listar APIs detectáveis |
api request |
Enviar uma solicitação HTTP autenticada |
auth create |
Criar um novo perfil de autenticação |
auth list |
Listar todos os perfis de autenticação |
auth remove |
Remover um perfil de autenticação |
auth select |
Selecione o perfil de autenticação ativa |
auth who |
Mostrar o perfil de autenticação atual |
data associate |
Vincular dois registros por meio de uma relação |
data count |
Contar registros em uma tabela |
data create |
Criar um novo registro |
data delete |
Excluir um registro |
data describe |
Descrever o esquema de uma entidade |
data disassociate |
Remover uma relação entre dois registros |
data get |
Recuperar um único registro por ID ou chave alternativa |
data query |
Executar uma consulta OData, FetchXML ou SQL |
data update |
Atualizar um registro existente |
data upload |
Carregar um arquivo em uma coluna de arquivo em um registro existente |
data upsert |
Criar ou atualizar um registro por chave alternativa |
erp batch cancel |
Cancelar um trabalho em lote de Finanças e Operações |
erp batch list |
Listar trabalhos em lote de Finanças e Operações |
install |
Instalar uma versão específica ou atualizar para a versão mais recente |
mcp |
Iniciar o servidor MCP para Dataverse ou ERP |
mcp allow |
Permitir um aplicativo como um cliente MCP |
org list |
Listar todos os ambientes acessíveis |
org who |
Mostrar informações atuais da organização e do usuário |
skill delete |
Excluir uma habilidade do Dataverse |
skill download |
Baixar uma habilidade do Dataverse |
skill list |
Listar habilidades ativas no ambiente |
skill upload |
Carregar uma habilidade no Dataverse |
Note
Muitos comandos dão suporte a uma --target <dataverse\|erp> opção que roteia a operação para o Dataverse (o padrão) ou para o ambiente vinculado de Finanças e Operações (ERP). Os comandos que se conectam a um ambiente dão suporte a uma --environment <url> opção (-env) para substituir a URL de ambiente do perfil atual.
api describe comando
Mostrar os metadados de uma única API. Para APIs personalizadas do Dataverse, a saída inclui descrições de propriedade de solicitação e de propriedade de resposta quando os metadados os fornecem.
Os nomes do dataverse não são prefixados por padrão. Você pode usar nomes qualificados por ERP no formulário erp:ServiceGroup/Service/Operation.
Parâmetros api describe
| Parameter | Description |
|---|---|
--target |
Resolver um nome não qualificado em dataverse ou erp. |
--service-group |
Somente ERP. Restringir a pesquisa da operação a um grupo de serviços. |
--service |
Somente ERP. Restringir a pesquisa de operação a um serviço. |
--environment |
Substitua a URL do ambiente do Dataverse. |
--json |
JSON bruto de saída. |
api describe Exemplos
dataverse api describe sample_CustomAPIExample
dataverse api describe msdyn_DoesKBExist
dataverse api describe GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService
api invoke comando
Invoque uma API descoberta pelo nome. Use name=value a sintaxe para parâmetros. Se um valor contiver espaços, assopa todo o token. Algumas APIs do Dataverse aceitam um parâmetro de cadeia de caracteres cujo conteúdo é o próprio JSON. Nesse caso, passe o texto JSON como o valor usando as regras normais de cotação e escape do shell.
Por padrão, as respostas JSON são renderizadas em um formato de texto amigável que mantém os nomes de propriedade de saída. Use --json para preservar o conteúdo JSON bruto.
Parâmetros api invoke
| Parameter | Description |
|---|---|
--target |
Resolver um nome não qualificado em dataverse ou erp. |
--service-group |
Somente ERP. Restringir a pesquisa da operação a um grupo de serviços. |
--service |
Somente ERP. Restringir a pesquisa de operação a um serviço. |
--param |
Adicione um parâmetro nomeado no name=value formulário. Repetível. |
--bind |
O caminho de associação para APIs do Dataverse associadas à entidade. |
--method, -X |
Substitua o método HTTP inferido. |
--body |
Use um corpo JSON bruto em vez de parâmetros nomeados. |
--body-file |
Leia um corpo JSON bruto de um arquivo. |
--header, -H |
Adicione um cabeçalho HTTP no key:value formulário. |
--include, -i |
Inclua o status da resposta e os cabeçalhos. |
--environment |
Substitua a URL do ambiente do Dataverse. |
--json |
Gerar JSON bruto em vez de texto amigável. |
api invoke Exemplos
Invocar uma função do Dataverse. Este exemplo mostra o uso da função CCaaS_GetPresence Dynamics 365 Contact Center.
dataverse api invoke CCaaS_GetPresence ApiVersion=1.0
Invoque a ação AISummarize do Dataverse com espaços em um valor de parâmetro:
dataverse api invoke AISummarize "Text=The customer reported intermittent login failures..."
Invoque um serviço personalizado ERP:
dataverse api invoke GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService
api list comando
Listar APIs detectáveis, como APIs personalizadas do Dataverse e pontos de extremidade de serviço invocados por ERP. Os resultados mostram a identidade da API, o nome amigável, o tipo e a descrição quando disponível. Você pode passar um termo de consulta opcional para filtrar os resultados.
Parâmetros api list
| Parameter | Description |
|---|---|
--target |
O sistema de destino a ser pesquisado: dataverse (padrão) ou erp. |
--service-group |
Somente ERP. Filtrar para um único grupo de serviços. |
--service |
Somente ERP. Filtrar para um único serviço. |
--limit |
O número máximo de APIs a serem retornadas. Padrão: 50. |
--page |
O número de página baseado em 1 ao paginar os resultados. Padrão: 1. |
--environment |
Substitua a URL do ambiente do Dataverse. |
--json |
JSON bruto de saída. |
api list Exemplos
dataverse api list
dataverse api list invoice --target dataverse
dataverse api list --target erp GetUserSessionInfo
dataverse api list --target erp --service-group UserSessionService --service AifUserSessionService
api request comando
Envie uma solicitação HTTP autenticada bruta para Dataverse ou ERP. Use esse comando quando precisar de controle total sobre o caminho, o método, os cabeçalhos e o corpo.
Parâmetros api request
| Parameter | Description |
|---|---|
--target |
O sistema de destino: dataverse ou erp. Required. |
--path |
O caminho da solicitação. Required. |
--method, -X |
O método HTTP. Padrão: GETou POST quando um corpo é fornecido. |
--body |
Um corpo de solicitação JSON embutido. |
--body-file |
Um arquivo que contém um corpo de solicitação de objeto JSON. |
--header, -H |
Adicione um cabeçalho HTTP no key:value formulário. |
--include, -i |
Inclua o status da resposta e os cabeçalhos. |
--environment |
Substitua a URL do ambiente do Dataverse. |
api request Exemplos
dataverse api request --target dataverse --path /api/data/v9.2/sample_CustomAPIExample --body "{\"Input\":\"value\"}"
dataverse api request --target erp --path /api/services/UserSessionService/AifUserSessionService/GetUserSessionInfo --body "{}"
auth create comando
Crie um novo perfil de autenticação.
Parâmetros auth create
Use esses parâmetros para especificar o comportamento do auth create comando.
| Parameter | Description |
|---|---|
--environment, -env |
A URL para o ambiente do Dataverse com o qual você deseja autenticar. |
--name, -n |
Um nome opcional para o perfil. Use o nome para selecionar o perfil posteriormente. |
--cloud, -ci |
A nuvem de destino: Public, , UsGov, UsGovHigh, UsGovDodou China. |
--deviceCode, -dc |
Use o fluxo de autenticação de código do dispositivo para ambientes sem um navegador. |
--username, -un |
O nome de usuário para autenticação de nome de usuário e senha. |
--password, -p |
A senha para autenticação de nome de usuário e senha. |
--applicationId, -id |
A ID do aplicativo (cliente) para autenticação SPN (entidade de serviço). |
--clientSecret, -cs |
O segredo do cliente para autenticação da entidade de serviço. |
--certificateDiskPath, -cdp |
O caminho para um arquivo de certificado .pfx para autenticação baseada em certificado. |
--certificatePassword, -cp |
A senha para o certificado. |
--tenant, -t |
A ID do locatário. Necessário para autenticação da entidade de serviço. |
--managedIdentity, -mi |
Use uma identidade gerenciada Azure. |
--githubFederated, -ghf |
Use GitHub Actions autenticação federada. |
--azureDevOpsFederated, -adof |
Use Azure DevOps autenticação federada. |
--clientid, -cid |
Um Microsoft Entra ID do cliente do aplicativo personalizado a ser usado em vez do aplicativo padrão da CLI do Dataverse. |
--no-default-environment |
Não defina o ambiente como o padrão. |
--accept-cleartext-caching |
Permitir um cache de token de texto sem formatação no Linux. |
auth create Exemplos
Os exemplos a seguir demonstram como usar o auth create comando.
Autenticação interativa
Esse comando abre uma caixa de diálogo do navegador ou do sistema para obter informações adicionais.
dataverse auth create --environment https://myorg.crm.dynamics.com
Perfil nomeado
Crie um perfil com um nome específico.
dataverse auth create --environment https://myorg.crm.dynamics.com --name prod
Fluxo de código do dispositivo
Use o fluxo de código do dispositivo para ambientes sem um navegador.
dataverse auth create --environment https://myorg.crm.dynamics.com --deviceCode
Entidade de serviço com segredo do cliente
Use uma entidade de serviço quando precisar de autenticação autônoma, como em um pipeline de CI/CD ou outro script automatizado em que a entrada interativa não seja possível. Forneça a ID do aplicativo, o segredo do cliente e a ID do locatário de um registro de aplicativo que tenha acesso ao ambiente.
dataverse auth create --applicationId <appId> --clientSecret <secret> --tenant <tenantId>
ID do cliente do aplicativo Entra personalizado
Use seu próprio registro de aplicativo em vez do padrão.
dataverse auth create --environment https://myorg.crm.dynamics.com --clientid <your-app-guid>
auth list comando
Listar todos os perfis de autenticação. Adicionar --json para saída JSON bruta.
auth list Exemplos
dataverse auth list
dataverse auth list --json
auth remove comando
Remova um ou todos os perfis de autenticação.
Parâmetros auth remove
| Parameter | Description |
|---|---|
--index, -i |
Remova o perfil com o índice baseado em 1 especificado, conforme mostrado em auth list. |
--name, -n |
Remova o perfil com o nome especificado. |
--all |
Remova todos os perfis. |
auth remove Exemplos
dataverse auth remove --index 1
dataverse auth remove --name prod
dataverse auth remove --all
auth select comando
Selecione o perfil de autenticação ativa. Execute o comando sem opções para listar todos os perfis.
Parâmetros auth select
| Parameter | Description |
|---|---|
--index, -i |
Selecione o perfil por seu índice baseado em 1, conforme mostrado em auth list. |
--name, -n |
Selecione o perfil pelo nome. |
auth select Exemplos
Abra um seletor interativo. Use as teclas de direção ou digite para filtrar:
dataverse auth select
Selecione um perfil por índice ou por nome:
dataverse auth select --index 1
dataverse auth select --name prod
auth who comando
Mostrar o perfil de autenticação ativo e atual. Adicionar --json para saída JSON bruta.
auth who Exemplos
dataverse auth who
dataverse auth who --json
data associate comando
Associe dois registros por meio de uma propriedade de navegação (relação). Este comando tem suporte apenas para o Dataverse.
Parâmetros data associate
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades do registro primário. Required. |
--id, -i |
O GUID do registro primário. Required. |
--relationship, -rel |
O nome da propriedade de navegação. Required. |
--related |
O nome do conjunto de entidades da tabela relacionada. Required. |
--related-id |
O GUID do registro relacionado. Required. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data associate Exemplos
dataverse data associate --table accounts --id <guid> --relationship contact_customer_accounts --related contacts --related-id <related-guid>
data count comando
Conte os registros em uma tabela, opcionalmente filtrado.
Parâmetros data count
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades. Obrigatório, a menos que você use --fetchxml. |
--filter, -f |
Uma expressão OData $filter . |
--fetchxml |
Uma consulta de agregação FetchXML para contagens complexas. |
--target |
Rotear para dataverse (padrão) ou para o ambiente vinculado erp . |
--cross-company |
Somente ERP. Conta em todas as empresas. Padrão: a empresa padrão do usuário. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data count Exemplos
dataverse data count --table accounts
dataverse data count --target erp --table Currencies --filter "CurrencyCode eq 'AED'"
data create comando
Crie um novo registro em uma tabela do Dataverse. Defina colunas de pesquisa usando @odata.bind a sintaxe.
Parâmetros data create
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades. Required. |
--data, -d |
Um objeto JSON com os valores de campo. |
--data-file |
O caminho para um arquivo JSON com os dados de registro. |
--return, -r |
Retorne o registro completo criado. |
--target |
Rotear para dataverse (padrão) ou para o ambiente vinculado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data create Exemplos
dataverse data create --table accounts --data '{"name":"Contoso"}'
dataverse data create --table contacts --data '{"firstname":"Alice","parentcustomerid_account@odata.bind":"accounts(<guid>)"}'
Dica
Use --data-file para JSON complexo. Use --return --json para obter o registro completo criado.
data delete comando
Exclua um único registro por sua chave primária ou por uma chave alternativa.
Parâmetros data delete
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades. Required. |
--id, -i |
O GUID de registro. |
--key, -k |
Uma chave alternativa. |
--no-confirm |
Ignore o prompt de confirmação. |
--target |
Rotear para dataverse (padrão) ou para o ambiente vinculado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data delete Exemplos
dataverse data delete --table accounts --id 00000000-0000-0000-0000-000000000001 --no-confirm
data describe comando
Descrever o esquema de uma entidade OData. Para o Dataverse, o comando chama EntityDefinitions(LogicalName='<table>') com orientado por --include, além de uma segunda chamada para customapis quando --include actions é definido.$expand Ações internas do Dataverse, como Assign e não são enumeradas SetState . Para ERP, uma única chamada para /Metadata/PublicEntities retornar propriedades, ações associadas e navegaçãos juntas.
Parâmetros data describe
| Parameter | Description |
|---|---|
--target |
O destino: dataverse (padrão) ou erp. |
--table, -t |
Required. Para o Dataverse, o nome lógico, como account. Para ERP, o nome do conjunto de entidades, como BatchJobs. |
--include |
Uma lista separada por vírgulas de seções a serem incluídas: entity, , properties, relations, ou actionsall. Aliases: attributes=properties, relationships=relations. Padrão para ERP: all. Padrão para o Dataverse: entity,properties. |
--json |
JSON bruto de saída. |
data describe Exemplos
dataverse data describe --table account
dataverse data describe --target dataverse --table account --include all
dataverse data describe --target erp --table BatchJobs
data disassociate comando
Remova uma relação entre dois registros. Este comando tem suporte apenas para o Dataverse.
Parâmetros data disassociate
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades do registro primário. Required. |
--id, -i |
O GUID do registro primário. Required. |
--relationship, -rel |
O nome da propriedade de navegação. Required. |
--related-id |
O GUID do registro relacionado, para uma relação muitos para muitos. Omita esse parâmetro para limpar uma pesquisa. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data disassociate Exemplos
dataverse data disassociate --table accounts --id <guid> --relationship contact_customer_accounts --related-id <related-guid>
data get comando
Recupere um único registro por sua ID (chave primária) ou por uma chave alternativa.
Parâmetros data get
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades. Required. |
--id, -i |
O GUID de registro (chave primária). |
--key, -k |
Uma chave alternativa, por exemplo "col='val'". |
--select, -s |
Uma lista separada por vírgulas de colunas ($select). |
--expand, -x |
Uma expressão OData $expand para registros relacionados. |
--target |
Rotear para dataverse (padrão) ou para o ambiente vinculado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data get Exemplos
dataverse data get --table accounts --id 00000000-0000-0000-0000-000000000001
dataverse data get --target erp --table Currencies --key "CurrencyCode='AED'" --select "CurrencyCode,Name"
data query comando
Execute uma consulta OData, FetchXML ou SQL em uma tabela do Dataverse.
Parâmetros data query
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades a ser consultado. Necessário para consultas OData. |
--select, -s |
Uma lista separada por vírgulas de colunas ($select). |
--filter, -f |
Uma expressão OData $filter . |
--orderby, -o |
Uma expressão OData $orderby . |
--top |
O número máximo de registros a serem retornados (1-5000). |
--expand, -x |
Uma expressão OData $expand para registros relacionados. |
--fetchxml |
Uma consulta FetchXML embutida. |
--fetchxml-file |
O caminho para um arquivo que contém uma consulta FetchXML. |
--sql |
Uma consulta SQL SELECT (versão prévia). |
--sql-file |
O caminho para um arquivo que contém uma consulta SQL. |
--all, -a |
Siga a paginação para recuperar todos os registros. |
--max-records |
O número máximo de registros a serem recuperados ao usar --all. Padrão: 100000. |
--target |
Rotear para dataverse (padrão) ou para o ambiente vinculado erp . |
--cross-company |
Somente ERP. Consultar em todas as empresas. Padrão: a empresa padrão do usuário. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data query Exemplos
dataverse data query --table accounts --select "name,revenue" --filter "revenue gt 1000000"
dataverse data query --fetchxml "<fetch><entity name='account'><attribute name='name'/></entity></fetch>"
dataverse data query --sql "SELECT name, revenue FROM account WHERE revenue > 1000000"
dataverse data query --target erp --table Currencies --select "CurrencyCode,Name" --top 10
Saiba mais
- Usar o OData para consultar dados
- Consultar dados usando FetchXML no Dataverse
- Usar o SQL para consultar dados usando a API Web do Dataverse
data update comando
Atualize um ou mais campos em um registro existente, identificado por sua ID ou por uma chave alternativa. Defina colunas de pesquisa usando @odata.bind a sintaxe.
Parâmetros data update
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades. Required. |
--id, -i |
O GUID de registro. |
--key, -k |
Uma chave alternativa. |
--data, -d |
Um objeto JSON com os campos a serem atualizados. |
--data-file |
O caminho para um arquivo JSON com os dados de atualização. |
--return, -r |
Retorne o registro atualizado completo. |
--target |
Rotear para dataverse (padrão) ou para o ambiente vinculado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data update Exemplos
dataverse data update --table accounts --id 00000000-0000-0000-0000-000000000001 --data '{"name":"Contoso (updated)"}'
data upload comando
Carregue um arquivo local em uma coluna de arquivo do Dataverse em um registro existente. O comando seleciona automaticamente uma solicitação única ou upload em partes com base no tamanho do arquivo, a menos que você especifique --mode. No modo automático, arquivos com menos de 128 MB são carregados em uma única solicitação e arquivos maiores usam um upload em partes. Quando você omite --mime-type, o comando infere o tipo MIME da extensão de arquivo. Extensões desconhecidas padrão para application/octet-stream.
Parâmetros data upload
| Parameter | Description |
|---|---|
--table, -t |
O esquema de tabela ou o nome lógico, como account. Required. O comando resolve o conjunto de entidades de metadados. |
--id, -i |
O GUID de registro. Required. |
--column, -c |
O nome do atributo da coluna de arquivo. Required. |
--file, -f |
O caminho para o arquivo local. Required. |
--mode, -m |
A estratégia de upload: auto (padrão) smallou chunk. |
--mime-type |
Um tipo MIME explícito. Padrão: inferido da extensão de arquivo. |
--overwrite |
Substitua um arquivo existente. Por padrão, o comando falhará se a coluna não estiver vazia. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data upload Exemplos
dataverse data upload --table account --id <guid> --column new_document --file report.pdf
dataverse data upload -t account -i <guid> -c new_document -f photo.jpg --overwrite
dataverse data upload -t account -i <guid> -c new_document -f big.bin --mode chunk
data upsert comando
Crie um registro se ele não existir ou atualize-o se ele existir. O registro é identificado por uma chave alternativa. Saiba como usar uma chave alternativa para fazer referência a um registro
Parâmetros data upsert
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto de entidades. Required. |
--key, -k |
Uma chave alternativa. Required. |
--data, -d |
Um objeto JSON com os valores de campo. |
--data-file |
O caminho para um arquivo JSON. |
--update-only |
Falhará se o registro não existir (If-Match: *). |
--create-only |
Falhará se o registro já existir (If-None-Match: *). |
--return, -r |
Retorne o registro completo após a operação. |
--target |
Rotear para dataverse (padrão) ou para o ambiente vinculado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
data upsert Exemplos
dataverse data upsert --table accounts --key "accountnumber='ACC-100'" --data '{"name":"Contoso"}'
erp batch cancel comando
Cancele um trabalho em lote de Finanças e Operações por sua RecId. Use erp batch list para localizar o RecId.
erp batch cancel Exemplos
dataverse erp batch cancel <recid>
erp batch list comando
Listar trabalhos em lote na instância de Finanças e Operações vinculada ao seu ambiente do Dataverse. O comando requer um perfil de autenticação conectado a um ambiente do Dataverse que tenha uma instância vinculada de Finanças e Operações. A URL de Finanças e Operações é derivada automaticamente da conexão dataverse atual.
Parâmetros erp batch list
| Parameter | Description |
|---|---|
--company |
Filtrar por pessoa jurídica (dataAreaId), como USMF. |
--status |
Filtrar por status: Waiting, , Executing, Finished, Errorou Cancelled. |
--top |
O número máximo de resultados a serem retornados. Padrão: 20. |
--caption |
Filtrar por legenda (correspondência de subcadeia de caracteres que não diferencia maiúsculas de minúsculas). |
--json |
JSON bruto de saída. |
erp batch list Exemplos
dataverse erp batch list
dataverse erp batch list --status Waiting
dataverse erp batch list --status Executing --top 20
install comando
Instale uma versão específica da CLI do Dataverse ou atualize para a versão mais recente. O comando detecta se você instalou a CLI globalmente ou se está usando npx e instala adequadamente.
install Exemplos
Instale a versão mais recente:
dataverse install latest
Instale uma versão específica:
dataverse install 1.0.0
mcp comando
Inicia um servidor MCP (Protocolo de Contexto de Modelo) que se conecta ao seu ambiente, para que assistentes de IA, como o Claude Desktop, possam interagir com seus dados. O destino é detectado automaticamente da URL: uma URL do Dataverse inicia o servidor MCP do Dataverse e uma URL de Finanças e Operações, como https://myorg.operations.dynamics.com, inicia o servidor MCP ERP.
Sintaxe de mcp
dataverse mcp <orgUrl> [options]
O <orgUrl> argumento é a URL da sua organização, por exemplo https://myorg.crm.dynamics.com.
Parâmetros mcp
| Parameter | Description |
|---|---|
--validate |
Valide os pontos de extremidade mcp e a configuração de autenticação sem iniciar o servidor. |
--log-level |
Defina o nível de registro em log: Trace, , Debug, Information, Warning, Errorou Critical. Padrão: Warning. |
--log-file |
Faça logon em um arquivo no diretório temporário. |
--preview |
Use o ponto de extremidade do MCP de visualização (api/mcp_preview em vez de api/mcp). Não há suporte para ERP. |
mcp Exemplos
Validar a configuração (uma primeira etapa recomendada):
dataverse mcp https://myorg.crm.dynamics.com --validate
Inicie o servidor usando o transporte stdio:
dataverse mcp https://myorg.crm.dynamics.com
Use o ponto de extremidade de visualização ou habilite o log de arquivos de depuração:
dataverse mcp https://myorg.crm.dynamics.com --preview
dataverse mcp https://myorg.crm.dynamics.com --log-level Debug --log-file
mcp allow comando
Verifique se um aplicativo Microsoft Entra está na lista de clientes permitidos do DATAverse MCP para o ambiente do perfil atual. Esse comando é uma alternativa à etapa de administrador manual descrita nos pré-requisitos. O usuário autenticado deve ter permissões de administrador do Dataverse no ambiente de destino.
Sintaxe de mcp allow
dataverse mcp allow <appId> [options]
O <appId> argumento é a ID do aplicativo (cliente) a ser permitido, como GUID.
Parâmetros mcp allow
| Parameter | Description |
|---|---|
--erp |
Permitir o aplicativo na instância vinculada de Finanças e Operações em vez do Dataverse. |
mcp allow Exemplos
dataverse mcp allow 0c412cc3-0dd6-449b-987f-05b053db9457
dataverse mcp allow 0c412cc3-0dd6-449b-987f-05b053db9457 --erp
Note
Finanças e Operações armazenam em cache a lista de permissões no AOS, portanto, uma ID de aplicativo recém-permitida pode levar até cinco minutos para entrar em vigor.
org list comando
Liste todos os ambientes que você pode acessar.
Parâmetros org list
| Parameter | Description |
|---|---|
--filter |
Filtre a lista de ambientes por um termo de pesquisa. |
--json |
JSON bruto de saída. |
org list Exemplos
dataverse org list
dataverse org list --filter contoso
dataverse org list --json
org who comando
Mostre informações sobre a organização e o usuário atuais, usando o perfil de autenticação ativo. O env comando é um alias para org.
Parâmetros org who
| Parameter | Description |
|---|---|
--environment, -env |
Substitua a URL do ambiente. |
--json |
JSON bruto de saída. |
org who Exemplos
dataverse org who
dataverse org who --environment https://myorg.crm.dynamics.com
dataverse org who --json
skill comandos
Gerenciar habilidades do Dataverse — conjuntos de instruções reutilizáveis (um SKILL.md arquivo e seus arquivos de recurso) que os agentes de IA usam, que são armazenados no ambiente conectado. Os comandos de nível skill superior fornecem operações de criação, leitura, atualização e exclusão no ambiente. Localmente, as habilidades são armazenadas em .claude/skills/<name>/.
Note
Comandos de criação e avaliação de habilidades, como make, update, gete eval, são separados desses comandos. Para obter mais informações, execute dataverse workspace skill --help.
skill delete comando
Exclua uma habilidade e todos os seus recursos do ambiente ativo do Dataverse. Use skill list para localizar nomes exclusivos de habilidades.
dataverse skill delete new_lead-qualification
skill download comando
Baixe uma ou mais habilidades do ambiente ativo do Dataverse para o disco. O comando baixa o SKILL.md arquivo e todos os arquivos de recurso, preservando a estrutura do diretório. Use skill list para localizar nomes exclusivos de habilidades.
| Parameter | Description |
|---|---|
--all |
Baixe todas as habilidades ativas do ambiente. Não pode ser combinado com um nome exclusivo de habilidade. |
--output, -o |
O diretório base para saída. Padrão: .claude/skills/. Com --all, cada habilidade é escrita para <path>/<name>/. |
--json |
Gere o conteúdo da habilidade como JSON sem gravar arquivos. Opcionalmente, especifique um caminho de arquivo para o qual gravar. |
dataverse skill download new_lead-qualification
dataverse skill download --all --output ./skills
skill list comando
Liste todas as habilidades ativas no ambiente do Dataverse conectado.
| Parameter | Description |
|---|---|
--resources, -r |
Liste também os arquivos de recurso para cada habilidade. |
--json |
Saída como JSON. Opcionalmente, especifique um caminho de arquivo para o qual gravar. |
dataverse skill list
dataverse skill list --resources
skill upload comando
Carregue uma ou mais habilidades do disco para o ambiente ativo do Dataverse. O comando dá suporte a diretórios, arquivos.zip , arquivos .skill e arquivos .md .
Você pode passar uma habilidade <name>, que é resolvida .claude/skills/<name>/ou explícita <path> para um diretório ou arquivo.
| Parameter | Description |
|---|---|
--all |
Carregar todas as habilidades em .claude/skills/. Não pode ser combinado com um nome de habilidade ou caminho. |
--json |
Gerar o resultado como JSON. Opcionalmente, especifique um caminho de arquivo para o qual gravar. |
dataverse skill upload lead-qualification
dataverse skill upload ./my-skill.zip
dataverse skill upload --all