การอ้างอิง CLI ของข้อมูล (ตัวอย่าง)

Note

  • คุณลักษณะนี้เป็นคุณลักษณะพรีวิว
  • คุณลักษณะการแสดงตัวอย่างไม่ได้มีไว้สำหรับการนำไปใช้งานจริง และอาจมีการจำกัดฟังก์ชันการทำงาน คุณลักษณะเหล่านี้สามารถใช้ได้ก่อนการเปิดตัวอย่างเป็นทางการ เพื่อให้ลูกค้าสามารถเข้าใช้งานได้ก่อนเวลาและให้ข้อคิดเห็น

บทความนี้อธิบายคําสั่งที่พร้อมใช้งานใน Dataverse CLI ทุกคําสั่งสนับสนุน --help ตัวเลือกที่แสดงรายการการใช้งาน ตัวเลือก และตัวอย่าง คําสั่งที่ส่งกลับข้อมูลรองรับ --json ตัวเลือกสําหรับเอาต์พุต JSON ดิบที่มีประโยชน์ในสคริปต์

ตัวเลือกส่วนกลางต่อไปนี้สามารถใช้ได้กับคําสั่งใด ๆ:

ตัวเลือก Description
--log-level <level> ตั้งค่าระดับการบันทึก: Trace, Debug, Information, Warning, , ErrorหรือCritical ค่าเริ่มต้น: Warning
--log-file ล็อกไฟล์ในไดเรกทอรีชั่วคราวแทนคอนโซล
--context <value> บริบทการดําเนินการผนวกเข้ากับ User-Agent คุณยังสามารถตั้งค่า DATAVERSE_OPERATION_CONTEXT ตัวแปรสภาพแวดล้อมได้
คำสั่ง Description
api describe อธิบาย API
api invoke เรียกใช้ API ตามชื่อ
api list API ที่ค้นพบได้ของรายการ
api request ส่งคําขอ HTTP ที่รับรองความถูกต้องแล้ว
auth create สร้างโปรไฟล์การรับรองความถูกต้องใหม่
auth list แสดงรายการโปรไฟล์การรับรองความถูกต้องทั้งหมด
auth remove เอาโปรไฟล์การรับรองความถูกต้องออก
auth select เลือกโปรไฟล์การรับรองความถูกต้องที่ใช้งานอยู่
auth who แสดงโปรไฟล์การรับรองความถูกต้องปัจจุบัน
data associate เชื่อมโยงสองระเบียนผ่านความสัมพันธ์
data count นับจํานวนระเบียนในตาราง
data create สร้างเรกคอร์ดใหม่
data delete ลบระเบียน
data describe อธิบายสคีมาของเอนทิตี
data disassociate ลบความสัมพันธ์ระหว่างสองระเบียน
data get เรียกใช้เรกคอร์ดเดี่ยวตามรหัสหรือคีย์สํารอง
data query ดําเนินการคิวรี OData, FetchXML หรือ SQL
data update ปรับปรุงเรกคอร์ดที่มีอยู่
data upload อัปโหลดไฟล์ไปยังคอลัมน์ไฟล์บนเรกคอร์ดที่มีอยู่
data upsert สร้างหรืออัปเดตระเบียนโดยคีย์สํารอง
erp batch cancel ยกเลิกชุดงานการเงินและการดําเนินงาน
erp batch list แสดงรายการชุดงานการเงินและการดําเนินงาน
install ติดตั้งเวอร์ชันเฉพาะหรืออัปเดตเป็นเวอร์ชันล่าสุด
mcp เริ่มเซิร์ฟเวอร์ MCP สําหรับ Dataverse หรือ ERP
mcp allow อนุญาตให้แอปเป็นไคลเอ็นต์ MCP
org list แสดงรายการสภาพแวดล้อมที่สามารถเข้าถึงได้ทั้งหมด
org who แสดงข้อมูลองค์กรและผู้ใช้ปัจจุบัน
skill delete ลบทักษะจาก Dataverse
skill download ดาวน์โหลดทักษะจาก Dataverse
skill list แสดงรายการทักษะที่ใช้งานอยู่ในสภาพแวดล้อม
skill upload อัปโหลดทักษะไปยัง Dataverse

Note

คําสั่งจํานวนมากสนับสนุน --target <dataverse\|erp> ตัวเลือกที่กําหนดเส้นทางการดําเนินการไปยัง Dataverse (ค่าเริ่มต้น) หรือไปยังสภาพแวดล้อม Finance and Operations (ERP) ที่เชื่อมโยง คําสั่งที่เชื่อมต่อกับตัวเลือกการสนับสนุน --environment <url> สภาพแวดล้อม (-env) เพื่อแทนที่ URL สภาพแวดล้อมของโปรไฟล์ปัจจุบัน

api describe สั่ง

แสดงเมตาดาต้าสําหรับ API เดียว สําหรับ Dataverse แบบกําหนดเอง API ผลลัพธ์จะประกอบด้วยพารามิเตอร์คําขอและคําอธิบายคุณสมบัติการตอบสนองเมื่อเมตาดาต้าให้

ชื่อ Dataverse จะไม่ถูกแก้ไขตามค่าเริ่มต้น คุณสามารถใช้ชื่อที่มีคุณสมบัติ ERP ในแบบฟอร์ม erp:ServiceGroup/Service/Operationได้

api describe พารามิเตอร์

พารามิเตอร์ Description
--target แก้ไขชื่อที่ไม่เหมาะสมกับ dataverse หรือerp
--service-group ERP เท่านั้น จํากัดการค้นหาการดําเนินงานเป็นกลุ่มบริการหนึ่งกลุ่ม
--service ERP เท่านั้น จํากัดการค้นหาการดําเนินการให้เป็นบริการเดียว
--environment แทนที่ URL ของสภาพแวดล้อม Dataverse
--json ส่งออก JSON ดิบ

api describe ตัว อย่าง เช่น

dataverse api describe sample_CustomAPIExample
dataverse api describe msdyn_DoesKBExist
dataverse api describe GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService

api invoke สั่ง

เรียกใช้ API ที่ค้นพบตามชื่อ ใช้ name=value ไวยากรณ์สําหรับพารามิเตอร์ ถ้าค่ามีช่องว่าง ให้อ้างอิงโทเค็นทั้งหมด Dataverse API บางตัวจะยอมรับพารามิเตอร์สตริงที่มีเนื้อหาเป็นตัว JSON เอง ในกรณีดังกล่าว ให้ส่งผ่านข้อความ JSON เป็นค่าโดยใช้กฎการ quoting และ escaping ปกติของเชลล์ของคุณ

ตามค่าเริ่มต้น การตอบสนอง JSON จะแสดงในรูปแบบข้อความจําง่ายที่เก็บชื่อคุณสมบัติผลลัพธ์ ใช้ --json เพื่อรักษาส่วนข้อมูล JSON ดิบ

api invoke พารามิเตอร์

พารามิเตอร์ Description
--target แก้ไขชื่อที่ไม่เหมาะสมกับ dataverse หรือerp
--service-group ERP เท่านั้น จํากัดการค้นหาการดําเนินงานเป็นกลุ่มบริการหนึ่งกลุ่ม
--service ERP เท่านั้น จํากัดการค้นหาการดําเนินการให้เป็นบริการเดียว
--param เพิ่มพารามิเตอร์ที่มีชื่อในแบบฟอร์มname=value ทําซ้ําได้
--bind เส้นทางการผูกสําหรับ API ที่ผูกกับเอนทิตี้ Dataverse
--method, -X แทนที่วิธีการ HTTP อนุมาน
--body ใช้เนื้อความ JSON ดิบแทนพารามิเตอร์ที่มีชื่อ
--body-file อ่านเนื้อความ JSON ดิบจากไฟล์
--header, -H เพิ่มส่วนหัว HTTP ในแบบฟอร์มkey:value
--include, -i รวมสถานะการตอบสนองและส่วนหัว
--environment แทนที่ URL ของสภาพแวดล้อม Dataverse
--json ส่งออกข้อมูล JSON ดิบแทนข้อความที่เป็นมิตร

api invoke ตัว อย่าง เช่น

เรียกใช้ฟังก์ชัน Dataverse ตัวอย่างนี้แสดงการใช้ฟังก์ชัน CCaaS_GetPresence Dynamics 365 Contact Center

dataverse api invoke CCaaS_GetPresence ApiVersion=1.0

เรียกใช้ การดําเนินการ Dataverse AISummarize พร้อมช่องว่างในค่าพารามิเตอร์:

dataverse api invoke AISummarize "Text=The customer reported intermittent login failures..."

เรียกใช้บริการแบบกําหนดเองของ ERP:

dataverse api invoke GetUserSessionInfo --target erp --service-group UserSessionService --service AifUserSessionService

api list สั่ง

รายการ API ที่ค้นพบได้ เช่น API แบบกําหนดเองของ Dataverse และจุดสิ้นสุดของบริการที่สามารถเรียกใช้ได้ของ ERP ผลลัพธ์แสดงข้อมูลประจําตัวของ API ชื่อที่เรียกง่าย ชนิด และคําอธิบายเมื่อพร้อมใช้งาน คุณสามารถส่งผ่านคําคิวรีทางเลือกเพื่อกรองผลลัพธ์ได้

api list พารามิเตอร์

พารามิเตอร์ Description
--target ระบบเป้าหมายในการค้นหา: dataverse (ค่าเริ่มต้น) หรือerp
--service-group ERP เท่านั้น กรองไปยังกลุ่มบริการเดียว
--service ERP เท่านั้น กรองไปยังบริการเดียว
--limit จํานวนสูงสุดของ API ที่จะแสดง ค่าเริ่มต้น: 50
--page หมายเลขหน้าแบบ 1 เมื่อแบ่งหน้าผ่านผลลัพธ์ ค่าเริ่มต้น: 1
--environment แทนที่ URL ของสภาพแวดล้อม Dataverse
--json ส่งออก JSON ดิบ

api list ตัว อย่าง เช่น

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 สั่ง

ส่งคําขอ HTTP ที่รับรองความถูกต้องดิบไปยัง Dataverse หรือ ERP ใช้คําสั่งนี้เมื่อคุณต้องการควบคุมเส้นทาง วิธีการ ส่วนหัว และเนื้อความทั้งหมด

api request พารามิเตอร์

พารามิเตอร์ Description
--target ระบบเป้าหมาย: dataverse หรือerp จำเป็น
--path เส้นทางการร้องขอ จำเป็น
--method, -X เมธอด HTTP ค่าเริ่มต้น: GETหรือ POST เมื่อมีการระบุเนื้อความ
--body เนื้อความคําขอ JSON แบบอินไลน์
--body-file ไฟล์ที่มีเนื้อความการร้องขอออบเจ็กต์ JSON
--header, -H เพิ่มส่วนหัว HTTP ในแบบฟอร์มkey:value
--include, -i รวมสถานะการตอบสนองและส่วนหัว
--environment แทนที่ URL ของสภาพแวดล้อม Dataverse

api request ตัว อย่าง เช่น

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 สั่ง

สร้างโปรไฟล์การรับรองความถูกต้องใหม่

auth create พารามิเตอร์

ใช้พารามิเตอร์เหล่านี้เพื่อระบุลักษณะการทํางานของ auth create คําสั่ง

พารามิเตอร์ Description
--environment, -env URL สําหรับสภาพแวดล้อม Dataverse ที่คุณต้องการรับรองความถูกต้อง
--name, -n ชื่อที่เลือกได้สําหรับโพรไฟล์ ใช้ชื่อเพื่อเลือกโปรไฟล์ในภายหลัง
--cloud, -ci ระบบคลาวด์เป้าหมาย: Public, UsGov, UsGovHigh, UsGovDodหรือChina
--deviceCode, -dc ใช้โฟลว์การรับรองความถูกต้องของรหัสอุปกรณ์สําหรับสภาพแวดล้อมที่ไม่มีเบราว์เซอร์
--username, -un ชื่อผู้ใช้สําหรับการรับรองความถูกต้องชื่อผู้ใช้และรหัสผ่าน
--password, -p รหัสผ่านสําหรับการรับรองความถูกต้องชื่อผู้ใช้และรหัสผ่าน
--applicationId, -id ID แอปพลิเคชัน (ไคลเอนต์) สําหรับการรับรองความถูกต้องโครงร่างสําคัญของบริการ (SPN)
--clientSecret, -cs ข้อมูลลับของไคลเอ็นต์สําหรับการรับรองความถูกต้องแบบโครงร่างสําคัญของบริการ
--certificateDiskPath, -cdp เส้นทางไปยังไฟล์ใบรับรอง .pfx สําหรับการรับรองความถูกต้องตามใบรับรอง
--certificatePassword, -cp รหัสผ่านสําหรับใบรับรอง
--tenant, -t ID ผู้เช่า จําเป็นสําหรับการรับรองความถูกต้องแบบโครงร่างสําคัญของบริการ
--managedIdentity, -mi ใช้ข้อมูลประจําตัวที่มีการจัดการ Azure
--githubFederated, -ghf ใช้การรับรองความถูกต้อง GitHub Actions ภายนอก
--azureDevOpsFederated, -adof ใช้การรับรองความถูกต้อง Azure DevOps ภายนอก
--clientid, -cid MICROSOFT ENTRA ID ไคลเอ็นต์ของแอปแบบกําหนดเองที่จะใช้แทนแอป Dataverse CLI เริ่มต้น
--no-default-environment อย่าตั้งค่าสภาพแวดล้อมเป็นค่าเริ่มต้น
--accept-cleartext-caching อนุญาตให้มีแคชโทเค็นข้อความธรรมดาบน Linux

auth create ตัว อย่าง เช่น

ตัวอย่างต่อไปนี้สาธิตวิธีการใช้ auth create คําสั่ง

การรับรองความถูกต้องแบบโต้ตอบ

คําสั่งนี้จะเปิดเบราว์เซอร์หรือกล่องโต้ตอบระบบสําหรับข้อมูลเพิ่มเติม

dataverse auth create --environment https://myorg.crm.dynamics.com

โปรไฟล์ที่มีชื่อ

สร้างโปรไฟล์ที่มีชื่อเฉพาะ

dataverse auth create --environment https://myorg.crm.dynamics.com --name prod

โฟลว์รหัสอุปกรณ์

ใช้โฟลว์รหัสอุปกรณ์สําหรับสภาพแวดล้อมโดยไม่มีเบราว์เซอร์

dataverse auth create --environment https://myorg.crm.dynamics.com --deviceCode

บริการหลักพร้อมข้อมูลลับไคลเอ็นต์

ใช้บริการหลักเมื่อคุณต้องการการรับรองความถูกต้องแบบผู้ใช้ไม่ต้องใส่ข้อมูล เช่น ในไปป์ไลน์ CI/CD หรือสคริปต์อัตโนมัติอื่นที่ไม่สามารถลงชื่อเข้าใช้แบบโต้ตอบได้ ระบุ ID แอปพลิเคชัน ข้อมูลลับไคลเอ็นต์ และ ID ผู้เช่าของการลงทะเบียนแอปที่มีสิทธิ์เข้าถึงสภาพแวดล้อม

dataverse auth create --applicationId <appId> --clientSecret <secret> --tenant <tenantId>

ID ไคลเอ็นต์ของแอป Entra แบบกําหนดเอง

ใช้การลงทะเบียนแอปของคุณเองแทนค่าเริ่มต้น

dataverse auth create --environment https://myorg.crm.dynamics.com --clientid <your-app-guid>

auth list สั่ง

ทํารายการโปรไฟล์การรับรองความถูกต้องทั้งหมด เพิ่ม --json สําหรับเอาต์พุต JSON ดิบ

auth list ตัว อย่าง เช่น

dataverse auth list
dataverse auth list --json

auth remove สั่ง

ลบโปรไฟล์การรับรองความถูกต้องหนึ่งรายการหรือทั้งหมด

auth remove พารามิเตอร์

พารามิเตอร์ Description
--index, -i ลบโปรไฟล์ที่มีดัชนีพื้นฐาน 1 รายการที่ระบุ ดังที่แสดงในauth list
--name, -n ลบโพรไฟล์ที่มีชื่อที่ระบุออก
--all ลบโปรไฟล์ทั้งหมด

auth remove ตัว อย่าง เช่น

dataverse auth remove --index 1
dataverse auth remove --name prod
dataverse auth remove --all

auth select สั่ง

เลือกโปรไฟล์การรับรองความถูกต้องที่ใช้งานอยู่ เรียกใช้คําสั่งโดยไม่มีตัวเลือกในการแสดงรายการโปรไฟล์ทั้งหมด

auth select พารามิเตอร์

พารามิเตอร์ Description
--index, -i เลือกโปรไฟล์ตามดัชนีพื้นฐาน 1 ดังที่แสดงในauth list
--name, -n เลือกโปรไฟล์ตามชื่อ

auth select ตัว อย่าง เช่น

เปิดตัวเลือกแบบโต้ตอบ ใช้แป้นลูกศร หรือพิมพ์ เพื่อกรอง:

dataverse auth select

เลือกโปรไฟล์ตามดัชนีหรือตามชื่อ:

dataverse auth select --index 1
dataverse auth select --name prod

auth who สั่ง

แสดงโปรไฟล์การรับรองความถูกต้องที่ใช้งานอยู่ในปัจจุบัน เพิ่ม --json สําหรับเอาต์พุต JSON ดิบ

auth who ตัว อย่าง เช่น

dataverse auth who
dataverse auth who --json

data associate สั่ง

เชื่อมโยงระเบียนสองระเบียนผ่านคุณสมบัติการนําทาง (ความสัมพันธ์) คําสั่งนี้ได้รับการสนับสนุนสําหรับ Dataverse เท่านั้น

data associate พารามิเตอร์

พารามิเตอร์ Description
--table, -t ชื่อชุดเอนทิตีของระเบียนหลัก จำเป็น
--id, -i GUID ของระเบียนหลัก จำเป็น
--relationship, -rel ชื่อคุณสมบัติการนําทาง จำเป็น
--related ชื่อชุดเอนทิตีของตารางที่เกี่ยวข้อง จำเป็น
--related-id GUID ของระเบียนที่เกี่ยวข้อง จำเป็น
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data associate ตัว อย่าง เช่น

dataverse data associate --table accounts --id <guid> --relationship contact_customer_accounts --related contacts --related-id <related-guid>

data count สั่ง

นับจํานวนเรกคอร์ดในตาราง เป็นทางเลือกในการกรองข้อมูล

data count พารามิเตอร์

พารามิเตอร์ Description
--table, -t ชื่อชุดเอนทิตี จําเป็นเว้นแต่ว่าคุณใช้--fetchxml
--filter, -f นิพจน์ OData $filter
--fetchxml คิวรีรวม FetchXML สําหรับจํานวนที่ซับซ้อน
--target กําหนดเส้นทางไปยัง dataverse (ค่าเริ่มต้น) หรือสภาพแวดล้อมที่เชื่อมโยงerp
--cross-company ERP เท่านั้น นับจํานวนทั่วทั้งบริษัท ค่าเริ่มต้น: บริษัทเริ่มต้นของผู้ใช้
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data count ตัว อย่าง เช่น

dataverse data count --table accounts
dataverse data count --target erp --table Currencies --filter "CurrencyCode eq 'AED'"

data create สั่ง

สร้างระเบียนใหม่ในตาราง Dataverse ตั้งค่าคอลัมน์การค้นหาโดยใช้ @odata.bind ไวยากรณ์

data create พารามิเตอร์

พารามิเตอร์ Description
--table, -t ชื่อชุดเอนทิตี จำเป็น
--data, -d ออบเจ็กต์ JSON ที่มีค่าเขตข้อมูล
--data-file เส้นทางไปยังไฟล์ JSON ด้วยข้อมูลระเบียน
--return, -r ส่งกลับระเบียนที่สร้างขึ้นแบบเต็ม
--target กําหนดเส้นทางไปยัง dataverse (ค่าเริ่มต้น) หรือสภาพแวดล้อมที่เชื่อมโยงerp
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data create ตัว อย่าง เช่น

dataverse data create --table accounts --data '{"name":"Contoso"}'
dataverse data create --table contacts --data '{"firstname":"Alice","parentcustomerid_account@odata.bind":"accounts(<guid>)"}'

Tip

ใช้สําหรับ --data-file JSON ที่ซับซ้อน ใช้ --return --json เพื่อรับระเบียนที่สร้างขึ้นทั้งหมด

data delete สั่ง

ลบระเบียนเดียวตามคีย์หลักหรือโดยคีย์สํารอง

data delete พารามิเตอร์

พารามิเตอร์ Description
--table, -t ชื่อชุดเอนทิตี จำเป็น
--id, -i GUID สําหรับระเบียน
--key, -k คีย์สํารอง
--no-confirm ข้ามพร้อมท์การยืนยัน
--target กําหนดเส้นทางไปยัง dataverse (ค่าเริ่มต้น) หรือสภาพแวดล้อมที่เชื่อมโยงerp
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data delete ตัว อย่าง เช่น

dataverse data delete --table accounts --id 00000000-0000-0000-0000-000000000001 --no-confirm

data describe สั่ง

อธิบายสคีมาของเอนทิตี OData สําหรับ Dataverse คําสั่งเรียก EntityDefinitions(LogicalName='<table>') ด้วย $expand driven by --includeบวกการเรียกครั้งที่สองเมื่อต้องการ customapis เมื่อ --include actions ถูกตั้งค่า ไม่มีการระบุการดําเนินการของข้อมูลที่มีอยู่ภายใน เช่น Assign และSetState สําหรับ ERP การเรียกเดียวเพื่อ /Metadata/PublicEntities ส่งกลับคุณสมบัติ การดําเนินการที่ผูกไว้ และการนําทางร่วมกัน

data describe พารามิเตอร์

พารามิเตอร์ Description
--target เป้าหมาย: dataverse (ค่าเริ่มต้น) หรือerp
--table, -t จำเป็น สําหรับ Dataverse ชื่อตรรกะ เช่นaccount สําหรับ ERP ชื่อชุดเอนทิตีเช่นBatchJobs
--include รายการส่วนที่ใช้จุลภาคเป็นตัวคั่นเพื่อรวม: entity, properties, relations, actions, หรือall นามแฝง: attributes, relationships=relations=properties ค่าเริ่มต้นสําหรับ ERP: all ค่าเริ่มต้นสําหรับ Dataverse: entity,properties
--json ส่งออก JSON ดิบ

data describe ตัว อย่าง เช่น

dataverse data describe --table account
dataverse data describe --target dataverse --table account --include all
dataverse data describe --target erp --table BatchJobs

data disassociate สั่ง

ลบความสัมพันธ์ระหว่างสองระเบียน คําสั่งนี้ได้รับการสนับสนุนสําหรับ Dataverse เท่านั้น

data disassociate พารามิเตอร์

พารามิเตอร์ Description
--table, -t ชื่อชุดเอนทิตีของระเบียนหลัก จำเป็น
--id, -i GUID ของระเบียนหลัก จำเป็น
--relationship, -rel ชื่อคุณสมบัติการนําทาง จำเป็น
--related-id GUID ของระเบียนที่เกี่ยวข้องสําหรับความสัมพันธ์แบบกลุ่มต่อกลุ่ม ไม่ใช้พารามิเตอร์นี้เพื่อล้างการค้นหา
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data disassociate ตัว อย่าง เช่น

dataverse data disassociate --table accounts --id <guid> --relationship contact_customer_accounts --related-id <related-guid>

data get สั่ง

เรียกใช้เรกคอร์ดเดี่ยวตาม ID (คีย์หลัก) หรือโดยคีย์สํารอง

data get พารามิเตอร์

พารามิเตอร์ Description
--table, -t ชื่อชุดเอนทิตี จำเป็น
--id, -i GUID ของระเบียน (คีย์หลัก)
--key, -k คีย์สํารอง ตัวอย่างเช่น"col='val'"
--select, -s รายการของคอลัมน์ ($select) ที่ใช้จุลภาคเป็นตัวคั่น
--expand, -x นิพจน์ OData $expand สําหรับระเบียนที่เกี่ยวข้อง
--target กําหนดเส้นทางไปยัง dataverse (ค่าเริ่มต้น) หรือสภาพแวดล้อมที่เชื่อมโยงerp
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data get ตัว อย่าง เช่น

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 สั่ง

ดําเนินการคิวรี OData, FetchXML หรือ SQL กับตาราง Dataverse

data query พารามิเตอร์

พารามิเตอร์ Description
--table, -t เอนทิตีตั้งชื่อเป็นคิวรี จําเป็นสําหรับคิวรี OData
--select, -s รายการของคอลัมน์ ($select) ที่ใช้จุลภาคเป็นตัวคั่น
--filter, -f นิพจน์ OData $filter
--orderby, -o นิพจน์ OData $orderby
--top จํานวนสูงสุดของระเบียนที่จะแสดง (1-5000)
--expand, -x นิพจน์ OData $expand สําหรับระเบียนที่เกี่ยวข้อง
--fetchxml คิวรี FetchXML แบบอินไลน์
--fetchxml-file เส้นทางไปยังไฟล์ที่มีคิวรี FetchXML
--sql คิวรี SQL SELECT (ตัวอย่าง)
--sql-file เส้นทางไปยังไฟล์ที่มีคิวรี SQL
--all, -a ทําตามการแบ่งหน้าเพื่อเรียกใช้ระเบียนทั้งหมด
--max-records จํานวนสูงสุดของระเบียนที่ดึงข้อมูลเมื่อใช้--all ค่าเริ่มต้น: 100000
--target กําหนดเส้นทางไปยัง dataverse (ค่าเริ่มต้น) หรือสภาพแวดล้อมที่เชื่อมโยงerp
--cross-company ERP เท่านั้น สอบถามทั่วทั้งบริษัท ค่าเริ่มต้น: บริษัทเริ่มต้นของผู้ใช้
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data query ตัว อย่าง เช่น

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

ศึกษาเพิ่มเติม

data update สั่ง

อัปเดตเขตข้อมูลอย่างน้อยหนึ่งเขตขึ้นไปบนระเบียนที่มีอยู่ ซึ่งระบุโดย ID หรือโดยคีย์สํารอง ตั้งค่าคอลัมน์การค้นหาโดยใช้ @odata.bind ไวยากรณ์

data update พารามิเตอร์

พารามิเตอร์ Description
--table, -t ชื่อชุดเอนทิตี จำเป็น
--id, -i GUID สําหรับระเบียน
--key, -k คีย์สํารอง
--data, -d วัตถุ JSON ที่มีเขตข้อมูลสําหรับอัปเดต
--data-file เส้นทางไปยังไฟล์ JSON ด้วยข้อมูลการอัปเดต
--return, -r ส่งกลับเรกคอร์ดที่อัปเดตทั้งหมด
--target กําหนดเส้นทางไปยัง dataverse (ค่าเริ่มต้น) หรือสภาพแวดล้อมที่เชื่อมโยงerp
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data update ตัว อย่าง เช่น

dataverse data update --table accounts --id 00000000-0000-0000-0000-000000000001 --data '{"name":"Contoso (updated)"}'

data upload สั่ง

อัปโหลดไฟล์ภายในเครื่องลงในคอลัมน์ไฟล์ Dataverse บนระเบียนที่มีอยู่ คําสั่ง จะเลือกการร้องขอเดียวหรือการอัปโหลดเป็นกลุ่มโดยอัตโนมัติโดยยึดตามขนาดไฟล์ เว้นแต่ว่าคุณระบุ--mode ในโหมดอัตโนมัติ ไฟล์ที่ต่ํากว่า 128 MB จะถูกอัปโหลดในคําขอเดียว และไฟล์ขนาดใหญ่กว่าจะใช้การอัปโหลดเป็นกลุ่ม เมื่อคุณไม่ใช้ --mime-typeคําสั่ง จะอนุมานชนิด MIME จากนามสกุลไฟล์ ส่วนขยายที่ไม่รู้จักค่าเริ่มต้นเป็นapplication/octet-stream

data upload พารามิเตอร์

พารามิเตอร์ Description
--table, -t สคีมาของตารางหรือชื่อตรรกะ เช่นaccount จำเป็น คําสั่งแก้ไขเอนทิตีที่ตั้งค่าจากเมตาดาต้า
--id, -i GUID สําหรับระเบียน จำเป็น
--column, -c ชื่อแอตทริบิวต์คอลัมน์ของไฟล์ จำเป็น
--file, -f เส้นทางไปยังไฟล์ภายในเครื่อง จำเป็น
--mode, -m กลยุทธ์การอัปโหลด: auto (ค่าเริ่มต้น) smallหรือchunk
--mime-type ชนิด MIME ที่ชัดเจน ค่าเริ่มต้น: อนุมานจากนามสกุลไฟล์
--overwrite เขียนทับแฟ้มที่มีอยู่ ตามค่าเริ่มต้น คําสั่งจะล้มเหลวถ้าคอลัมน์ไม่ว่างเปล่า
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data upload ตัว อย่าง เช่น

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 สั่ง

สร้างระเบียนถ้าไม่มีอยู่ หรืออัปเดตถ้าเป็นเช่นนั้น ระเบียนจะถูกระบุโดยคีย์สํารอง เรียนรู้วิธีการใช้คีย์สํารองเพื่ออ้างอิงระเบียน

data upsert พารามิเตอร์

พารามิเตอร์ Description
--table, -t ชื่อชุดเอนทิตี จำเป็น
--key, -k คีย์สํารอง จำเป็น
--data, -d ออบเจ็กต์ JSON ที่มีค่าเขตข้อมูล
--data-file เส้นทางไปยังไฟล์ JSON
--update-only ล้มเหลวถ้าไม่มีระเบียน (If-Match: *)
--create-only ล้มเหลวถ้ามีเรกคอร์ดอยู่แล้ว (If-None-Match: *)
--return, -r ส่งกลับเรกคอร์ดทั้งหมดหลังจากการดําเนินการ
--target กําหนดเส้นทางไปยัง dataverse (ค่าเริ่มต้น) หรือสภาพแวดล้อมที่เชื่อมโยงerp
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

data upsert ตัว อย่าง เช่น

dataverse data upsert --table accounts --key "accountnumber='ACC-100'" --data '{"name":"Contoso"}'

erp batch cancel สั่ง

ยกเลิกชุดงาน การเงินและการดําเนินงาน ด้วยRecId ใช้ erp batch list เพื่อค้นหาRecId

erp batch cancel ตัว อย่าง เช่น

dataverse erp batch cancel <recid>

erp batch list สั่ง

แสดงรายการชุดงานบนอินสแตนซ์การเงินและการดําเนินการที่เชื่อมโยงกับสภาพแวดล้อม Dataverse ของคุณ คําสั่งจําเป็นต้องมีโปรไฟล์การรับรองความถูกต้องที่เชื่อมต่อกับสภาพแวดล้อม Dataverse ที่มีอินสแตนซ์การเงินและการดําเนินการที่เชื่อมโยง URL การเงินและการดําเนินการได้รับมาจากการเชื่อมต่อ Dataverse ปัจจุบันโดยอัตโนมัติ

erp batch list พารามิเตอร์

พารามิเตอร์ Description
--company กรองตามเอนทิตีทางกฎหมาย (dataAreaId) เช่นUSMF
--status กรองตามสถานะ: Waiting, Executing, Finished, ErrorหรือCancelled
--top จํานวนสูงสุดของผลลัพธ์ที่จะแสดง ค่าเริ่มต้น: 20
--caption กรองตามคําอธิบาย (ตรงกันกับสตริงย่อยที่ไม่ตรงตามตัวพิมพ์ใหญ่-เล็ก)
--json ส่งออก JSON ดิบ

erp batch list ตัว อย่าง เช่น

dataverse erp batch list
dataverse erp batch list --status Waiting
dataverse erp batch list --status Executing --top 20

install สั่ง

ติดตั้ง Dataverse CLI เวอร์ชันเฉพาะ หรืออัปเดตเป็นเวอร์ชันล่าสุด คําสั่ง ตรวจสอบว่าคุณได้ติดตั้ง CLI ส่วนกลาง หรือกําลังใช้ npx และติดตั้งตามลําดับ

install ตัว อย่าง เช่น

ติดตั้งเวอร์ชันล่าสุด:

dataverse install latest

ติดตั้งเวอร์ชันที่เจาะจง:

dataverse install 1.0.0

mcp สั่ง

เริ่มต้นเซิร์ฟเวอร์ Model Context Protocol (MCP) ที่เชื่อมต่อกับสภาพแวดล้อมของคุณ เพื่อให้ผู้ช่วย AI เช่น Claude Desktop สามารถโต้ตอบกับข้อมูลของคุณ เป้าหมายจะถูกตรวจพบโดยอัตโนมัติจาก URL: URL Dataverse เริ่มต้นเซิร์ฟเวอร์ Dataverse MCP และ URL การเงินและการดําเนินการ เช่น https://myorg.operations.dynamics.comเริ่มต้นเซิร์ฟเวอร์ ERP MCP

ไวยากรณ์ mcp

dataverse mcp <orgUrl> [options]

อาร์กิวเมนต์ <orgUrl> คือ URL ขององค์กรของคุณ ตัวอย่างเช่นhttps://myorg.crm.dynamics.com

mcp พารามิเตอร์

พารามิเตอร์ Description
--validate ตรวจสอบความถูกต้องของจุดสิ้นสุด MCP และการตั้งค่าการรับรองความถูกต้องโดยไม่ต้องเริ่มต้นเซิร์ฟเวอร์
--log-level ตั้งค่าระดับการบันทึก: Trace, Debug, Information, Warning, , ErrorหรือCritical ค่าเริ่มต้น: Warning
--log-file ล็อกไฟล์ในไดเรกทอรีชั่วคราว
--preview ใช้จุดสิ้นสุด MCP ตัวอย่าง (api/mcp_preview แทน api/mcp) ไม่สนับสนุนสําหรับ ERP

mcp ตัว อย่าง เช่น

ตรวจสอบการตั้งค่า (ขั้นตอนแรกที่แนะนํา):

dataverse mcp https://myorg.crm.dynamics.com --validate

เริ่มเซิร์ฟเวอร์โดยใช้การส่งข้อมูล stdio:

dataverse mcp https://myorg.crm.dynamics.com

ใช้จุดสิ้นสุดการแสดงตัวอย่าง หรือเปิดใช้งานการบันทึกไฟล์ดีบัก:

dataverse mcp https://myorg.crm.dynamics.com --preview
dataverse mcp https://myorg.crm.dynamics.com --log-level Debug --log-file

mcp allow สั่ง

ตรวจสอบให้แน่ใจว่าแอปพลิเคชัน Microsoft Entra อยู่ในรายการไคลเอ็นต์ที่อนุญาต Dataverse MCP สําหรับสภาพแวดล้อมของโปรไฟล์ปัจจุบัน คําสั่งนี้เป็นทางเลือกสําหรับขั้นตอนผู้ดูแลระบบด้วยตนเองตามที่อธิบายไว้ในข้อกําหนดเบื้องต้น ผู้ใช้ที่ได้รับการรับรองความถูกต้องต้องมีสิทธิ์ผู้ดูแลระบบ Dataverse บนสภาพแวดล้อมเป้าหมาย

ไวยากรณ์ mcp allow

dataverse mcp allow <appId> [options]

อาร์กิวเมนต์ <appId> คือ ID แอปพลิเคชัน (ไคลเอ็นต์) ที่จะอนุญาตเป็น GUID

mcp allow พารามิเตอร์

พารามิเตอร์ Description
--erp อนุญาตให้แอปพลิเคชันบนอินสแตนซ์การเงินและการดําเนินการที่เชื่อมโยงแทน Dataverse

mcp allow ตัว อย่าง เช่น

dataverse mcp allow 0c412cc3-0dd6-449b-987f-05b053db9457
dataverse mcp allow 0c412cc3-0dd6-449b-987f-05b053db9457 --erp

Note

การเงินและการดําเนินการจะแคชรายการที่อนุญาตใน AOS ดังนั้น ID แอปที่ได้รับอนุญาตใหม่อาจใช้เวลาประมาณห้านาทีจึงจะมีผล

org list สั่ง

ระบุสภาพแวดล้อมทั้งหมดที่คุณสามารถเข้าถึงได้

org list พารามิเตอร์

พารามิเตอร์ Description
--filter กรองรายการของสภาพแวดล้อมตามคําที่ใช้ค้นหา
--json ส่งออก JSON ดิบ

org list ตัว อย่าง เช่น

dataverse org list
dataverse org list --filter contoso
dataverse org list --json

org who สั่ง

แสดงข้อมูลเกี่ยวกับองค์กรและผู้ใช้ปัจจุบัน โดยใช้โปรไฟล์การรับรองความถูกต้องที่ใช้งานอยู่ คําสั่ง env เป็นนามแฝงสําหรับorg

org who พารามิเตอร์

พารามิเตอร์ Description
--environment, -env แทนที่ URL สภาพแวดล้อม
--json ส่งออก JSON ดิบ

org who ตัว อย่าง เช่น

dataverse org who
dataverse org who --environment https://myorg.crm.dynamics.com
dataverse org who --json

คําสั่ง skill

จัดการทักษะ Dataverse — ชุดคําแนะนําที่นํากลับมาใช้ใหม่ได้ ( SKILL.md ไฟล์และไฟล์ทรัพยากร) ที่ตัวแทน AI ใช้ - ซึ่งถูกเก็บไว้ในสภาพแวดล้อมที่เชื่อมต่อกัน คําสั่งระดับ skill บนสุดมีการดําเนินการสร้าง อ่าน อัปเดต และลบกับสภาพแวดล้อม ภายในเครื่อง ทักษะจะถูกเก็บไว้ภายใต้.claude/skills/<name>/

Note

คําสั่งการสร้างและการประเมินทักษะ เช่น make, update, getและ evalจะแยกต่างหากจากคําสั่งเหล่านี้ สําหรับข้อมูลเพิ่มเติม ให้เรียกใช้dataverse workspace skill --help

skill delete สั่ง

ลบทักษะและทรัพยากรทั้งหมดออกจากสภาพแวดล้อม Dataverse ที่ใช้งานอยู่ ใช้ skill list เพื่อค้นหาชื่อเฉพาะของทักษะ

dataverse skill delete new_lead-qualification

skill download สั่ง

ดาวน์โหลดอย่างน้อยหนึ่งทักษะจากสภาพแวดล้อม Dataverse ที่ใช้งานอยู่ไปยังดิสก์ คําสั่งจะ SKILL.md ดาวน์โหลดไฟล์และไฟล์ทรัพยากรทั้งหมด โดยคงโครงสร้างไดเรกทอรีไว้ ใช้ skill list เพื่อค้นหาชื่อเฉพาะของทักษะ

พารามิเตอร์ Description
--all ดาวน์โหลดทักษะที่ใช้งานอยู่ทั้งหมดจากสภาพแวดล้อม ไม่สามารถรวมกับชื่อเฉพาะของทักษะได้
--output, -o ไดเรกทอรีพื้นฐานสําหรับเอาต์พุต ค่าเริ่มต้น: .claude/skills/ ด้วย --allแต่ละทักษะจะถูกเขียนถึง<path>/<name>/
--json ส่งออกเนื้อหาทักษะเป็น JSON โดยไม่ต้องเขียนไฟล์ หรือระบุเส้นทางของไฟล์ที่จะเขียนถึง 
dataverse skill download new_lead-qualification
dataverse skill download --all --output ./skills

skill list สั่ง

แสดงรายการทักษะที่ใช้งานอยู่ทั้งหมดในสภาพแวดล้อม Dataverse ที่เชื่อมต่อ

พารามิเตอร์ Description
--resources, -r นอกจากนี้ยังแสดงรายการไฟล์ทรัพยากรสําหรับแต่ละทักษะ
--json แสดงผลเป็น JSON หรือระบุเส้นทางของไฟล์ที่จะเขียนถึง 
dataverse skill list
dataverse skill list --resources

skill upload สั่ง

อัปโหลดทักษะอย่างน้อยหนึ่งทักษะจากดิสก์ไปยังสภาพแวดล้อม Dataverse ที่ใช้งานอยู่ คําสั่ง สนับสนุนไดเรกทอรี ไฟล์.zip ไฟล์ .skill และไฟล์ .md

คุณสามารถผ่านทักษะ <name>ซึ่งแก้ไขเป็น .claude/skills/<name>/หรือระบุอย่างชัดเจน <path> ไปยังไดเรกทอรีหรือไฟล์

พารามิเตอร์ Description
--all อัปโหลดทักษะทั้งหมดภายใต้.claude/skills/ ไม่สามารถรวมกับชื่อทักษะหรือเส้นทางได้
--json แสดงผลลัพธ์เป็น JSON หรือระบุเส้นทางของไฟล์ที่จะเขียนถึง 
dataverse skill upload lead-qualification
dataverse skill upload ./my-skill.zip
dataverse skill upload --all

ดูเพิ่มเติม

ทํางานกับข้อมูลโดยใช้ Dataverse CLI

  • Last updated on