Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Note
- Esta é uma funcionalidade de pré-visualização.
- As funcionalidades de pré-visualização não se destinam a uso em produção e poderão ter funcionalidades restritas. Esses recursos estão disponíveis antes de um lançamento oficial para que os clientes possam obter acesso antecipado e fornecer feedback.
Este artigo descreve os comandos disponíveis na Cli do Dataverse. Cada comando suporta uma --help opção que lista o seu uso, opções e exemplos. Comandos que devolvem dados suportam uma --json opção para saída JSON bruta que é útil em scripts.
As seguintes opções globais podem ser usadas com qualquer comando:
| Option | Description |
|---|---|
--log-level <level> |
Defina o nível de registo: Trace, Debug, Information, Warning, Error, ou Critical. Padrão: Warning. |
--log-file |
Faça login num ficheiro no diretório temporário em vez da consola. |
--context <value> |
Contexto operacional anexado ao User-Agent. Também podes definir a DATAVERSE_OPERATION_CONTEXT variável de ambiente. |
| Command | Description |
|---|---|
api describe |
Descreva uma API |
api invoke |
Invocar uma API por nome |
api list |
Listar APIs descobertas |
api request |
Enviar um pedido HTTP autenticado |
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 |
Liga dois registos através de uma relação |
data count |
Registos de contagem numa tabela |
data create |
Criar um novo registo |
data delete |
Eliminar um registo |
data describe |
Descreva o esquema de uma entidade |
data disassociate |
Remover uma relação entre dois registos |
data get |
Recuperar um único registo por ID ou chave alternativa |
data query |
Executar uma consulta OData, FetchXML ou SQL |
data update |
Atualizar um registo existente |
data upload |
Carregar um ficheiro para uma coluna de ficheiro num registo existente |
data upsert |
Criar ou atualizar um registo por chave alternativa |
erp batch cancel |
Cancelar um trabalho de turma de Finanças e Operações |
erp batch list |
Lista de vagas de turma em Finanças e Operações |
install |
Instala uma versão específica ou atualiza para a versão mais recente |
mcp |
Inicie o servidor MCP para Dataverse ou ERP |
mcp allow |
Permitir uma aplicação como cliente MCP |
org list |
Liste todos os ambientes acessíveis |
org who |
Mostrar organização atual e informações do utilizador |
skill delete |
Apagar uma habilidade do Dataverse |
skill download |
Descarregue uma habilidade do Dataverse |
skill list |
Liste competências ativas no ambiente |
skill upload |
Carregar uma competência para o Dataverse |
Note
Muitos comandos suportam uma --target <dataverse\|erp> opção que encaminha a operação para o Dataverse (o padrão) ou para o ambiente ligado de Finanças e Operações (ERP). Comandos que se ligam a um ambiente suportam uma --environment <url> opção (-env) para sobrescrever a URL do 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 parâmetros de pedido e propriedades de resposta quando os metadados as fornecem.
Os nomes do Dataverse não têm prefixo por defeito. Pode usar nomes qualificados pelo ERP no formulário erp:ServiceGroup/Service/Operation.
api describe Parâmetros
| Parameter | Description |
|---|---|
--target |
Resolver um nome não qualificado contra dataverse ou erp. |
--service-group |
Apenas ERP. Reduza a pesquisa operacional a um único grupo de serviço. |
--service |
Apenas ERP. Reduza a pesquisa operacional a um único serviço. |
--environment |
Sobrepor a URL do ambiente Dataverse. |
--json |
Sair JSON bruto. |
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
Invocar uma API descoberta pelo nome. Use name=value sintaxe para parâmetros. Se um valor contiver espaços, cite o token inteiro. Algumas APIs do Dataverse aceitam um parâmetro de string cujo conteúdo é ele próprio JSON. Nesse caso, passa o texto JSON como valor usando as regras normais de citação e escape do teu shell.
Por defeito, as respostas JSON são renderizadas num formato de texto amigável que mantém os nomes das propriedades de saída. Use --json para preservar a carga útil JSON bruta.
api invoke Parâmetros
| Parameter | Description |
|---|---|
--target |
Resolver um nome não qualificado contra dataverse ou erp. |
--service-group |
Apenas ERP. Reduza a pesquisa operacional a um único grupo de serviço. |
--service |
Apenas ERP. Reduza a pesquisa operacional a um único serviço. |
--param |
Adicione um parâmetro nomeado na name=value forma. Repetível. |
--bind |
O caminho de ligação para APIs Dataverse vinculadas a entidades. |
--method, -X |
Sobrepor o método HTTP inferido. |
--body |
Usa um corpo JSON bruto em vez de parâmetros nomeados. |
--body-file |
Lê um corpo JSON bruto a partir de um ficheiro. |
--header, -H |
Adicione um cabeçalho HTTP no key:value formulário. |
--include, -i |
Inclua o estado da resposta e os cabeçalhos. |
--environment |
Sobrepor a URL do ambiente Dataverse. |
--json |
Produz JSON bruto em vez de texto amigável. |
api invoke exemplos
Invocar uma função do Dataverse. Este exemplo mostra a utilização da função Dynamics 365 Contact Center CCaaS_GetPresence.
dataverse api invoke CCaaS_GetPresence ApiVersion=1.0
Invocar a ação AISummarize do Dataverse com espaços num valor de parâmetro:
dataverse api invoke AISummarize "Text=The customer reported intermittent login failures..."
Invocar um serviço personalizado ERP:
dataverse api invoke GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService
api list comando
Liste APIs descobertas, como APIs personalizadas do Dataverse e endpoints de serviço invocáveis ERP. Os resultados mostram a identidade da API, nome amigo, tipo e descrição quando disponíveis. Pode passar um termo de consulta opcional para filtrar os resultados.
api list Parâmetros
| Parameter | Description |
|---|---|
--target |
O sistema alvo para pesquisar: dataverse (por defeito) ou erp. |
--service-group |
Apenas ERP. Filtra para um único grupo de serviço. |
--service |
Apenas ERP. Filtre para um único serviço. |
--limit |
O número máximo de APIs a devolver. Padrão: 50. |
--page |
O número de página baseado em 1 ao folhear os resultados. Padrão: 1. |
--environment |
Sobrepor a URL do ambiente Dataverse. |
--json |
Sair JSON bruto. |
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 um pedido HTTP autenticado bruto para o Dataverse ou ERP. Use este comando quando precisar de controlo total sobre o caminho, método, cabeçalhos e corpo.
api request Parâmetros
| Parameter | Description |
|---|---|
--target |
O sistema alvo: dataverse ou erp. Required. |
--path |
O caminho da solicitação. Required. |
--method, -X |
O método HTTP. Padrão: GET, ou POST quando um corpo é fornecido. |
--body |
Um corpo de pedido JSON inline. |
--body-file |
Um ficheiro que contém o corpo de um pedido de objeto JSON. |
--header, -H |
Adicione um cabeçalho HTTP no key:value formulário. |
--include, -i |
Inclua o estado da resposta e os cabeçalhos. |
--environment |
Sobrepor a URL do ambiente 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.
auth create Parâmetros
Use estes parâmetros para especificar o comportamento do auth create comando.
| Parameter | Description |
|---|---|
--environment, -env |
A URL do ambiente Dataverse com que queres autenticar-te. |
--name, -n |
Um nome opcional para o perfil. Use o nome para selecionar o perfil mais tarde. |
--cloud, -ci |
A nuvem alvo: Public, UsGov, UsGovHigh, UsGovDod, ou China. |
--deviceCode, -dc |
Use o fluxo de autenticação por código de dispositivo, para ambientes sem navegador. |
--username, -un |
O nome de utilizador para autenticação de nome de utilizador e palavra-passe. |
--password, -p |
A palavra-passe para a autenticação do nome de utilizador e palavra-passe. |
--applicationId, -id |
O ID da aplicação (cliente) para a autenticação do principal de serviço (SPN). |
--clientSecret, -cs |
O segredo do cliente para a autenticação do principal de serviço. |
--certificateDiskPath, -cdp |
O caminho para um ficheiro de certificado .pfx para autenticação baseada em certificados. |
--certificatePassword, -cp |
A palavra-passe do certificado. |
--tenant, -t |
O ID do locatário. Exigido para autenticação do principal de serviço. |
--managedIdentity, -mi |
Use uma identidade gerida no Azure. |
--githubFederated, -ghf |
Use a autenticação federada do GitHub Actions. |
--azureDevOpsFederated, -adof |
Use a autenticação federada do Azure DevOps. |
--clientid, -cid |
Um ID de cliente personalizado da aplicação Microsoft Entra para usar em vez da aplicação CLI padrão do Dataverse. |
--no-default-environment |
Não definas o ambiente como padrão. |
--accept-cleartext-caching |
Permitir uma cache de token em texto simples no Linux. |
auth create exemplos
Os exemplos seguintes demonstram como usar o auth create comando.
Autenticação interativa
Este comando abre um navegador ou diálogo do sistema para informações adicionais.
dataverse auth create --environment https://myorg.crm.dynamics.com
Perfil nomeado
Cria 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 navegador.
dataverse auth create --environment https://myorg.crm.dynamics.com --deviceCode
Principal de serviço com segredo de cliente
Use um princípio de serviço quando precisar de autenticação desatendida, como num pipeline CI/CD ou noutro script automatizado onde não é possível iniciar sessão interativamente. Forneça o ID da aplicação, o segredo do cliente e o ID do inquilino de um registo de aplicação que tenha acesso ao ambiente.
dataverse auth create --applicationId <appId> --clientSecret <secret> --tenant <tenantId>
ID de cliente personalizado da aplicação Entra
Use o seu próprio registo na aplicação em vez do padrão.
dataverse auth create --environment https://myorg.crm.dynamics.com --clientid <your-app-guid>
auth list comando
Liste 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.
auth remove Parâmetros
| Parameter | Description |
|---|---|
--index, -i |
Remova o perfil com o índice baseado em 1 especificado, como mostrado em auth list. |
--name, -n |
Remova o perfil com o nome especificado. |
--all |
Remover 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. Executa o comando sem opções para listar todos os perfis.
auth select Parâmetros
| Parameter | Description |
|---|---|
--index, -i |
Selecione o perfil pelo seu índice baseado em 1, como mostrado em auth list. |
--name, -n |
Selecione o perfil pelo nome. |
auth select exemplos
Abre um seletor interativo. Use as teclas de seta, ou escreva 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 atual. Adicionar --json para saída JSON bruta.
auth who exemplos
dataverse auth who
dataverse auth who --json
data associate comando
Associe dois registos através de uma propriedade de navegação (relação). Este comando é suportado apenas para Dataverse.
data associate Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O nome de conjunto da entidade do registo primário. Required. |
--id, -i |
O GUID do registo principal. 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 registo relacionado. Required. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
data associate exemplos
dataverse data associate --table accounts --id <guid> --relationship contact_customer_accounts --related contacts --related-id <related-guid>
data count comando
Contar os registos numa tabela, opcionalmente filtrados.
data count Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto da entidade. Obrigatório, a menos que use --fetchxml. |
--filter, -f |
Uma expressão OData $filter . |
--fetchxml |
Uma consulta agregada FetchXML para contagens complexas. |
--target |
Rotear para dataverse (por defeito) ou para o ambiente ligado erp . |
--cross-company |
Apenas ERP. Conte em todas as empresas. Padrão: a empresa padrão do utilizador. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
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 registo numa tabela Dataverse. Defina colunas de pesquisa usando @odata.bind sintaxe.
data create Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto da entidade. Required. |
--data, -d |
Um objeto JSON com os valores do campo. |
--data-file |
O caminho para um ficheiro JSON com os dados do registo. |
--return, -r |
Devolva o registo completo criado. |
--target |
Rotear para dataverse (por defeito) ou para o ambiente ligado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
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>)"}'
Tip
Use --data-file para JSON complexo. Use --return --json para obter o registo completo criado.
data delete comando
Apague um único registo pela sua chave primária ou por uma chave alternativa.
data delete Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto da entidade. Required. |
--id, -i |
O registo GUID. |
--key, -k |
Uma tonalidade alternativa. |
--no-confirm |
Ignora o prompt de confirmação. |
--target |
Rotear para dataverse (por defeito) ou para o ambiente ligado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
data delete exemplos
dataverse data delete --table accounts --id 00000000-0000-0000-0000-000000000001 --no-confirm
data describe comando
Descreva o esquema de uma entidade OData. Para o Dataverse, o comando chama EntityDefinitions(LogicalName='<table>') com $expand conduzido por --include, mais uma segunda chamada para customapis quando --include actions está definido. As ações integradas do Dataverse como Assign e SetState não são enumeradas. Para ERP, uma única chamada para /Metadata/PublicEntities devolve propriedades, ações vinculadas e navegações em conjunto.
data describe Parâmetros
| Parameter | Description |
|---|---|
--target |
O alvo: dataverse (padrão) ou erp. |
--table, -t |
Required. Para 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 secções para incluir: entity, properties, relations, actions, ou all. Pseudónimos: attributes=properties, relationships=relations. Padrão para ERP: all. Padrão para o Dataverse: entity,properties. |
--json |
Sair JSON bruto. |
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
Elimine uma relação entre dois discos. Este comando é suportado apenas para Dataverse.
data disassociate Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O nome de conjunto da entidade do registo primário. Required. |
--id, -i |
O GUID do registo principal. Required. |
--relationship, -rel |
O nome da propriedade de navegação. Required. |
--related-id |
O GUID do registo relacionado, para uma relação muitos-para-muitos. Omita este parâmetro para limpar uma pesquisa. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
data disassociate exemplos
dataverse data disassociate --table accounts --id <guid> --relationship contact_customer_accounts --related-id <related-guid>
data get comando
Recuperar um único registo pelo seu ID (chave primária) ou por uma chave alternativa.
data get Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto da entidade. Required. |
--id, -i |
O registo GUID (chave primária). |
--key, -k |
Uma tonalidade alternativa, por exemplo "col='val'". |
--select, -s |
Uma lista separada por vírgulas de colunas ($select). |
--expand, -x |
Uma expressão OData $expand para registos relacionados. |
--target |
Rotear para dataverse (por defeito) ou para o ambiente ligado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
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 numa tabela Dataverse.
data query Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
A entidade define o nome para consultar. Obrigató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 registos a devolver (1-5000). |
--expand, -x |
Uma expressão OData $expand para registos relacionados. |
--fetchxml |
Uma consulta FetchXML inline. |
--fetchxml-file |
O caminho para um ficheiro que contém uma consulta FetchXML. |
--sql |
Uma consulta SQL SELECT (pré-visualização). |
--sql-file |
O caminho para um ficheiro que contém uma consulta SQL. |
--all, -a |
Siga a paginação para obter todos os registos. |
--max-records |
O número máximo de registos a recuperar ao usar --all. Padrão: 100000. |
--target |
Rotear para dataverse (por defeito) ou para o ambiente ligado erp . |
--cross-company |
Apenas ERP. Faça consultas em todas as empresas. Padrão: a empresa padrão do utilizador. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
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
Mais informações
- Usar OData para consultar dados
- Consultar Dados Usando FetchXML no Dataverse
- Use SQL para consultar dados utilizando a API Web do Dataverse
data update comando
Atualize um ou mais campos num registo existente, identificados pelo seu ID ou por uma chave alternativa. Defina colunas de pesquisa usando @odata.bind sintaxe.
data update Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto da entidade. Required. |
--id, -i |
O registo GUID. |
--key, -k |
Uma tonalidade alternativa. |
--data, -d |
Um objeto JSON com os campos a atualizar. |
--data-file |
O caminho para um ficheiro JSON com os dados de atualização. |
--return, -r |
Devolva o registo completo atualizado. |
--target |
Rotear para dataverse (por defeito) ou para o ambiente ligado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
data update exemplos
dataverse data update --table accounts --id 00000000-0000-0000-0000-000000000001 --data '{"name":"Contoso (updated)"}'
data upload comando
Carregue um ficheiro local numa coluna de ficheiro Dataverse num registo existente. O comando seleciona automaticamente um pedido único ou um upload em blocos com base no tamanho do ficheiro, a menos que especifique --mode. No modo automático, ficheiros com menos de 128 MB são carregados num único pedido, e ficheiros maiores usam um upload em blocos. Quando omites --mime-type, o comando infere o tipo MIME a partir da extensão do ficheiro. Extensões desconhecidas por defeito para application/octet-stream.
data upload Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O esquema da tabela ou nome lógico, como account. Required. O comando resolve o conjunto de entidades a partir dos metadados. |
--id, -i |
O registo GUID. Required. |
--column, -c |
O nome do atributo da coluna do ficheiro. Required. |
--file, -f |
O caminho para o ficheiro local. Required. |
--mode, -m |
A estratégia de upload: auto (por defeito), small, ou chunk. |
--mime-type |
Um tipo MIME explícito. Padrão: inferido a partir da extensão do ficheiro. |
--overwrite |
Sobrescrever um ficheiro existente. Por defeito, o comando falha se a coluna não estiver vazia. |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
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
Cria um registo se não existir, ou atualiza-o se existir. O registo é identificado por uma tonalidade alternativa. Aprenda a usar uma chave alternativa para referenciar um registo
data upsert Parâmetros
| Parameter | Description |
|---|---|
--table, -t |
O nome do conjunto da entidade. Required. |
--key, -k |
Uma tonalidade alternativa. Required. |
--data, -d |
Um objeto JSON com os valores do campo. |
--data-file |
O caminho para um ficheiro JSON. |
--update-only |
Reprovar se o registo não existir (If-Match: *). |
--create-only |
Reprovar se o registo já existir (If-None-Match: *). |
--return, -r |
Devolva o registo completo após a operação. |
--target |
Rotear para dataverse (por defeito) ou para o ambiente ligado erp . |
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
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 pelo seu RecId. Use erp batch list para encontrar o RecId.
erp batch cancel exemplos
dataverse erp batch cancel <recid>
erp batch list comando
Lista os trabalhos em lote na instância de Finanças e Operações que está ligada ao teu ambiente Dataverse. O comando requer um perfil de autenticação ligado a um ambiente Dataverse que tenha uma instância de Finanças e Operações ligada. O URL de Finanças e Operações é derivado automaticamente da ligação atual ao Dataverse.
erp batch list Parâmetros
| Parameter | Description |
|---|---|
--company |
Filtrar por entidade legal (dataAreaId), como USMF. |
--status |
Filtrar por estado: Waiting, Executing, Finished, Error, ou Cancelled. |
--top |
O número máximo de resultados a serem retornados. Padrão: 20. |
--caption |
Filtrar por legenda (correspondência de substrings insensíveis a maiúsculas minúsculas). |
--json |
Sair JSON bruto. |
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 deteta se instalou a CLI globalmente ou se está a usar npx e instala em conformidade.
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 Model Context Protocol (MCP) que se liga ao seu ambiente, para que assistentes de IA como o Claude Desktop possam interagir com os seus dados. O destino é detetado automaticamente a partir 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 ERP MCP.
mcp sintaxe
dataverse mcp <orgUrl> [options]
O <orgUrl> argumento é, por exemplo https://myorg.crm.dynamics.com, o URL da sua organização.
mcp Parâmetros
| Parameter | Description |
|---|---|
--validate |
Valida os endpoints MCP e a configuração de autenticação sem iniciar o servidor. |
--log-level |
Defina o nível de registo: Trace, Debug, Information, Warning, Error, ou Critical. Padrão: Warning. |
--log-file |
Aceda a um ficheiro no diretório temporário. |
--preview |
Use o endpoint de pré-visualização MCP (api/mcp_preview em vez de api/mcp). Não é suportado para ERP. |
mcp exemplos
Valide a configuração (um primeiro passo recomendado):
dataverse mcp https://myorg.crm.dynamics.com --validate
Inicia o servidor usando o transporte stdio:
dataverse mcp https://myorg.crm.dynamics.com
Use o endpoint de pré-visualização, ou ative o registo de ficheiros 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
Certifique-se de que uma aplicação Microsoft Entra está na lista de clientes permitidos do Dataverse MCP para o ambiente do perfil atual. Este comando é uma alternativa ao passo manual de administração descrito nos pré-requisitos. O utilizador autenticado deve ter permissões de administrador do Dataverse no ambiente de destino.
mcp allow sintaxe
dataverse mcp allow <appId> [options]
O <appId> argumento é o ID da aplicação (cliente) a permitir, como um GUID.
mcp allow Parâmetros
| Parameter | Description |
|---|---|
--erp |
Permita a aplicação na instância ligada 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
O departamento de Finanças e Operações armazena em cache a lista de permissões no AOS, por isso um ID de aplicação recém-autorizado pode demorar cerca de cinco minutos a entrar em vigor.
org list comando
Lista todos os ambientes a que consegues aceder.
org list Parâmetros
| Parameter | Description |
|---|---|
--filter |
Filtra a lista de ambientes por um termo de pesquisa. |
--json |
Sair JSON bruto. |
org list exemplos
dataverse org list
dataverse org list --filter contoso
dataverse org list --json
org who comando
Mostrar informações sobre a organização atual e o utilizador, utilizando o perfil de autenticação ativa. O env comando é um pseudónimo para org.
org who Parâmetros
| Parameter | Description |
|---|---|
--environment, -env |
Substitua a URL do ambiente. |
--json |
Sair JSON bruto. |
org who exemplos
dataverse org who
dataverse org who --environment https://myorg.crm.dynamics.com
dataverse org who --json
skill comandos
Gerir competências do Dataverse — conjuntos de instruções reutilizáveis (um SKILL.md ficheiro e os seus ficheiros de recursos) que os agentes de IA utilizam — que são armazenadas no ambiente ligado. Os comandos de topo skill fornecem operações de criar, ler, atualizar e eliminar o ambiente. Localmente, as competências são armazenadas em .claude/skills/<name>/.
Note
Comandos de autoria e avaliação de competências, como make, update, get, e eval, são separados destes comandos. Para obter mais informações, execute dataverse workspace skill --help.
skill delete comando
Apagar uma habilidade e todos os seus recursos do ambiente ativo do Dataverse. Use skill list para encontrar nomes únicos de habilidades.
dataverse skill delete new_lead-qualification
skill download comando
Descarregue uma ou mais competências do ambiente Dataverse ativo para disco. O comando descarrega o SKILL.md ficheiro e todos os ficheiros de recursos, preservando a estrutura de diretórios. Use skill list para encontrar nomes únicos de habilidades.
| Parameter | Description |
|---|---|
--all |
Descarregue todas as competências ativas do ambiente. Não pode ser combinado com o nome único de uma habilidade. |
--output, -o |
O diretório base para a saída. Padrão: .claude/skills/. Com --all, cada habilidade é escrita para <path>/<name>/. |
--json |
Produz o conteúdo da skill em JSON sem escrever ficheiros. Opcionalmente, especifique um caminho de ficheiro para escrever. |
dataverse skill download new_lead-qualification
dataverse skill download --all --output ./skills
skill list comando
Liste todas as competências ativas no ambiente Dataverse conectado.
| Parameter | Description |
|---|---|
--resources, -r |
Também liste os ficheiros de recursos para cada habilidade. |
--json |
Saída como JSON. Opcionalmente, especifique um caminho de ficheiro para escrever. |
dataverse skill list
dataverse skill list --resources
skill upload comando
Carrega uma ou mais competências do disco para o ambiente ativo do Dataverse. O comando suporta diretórios, ficheiros.zip , ficheiros .skill e ficheiros .md .
Podes passar uma habilidade <name>, que resolve para .claude/skills/<name>/, ou uma explícita <path> para um diretório ou ficheiro.
| Parameter | Description |
|---|---|
--all |
Carregar todas as competências em .claude/skills/. Não pode ser combinado com um nome ou caminho de habilidade. |
--json |
Produz o resultado em JSON. Opcionalmente, especifique um caminho de ficheiro para escrever. |
dataverse skill upload lead-qualification
dataverse skill upload ./my-skill.zip
dataverse skill upload --all