Reference
Source code
<?xml version="1.0" encoding="utf-8"?>
<ApiConfig Name="Cosmos DB"
Desc="Read and write Azure Cosmos DB data effortlessly. Query, integrate, and manage databases, containers, documents, and users — almost no coding required."
Version="2"
Slug="cosmosdb-connector"
Id="b892d532-b55f-4c6c-b719-96a100bffae6"
EngineVersion="12"
Logo="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJYAAACWCAYAAAA8AXHiAAAKN2lDQ1BzUkdCIElFQzYxOTY2LTIuMQAAeJydlndUU9kWh8+9N71QkhCKlNBraFICSA29SJEuKjEJEErAkAAiNkRUcERRkaYIMijggKNDkbEiioUBUbHrBBlE1HFwFBuWSWStGd+8ee/Nm98f935rn73P3Wfvfda6AJD8gwXCTFgJgAyhWBTh58WIjYtnYAcBDPAAA2wA4HCzs0IW+EYCmQJ82IxsmRP4F726DiD5+yrTP4zBAP+flLlZIjEAUJiM5/L42VwZF8k4PVecJbdPyZi2NE3OMErOIlmCMlaTc/IsW3z2mWUPOfMyhDwZy3PO4mXw5Nwn4405Er6MkWAZF+cI+LkyviZjg3RJhkDGb+SxGXxONgAoktwu5nNTZGwtY5IoMoIt43kA4EjJX/DSL1jMzxPLD8XOzFouEiSniBkmXFOGjZMTi+HPz03ni8XMMA43jSPiMdiZGVkc4XIAZs/8WRR5bRmyIjvYODk4MG0tbb4o1H9d/JuS93aWXoR/7hlEH/jD9ld+mQ0AsKZltdn6h21pFQBd6wFQu/2HzWAvAIqyvnUOfXEeunxeUsTiLGcrq9zcXEsBn2spL+jv+p8Of0NffM9Svt3v5WF485M4knQxQ143bmZ6pkTEyM7icPkM5p+H+B8H/nUeFhH8JL6IL5RFRMumTCBMlrVbyBOIBZlChkD4n5r4D8P+pNm5lona+BHQllgCpSEaQH4eACgqESAJe2Qr0O99C8ZHA/nNi9GZmJ37z4L+fVe4TP7IFiR/jmNHRDK4ElHO7Jr8WgI0IABFQAPqQBvoAxPABLbAEbgAD+ADAkEoiARxYDHgghSQAUQgFxSAtaAYlIKtYCeoBnWgETSDNnAYdIFj4DQ4By6By2AE3AFSMA6egCnwCsxAEISFyBAVUod0IEPIHLKFWJAb5AMFQxFQHJQIJUNCSAIVQOugUqgcqobqoWboW+godBq6AA1Dt6BRaBL6FXoHIzAJpsFasBFsBbNgTzgIjoQXwcnwMjgfLoK3wJVwA3wQ7oRPw5fgEVgKP4GnEYAQETqiizARFsJGQpF4JAkRIauQEqQCaUDakB6kH7mKSJGnyFsUBkVFMVBMlAvKHxWF4qKWoVahNqOqUQdQnag+1FXUKGoK9RFNRmuizdHO6AB0LDoZnYsuRlegm9Ad6LPoEfQ4+hUGg6FjjDGOGH9MHCYVswKzGbMb0445hRnGjGGmsVisOtYc64oNxXKwYmwxtgp7EHsSewU7jn2DI+J0cLY4X1w8TogrxFXgWnAncFdwE7gZvBLeEO+MD8Xz8MvxZfhGfA9+CD+OnyEoE4wJroRIQiphLaGS0EY4S7hLeEEkEvWITsRwooC4hlhJPEQ8TxwlviVRSGYkNimBJCFtIe0nnSLdIr0gk8lGZA9yPFlM3kJuJp8h3ye/UaAqWCoEKPAUVivUKHQqXFF4pohXNFT0VFysmK9YoXhEcUjxqRJeyUiJrcRRWqVUo3RU6YbStDJV2UY5VDlDebNyi/IF5UcULMWI4kPhUYoo+yhnKGNUhKpPZVO51HXURupZ6jgNQzOmBdBSaaW0b2iDtCkVioqdSrRKnkqNynEVKR2hG9ED6On0Mvph+nX6O1UtVU9Vvuom1TbVK6qv1eaoeajx1UrU2tVG1N6pM9R91NPUt6l3qd/TQGmYaYRr5Grs0Tir8XQObY7LHO6ckjmH59zWhDXNNCM0V2ju0xzQnNbS1vLTytKq0jqj9VSbru2hnaq9Q/uE9qQOVcdNR6CzQ+ekzmOGCsOTkc6oZPQxpnQ1df11Jbr1uoO6M3rGelF6hXrtevf0Cfos/ST9Hfq9+lMGOgYhBgUGrQa3DfGGLMMUw12G/YavjYyNYow2GHUZPTJWMw4wzjduNb5rQjZxN1lm0mByzRRjyjJNM91tetkMNrM3SzGrMRsyh80dzAXmu82HLdAWThZCiwaLG0wS05OZw2xljlrSLYMtCy27LJ9ZGVjFW22z6rf6aG1vnW7daH3HhmITaFNo02Pzq62ZLde2xvbaXPJc37mr53bPfW5nbse322N3055qH2K/wb7X/oODo4PIoc1h0tHAMdGx1vEGi8YKY21mnXdCO3k5rXY65vTW2cFZ7HzY+RcXpkuaS4vLo3nG8/jzGueNueq5clzrXaVuDLdEt71uUnddd457g/sDD30PnkeTx4SnqWeq50HPZ17WXiKvDq/XbGf2SvYpb8Tbz7vEe9CH4hPlU+1z31fPN9m31XfKz95vhd8pf7R/kP82/xsBWgHcgOaAqUDHwJWBfUGkoAVB1UEPgs2CRcE9IXBIYMj2kLvzDecL53eFgtCA0O2h98KMw5aFfR+OCQ8Lrwl/GGETURDRv4C6YMmClgWvIr0iyyLvRJlESaJ6oxWjE6Kbo1/HeMeUx0hjrWJXxl6K04gTxHXHY+Oj45vipxf6LNy5cDzBPqE44foi40V5iy4s1licvvj4EsUlnCVHEtGJMYktie85oZwGzvTSgKW1S6e4bO4u7hOeB28Hb5Lvyi/nTyS5JpUnPUp2Td6ePJninlKR8lTAFlQLnqf6p9alvk4LTduf9ik9Jr09A5eRmHFUSBGmCfsytTPzMoezzLOKs6TLnJftXDYlChI1ZUPZi7K7xTTZz9SAxESyXjKa45ZTk/MmNzr3SJ5ynjBvYLnZ8k3LJ/J9879egVrBXdFboFuwtmB0pefK+lXQqqWrelfrry5aPb7Gb82BtYS1aWt/KLQuLC98uS5mXU+RVtGaorH1futbixWKRcU3NrhsqNuI2ijYOLhp7qaqTR9LeCUXS61LK0rfb+ZuvviVzVeVX33akrRlsMyhbM9WzFbh1uvb3LcdKFcuzy8f2x6yvXMHY0fJjpc7l+y8UGFXUbeLsEuyS1oZXNldZVC1tep9dUr1SI1XTXutZu2m2te7ebuv7PHY01anVVda926vYO/Ner/6zgajhop9mH05+x42Rjf2f836urlJo6m06cN+4X7pgYgDfc2Ozc0tmi1lrXCrpHXyYMLBy994f9Pdxmyrb6e3lx4ChySHHn+b+O31w0GHe4+wjrR9Z/hdbQe1o6QT6lzeOdWV0iXtjusePhp4tLfHpafje8vv9x/TPVZzXOV42QnCiaITn07mn5w+lXXq6enk02O9S3rvnIk9c60vvG/wbNDZ8+d8z53p9+w/ed71/LELzheOXmRd7LrkcKlzwH6g4wf7HzoGHQY7hxyHui87Xe4Znjd84or7ldNXva+euxZw7dLI/JHh61HXb95IuCG9ybv56Fb6ree3c27P3FlzF3235J7SvYr7mvcbfjT9sV3qID0+6j068GDBgztj3LEnP2X/9H686CH5YcWEzkTzI9tHxyZ9Jy8/Xvh4/EnWk5mnxT8r/1z7zOTZd794/DIwFTs1/lz0/NOvm1+ov9j/0u5l73TY9P1XGa9mXpe8UX9z4C3rbf+7mHcTM7nvse8rP5h+6PkY9PHup4xPn34D94Tz+49wZioAAAAJcEhZcwAACxIAAAsSAdLdfvwAACAASURBVHic7X0JnBTF2fdTPbP3zS57cK+CyIIKsiySoGICIiqoiZrjTTwSJSZGE4FlF5O8hC9R2V0CbyQmwcTXJCZfPu9EjQfgGa89gAhyCMu5u+zssvd9zHR9T830Ud3TM9Mz08OuOv/f7nR3dXVVdfe/n+eppy47pRSiiMJq2Ee6AFF8NhElVhQRQUSIteEtsPclOV7A3cvx/4dl83Ifj0Q+UYxeRIRYPQnNBQLAMvcBgbvxN0qszxkiQiwBxEzlgEJGJPKIYnQjIsQiAoyV65oEICsSeUQxuhERYolAzyOMUsAEFqT+ZFdL3gNzsxojkVcUoxORkVhA5vPHTuqah5sXIpFXFKMTlhPr3trauERIvox3uxKgiyFKrM8VLCdWXFvS1ZRAKh9GKXxtw1uwav0icFqdXxSjE5YTSyDkewbB2X3JjusBcp+xOr8oRicsJVbxrqb5AsBSw5MU7t8A8Nx6ZttH8ZmHZcRC0giCSP/HT5Q5/dWN34V5eX+wKs8oRi8sI1ZfjWM1bi7xF4eCUF5c1bSzoijnuFX5RjE6YQmxSiodV4AADwSOSdMFAk8V721aVHFhTq8VeUcxOhE2sdZVNs5Fi/153I0xeUmhMEif2fDWiRvWL5oyEG7+UYxOhEWskprmJUQgrKaXGjCyFlf1JcW/uu7dUzc8tHBSezhliGJ0IiRifW8XxKSJjnUE4L8pgC3EvC8X42J3l1Y3/9fGednvh5hGFKMUQROrtKpxaTohm3B3lgX5T6Eg/rukuumxYefwhs0LJjRYkGYUowCmiHV/VUOmKAg3UkruAEIKLS6DgEb9nTF2+y0l1Y7/ByL8+fip3HeeuglcFufzmcSGXY2JgwCTXKIwHiidQARIpiIku08SiMX/JPcuhUFKoAdE0kaAOlxUqBOcwvGyL2Z1R6JcGmK52/nakhdjAbIJpRmUCNOxRHOB2OYwX0EkCsAhDv9vxVxuzZ/i6CypgXdRze4XKJwASjpFm3iofG7e7giXYVTC/WHbhBn40c2gQKZjEPufgqRBMhGpvxt191Fyj40h3MWU27jPUfdGICJArAj4MZ/A430Y/B4hwr+PnciutOKj1hArsSP5CSTVTe4yEOIpycgM4knDfK/BElzjzh7vmoiEllY5lm8syv1XpDK9YsNb9tOdrkk2QrOpTcwSqDCWEjoWyzKGncdS9OPX7qnJUjqEFZd66iJ1ILpOHvyfpQ5Kw39aJXtaxoHLVQgivRgJMheDcGsbZ9heYc27mUI8JF2OZgngR91SUg0v4kP/W/m8nDdCZYCGWPhgzrWkqJEBoQLkW5XYRcXbk5wEXx7YZqN0vggl5Wy8/1l2O2GSEw8F95dPPD98MaSNtGVVF5sNCop3DM0shlOEkl0iiJWYVuVAauzu4+sX+XWprKl0FNhsdCGqqIWY9EIMyuezGQGwjpm3IxtuX1vtOFxK6OaExPbH1xcUDAWTiJZYAr2TiMIqAmKOCCQN7+08YNJjZMC+/1P4gFEVQi9K0gPOYedj4SRYsHbHNBTF1wiEXo0S+TICgptEMkmEEF6mfAlKs1jcTMWAqUjKr7HPPLF3eHjm2h27UBC86AT63Cebrjy0Zldjlp0Ki/ErXopxltoEyMMyjSSR/OE8tKt/39c7prS4qnFVRVHe82Yv1BBLsmG+xYet231mqig6v4QZfA3vfRFARG2tNnzYT+JDfikp0fbO+oKxPeEmyMgkiHAHSrsbUPpM83CIaEhE5F/dyw30rrV9zjwhXJdsRrYY/LkEn9gldiAPXLhu58FZc8bXj5ucfq5NIOeEfldnHVMEQp5De+w5YXDoDjO+x4C1wocuHluLG/b/6NrKM9ME4irFD+xWCN1/ZYQ6fBEPJfQOPG6FN57c/LRtxuQxV6Dy/BGS6Rp8sYRwvPFwi6j7/LVBSA6NjUw9F6sSzG0aojCiSlzRBTP21jTM+KimHrKyUw4VzM5rTU2LKwLzrRYjja+IcbFziiubr6+Yn73XX8Sg/Fjl88cewc131+5qfASN6T/i/pxwSgmeLjRbxDiy3oq2w1l3v5VME4bvLchP/yHaTXksTCaKbCvxZFBJpBLCrNSiugM5LSr9SlUfd8qqFKNKWGtzz/nvbD8CCfExdQVz8g7ljU8rQiaOlNkRDPIFgb5dXNV8dUVR9ge+IoXkeWcq897a2gUJ7SkP4+NbGVLxCLQTkX5jY1HeayFdz6Hwe7tiBlJab6fJ5OdoPCuEkiWTIqn0RFJIpysaMQrVF18G9VKJVFWuEpGoItGAu44dDQwMT9z9wamJ9lihbU7RxLez81LYeIH4gDc9oqDpWHN+tbim6YsVhTkfG8UIua3w4alTB3HzPaw5NBB3d6yg4EDddOXGotx9oebPwDhz/urttwhpSCgQpriNP6KTToqUIrpjbwIZVf70h151b7QLtNJKIhSlSl5UypsnGdPNyjFunUPimOp3T16emBJ7fN7CKQ3JybELg3wczIRowAQ7MME+THcQM2lHldCPebdgOVsoiDbMNxnLNhGfVwGWCP8hNsh85HtNFSj9R+mu9rkb52Z06s+H3buhfF7u/ympcSRiTiUmL+kkVLhq49zssEg1fdXr58woFh/DGtgi+QXyhJJJ400mnW3lZbNrpZkemmC3DaUeyOSRU/FWgTzJeBqqcfq6h/LfeuVwfu6E1I/mFk3IIDZhkq4IxzDibryR3ZSIh22UnHKBra583liHj0flE8V7m5KEQRFrpwJWbCjzX8YFmcS5VBzcgtvv6E9Y0h+rvDB3HVZHz8eXdl2AqOxzvW1jUfZHoebFpNTM1dvvtNuEX+Fusl7lKYQykEx6ksnx1CN9Zn7vRJMWr/5kwslk0bgTJEnmzpsz7vUpNdV3XfRq48G+uZdMem3suOQ9+AG9L1Dn+w8WjW8N8IhMQ7Jrn2P/a6vPFBMi/hDLtwqPE4JI5vbS6sY/bZyX9w4faAmx2PNZY4M7bKLbwZfpMyKBbWXz8v4Raj4Fa96YXLDW9RegwmWyu4D4JZT6sjX2ld62IgrtuKLqdzhIpDLhbtCqQFAlmUI6nmCyipSqlKKLJla/d3IppSJ1uuy/+WTzlywjlR6SxPvpug8dfxRtsBX3rzV7LaWEdfK8lA+zrGvyprl5LSU1jffjE9rmI8oZYWDo/lDTn7F2x+U2gTyN6Y8lEhEUgngd66WTjkw6IvmVWkbMksSS1hSX8uHUo2pPaVWgxwaT1TZHMNBSUz0nXGW3uz7CZ/DVg+VL3g74sMLAQ5fknsDNcnyXK/FGfgNmXCEEFpZUNRaWFeXVyEGWjtLpIHmPp1NHKcjNEtrct4TaqW/Wmu0rbYKwFW8g1iN9VCmltauMCaUnUyCVqIb6BtWdVe0r3tbyNtr5jDxh3gRTzsli0cPWTKyc7CxYu+PHB8qXPBLgkYWNssK8R9fWOOoxa6YqA9teRLgTfyNDrG1zYXhtDd2KVf7NulMDwuDg74NNj7kR+tPaf0MEYaWRLeVbDXoTyotMvBtC+ZGP/VGKu8YNTsZQufFeSzT+Co+0oooU84SpBFNsMPexVrECe18oRWYVb5+6/2TnGvrUTRHtWoS288tIrq9gMZj5EkBy0WulEksFtRrU/ncAVwVoPfMvBCutZm14OpampT2F1eLreFXnS0p5kcuIUAY+LV8qkYc+mOrOEi6ct7Vkoil8IVqpxBvy2vqkkgIoPUzcTJQJKfy4YEr6OfiMbvp4/U1BNQ4HCze5qh1/xGy/HyDquNWVjhkwP/cAO7CcWMwIxILsxoLMUwIpvBxMGm5S9XKk0qk+jfQyVINaQmlcDLxK1NtWMjkDlM/btgLupWtj6F0NfJhCItUQ85CPI5JaSI+VRlWJtoL2pP9j2r2v3HDk4WWDAYocFoiLbgUbCUQssBMyGzeRIZa7IACs6qkQi9qEd81e6yFV+tP4EFf4JJUPKaW3sRRC6VSkFMWQSMG0FSpJgIG3nXXO0utYFkujLnkJRjW/SuoyYTExVnO02wQYdopy2ZfFxtmfjzS5yi7JO1hS7WjC3Rx/8bB858v7kZnclpKDqn0A/Ulzs00NUGWNxyjin8FXvdyLVMq+d5gipcwQSkcmretBucCEleXtbtDTRE8y1WnKEUzSmcRNHFCkFNudNTEZ5k1JhZnjk2ByZgJkJMUo5W3pGYK61gHYW9+z7GBD7/Z7t9Ze+fA9UyMpuQ5DAGJhocfKu5EhlkBOgTx/PIUGs/M1zMxP24RPNyhS+SKX97EP+4poSaQVMv7ppdBEcZby3nbOtaBReVqCyeWQSRlnF+Dqi7LgK3NzIDfNd2tLVnKs+3/OZPfIu8vePdzOamQX+C1weGA9XC71G0NUG9EjM6MfoV2C+oRNddaftXbHbcjIH/sllU7l6cNAvkYjobSE0pNJ4zhVd/mNT8juAL6tUHUrSCnIVjyXB+W976Aa6gunpsNdXxoPY1OCb75beF7GrL//+9gT37j0nG8HfbEJsL5lRCOjDUAERYBEhFj2/sHDYlwsa5hMQ9ugKlD8WWt2LkQp9/vApNKRy4to7rvT1h7Bm1C8RANlXwXRB/iAal/5UIE6b7uX60FSkTGCDQk1DpZdEN50rUsvyPzWozsPV65cfN5vwkrIAHgHJgYlU6WGGhFiMddCcVXTHLQzL+wQcvzWCAvuey2PxNieFwjEybU5v6TSEMwoDBS15+2acJ/kiOUBUcWWaalF5R+9CpSaZ7Qk45prpKvl8/EoB366PB9mT0ox9Wz9IQYf+FUXZP36ke1Hqu++clpl2AlqQLMCfW14n03yfsRWppBmlAlotAuxApvWKEsllEQSCI1U8jUg74OWUPw5T6h8LJeIC/fzHFVpJR/rG2NA2+AMOoLh1m4DuP9aa0glIyMxRiiclPzKhg2QtX69NXORsQUhIIlcFCieQEi9vD+iS54UrN1xhwDkGiK9cUOXAoA3gQK4IIxsLCNC6SUYt1HBq0zgvOlc7wbvdkLeKAeuFwNvUwHcfuk4uHiydaSSUTA+OePE4uN/Acj/VuDYgTGQ0IikIkmB4hGRHJT3R4xYF5W8MkGAmAqN20AjhXQqMUhSeatBfa1Q59MC/ypRcyg1v3h3eOFUoL7rjBLmOXHhpGS4dnbkpsBfdP6Yb5Y9f+D3JTcUmPYh+oKLCF8IaLgjhm2i0g9+xIg1TGMeQ7sqXS+VAIwIw0kz8EMqI4IZ2VgG9pW31DJiFPDtNuBtkhPltL4jHx+Ldfm547K8ABZLeEiMFcjlMzL+gSoxO1yVSIi7E6B/UKhlPVzkwxEhFqrAq1EFXul5mXrSyEQwcimYIVWA2qJnV0lfJp28w79swxfPBWq87Rq3gpQfcL4ryXPO+LVgahpMHBP5bu0zxydnHrni2K8Azrkv1DTW7GmcbAMSuJu0ADv5w7NOLI93PaPMWAWqag94lQg6qRUkqYxsLoVEvIpUws3JEl4yKSoQvBuc1XiedK++0HdfSKtRlJ/2gy1P199/300T+kO5XnAC84sFfCCiSLfzx2edWDMnZ7D+0e4pkLxVICeVeCkTCqk06pBTefpj6UehuA8NqIdG/WkMea7Nz6tHA4XkOBtMz0sM/QEGiXHpsbF5eV2s8+UtwV674cCBWAJj7gwYkUKPy+V6lQ86q8Ri8yWAIGzQvlgfKlCWMl7GO4REKlUN8rVNLZl8qUQj8JYT72pQ+7drCSa3B56XkxhR28oI889J/eaW1+p/fN/SCW3BXNfXk/ltLLR+MIcXUMW/sHmBViKeVWK5CLkNH3IecOTQqzzl2CgMjKSWlkCCLH2Ua7yJppBLIZSqKoELV89qoW3nM+dtJ9KZHD/tf5FCVkqsbUJK1+O4G2iwi4KbnwZb/hSxxIQWZLfo1YnzrBGLvcuZxeSHMincYaoC0pBFkR2c9NEfB5RUGltK64LwsrdASzJQrvNxL9Kv7H0nRKcC3eGMRDHuXgmZyXaIsxMYclGYnnv21CCPi6ekXf29R3fFbFs5d9hM/HOmNH4D72Waiai7y4vy/q0PPGvEKli9/So0Bd39dYyklU8ycUThrw3GsAfQkkqvBnmXhFISnbHFqz41TOdtp0w6xMDl01NhzuRktG+CHaYXOWSnxNgXTE1hg1k2BIrLZgmklPzSlM4mxotGnD1VKAj3+pdW2herGPAaAoHywr1IpNhkoCGVF4l0tUU+fb6G6EtiaQgmjYJm+8lxAlw5KwMWF6S72+xGI6bmJt8FJojVJ8JP8UYnm0iyMTGx/UmAPK8TZ4VYF6x941wirbHDSysA7ctT2vl4soB0rFOBoDvmbTDQkcqXlNLbXFqp5UcXAk8wClOzE+CuRbmQmjCiLWQBMWt8cu4jrx5acPdV5/uczIPNKEQEsspUgpQ+4mtCtrPyJChx3ai+VgYdQXhbB0B5yRppAt4qUFGlHHH82mB8npowrlQ8nzTc0ipD2cWwcFoafL1oLNhtZvTGyMKGNRtUzw+BZ54zL7DbXSu42GBVMzr8dGKy/de+Tp4VYomU3GiTJZFe5cn7surjbSvgr+FkiYaMehJxKtGIcDop5aUSiZomqMXhQJTfiyYlwX9dkq03x0Y1puYmFfk6V1LtuIv6Wr1NDwr3+5sYL+LEumD19omCTWCTtGolAeGIAupZI9uKD1eli3Fcvvbnuc63Xws0YeqxtqwG7gZ8+hMyY+G2L+Z8qkjFMCUzIWHrKwcvuWfZjA/58HU1zefgfZX7U/8c9iQW5T7hL0LEiUVtcCP3vkAje3yRSN43klbAqzPVFtPYVZxUAzAmldbY10lSrgaq3fHAhudv/UI2xNo/ZaySMDY17m7cKMRi/a3EJPFveJ/JZq7H+u+PA41jiDyxQLjaM2+V1n7hX4liKBOd9FIjGKtQHZk82ejtLNDaVDyRvNSg3ojnfqXMmbS65NwUyEs/+45OqzAhI34xf9yf5PgZBFgSUAGFZzYWaWeWMUJEiUU2bBBmwhcVna6SQQ3REgwMSOTtROWlFfDXGKhJw5olf46XbJr4XJk4MAP4qgvSw3swI4zpuUm5W1+pTb1n2dSukhoHVqzgpyYvbaHEdo+ZiBEl1vmdX5yJObg74atKSTrSEwFAE0MmgtELJtxFGmmlqDedCtTbVDpS6W0shYi6PFlF8NzseEhPHN1uhUCIjxHATlwr1lU2HgSB/BlMzoSN0voH5UXmJniLrMSy0/meF6RTbfw+p9eMzmvVma4myBFUrya9jHp9OhpSGdcW1XKovxdMGJkmGasRnxp3LRWEjUgXUzdEgfy1vCjnabPpR5RY+BnM59WKDC/7CsBQOhF9LI4sXmkRA2nFhXv39fLt6+LJp8f03GAmuxudGEbRe0SIXUZNDelyP4uGYefwj4LJI6LEEoHMlqec4YkjhRgQCFRycIw0tsM49cbFMZJWfLi29gdaUvkhFIOA9hVrUP40Q0RS/XpfB7hiY8wuXkpFUfzO5gXBdbmJ2FMqrXEs2/T16RfG24hWyuhsF2a3dPY5oQP/z3QPwd66HjjVNsgRSI2rtdOU5Awknbe0Au5aL1KaIBVDQgxxG++fVrBn/YdDXTAQa369ArzbX5TNz9seOKYWESFWSXXTl1HMbrt0Wmh1ckfnELx5qB3+ufsMDEozq3i7KY0lnaGaBFU68fYZf00gUjF8mknF8Lcj3XCGBLGgCIVnyopyf74xhLwsJ9baqsZLUQK8YKNQHzi2MdhkGN+Yn+PuG/5UVTO8tq/Vy74ytNPkH40dpjP4DYx6vWT0hb4hS8Z/jgheONUHJ1xB9bqoGnY5b6HankKmYSmxSnc1XYCkehF3E2MoNdWhzB/SEuxw5+Xj3NP4PPJ6PQy7qNZwMpRjau3ONxFBMbq0nn3/cGL+A8Oiu7r+acL2uj7Y2xcUP05RsF23eUFuSAMwGCwjVkllwwQQbGyeBvdUNjFALVt46AtT01CKxcHP/3EMVSNVanY8iK89H3YaHzOY9r46tP+m5Xx6aobvnO6Hqh7q9bx8gkIPAWFFmUl/lS9YQqz7/nMiPVaIfwV3J8hhMcoEWdbgnLHxsGrpJCh7+ZQSZkQIn89PY8QbSzIzONEy9Kkh1jun++CdLjGYL4d9tt8oC2OBBxlhE2sDm9fDGf9X0K1qjyai5TP6zp6UDF8tzIJna1rUQB/PjPg68hJ2wVHrP3W9sHhmWtCEPNv49+kBeLtT1HxMAcDmVLqrvCjnJSvyD5tYfdWOctxc43UiQouTr5idBW8f6oTWXtWE8/Z2BUAYrGjuGoZjzQPupp3RireQVO92uoIhFRvCtbp8Xm5YK9jyCItYa6sct2DZVxueJJYulKkg1i7AzUXZ8Ls3G5QwedhVWIwJAq993AHf/1LuqJRar6JErWEr5ATznVH6YNm8vC1WliNkYhVXNl8oCN7jyRSQyC3xy7qt/OldwW3Im4OWdJpZrkMg5PGWQdhzshcunhxwZp+zimeP9sDB4eDuhVKyrawo9ydWlyUkYpW815IixIpPgZ9VopwiRGwGXzYKhg2v+uBoNxAfvDAK1szX7yeeGTy3qxXGpcf4nYD2bIHdw+OHuuF0kN9yV2d/Te7i/B9EokyhSayY4W34Oqb7izIEJKLLcbBZ8D6o7VZYwU8fpPdLqYRSz/KECoVcTFr+6b0zcDeqxJT4iGh9U3Dhzf12fxd02oN7lafrOuGjyobf7l2cHxGvb9DE8thV5BuB4g1F2ODJTvG4yQwlE3hsLjbpviyhtETiVnnw7AXnzJLQ2uOE37zugDsvz4GsEWic7ndRePjjLhiOCy7vxvpO2FNZz1Y/PxmhogVHrNJdjZOQVA+biSvahIiuzD4mmSWvs53kI3kmR6KVYPrzsuuBHyofLNp6nbB1ZyNcf/EYmDPp7NlcDd1OeOxoLwjxwZGq4SRKqpp6z0JRLnoq8BWhwXSp2DsoFsnjRPKsB4Qovo6/ftVlOGDTAXmpP45QALx6BLc+9MgmmUFaqQXcHKHBgrUh/u2DFqg+3gNLCtIgf2xkXRGVp/vh1ZZhsAVNqg7Yt+u0NCiS0t60uJDbcwPBdMmKq5vuxYf+JZPRP2izj/9xW0/bXShZIlI7FJAcXyvKho4+FzR3DYKjcxhaeoYV8siWFJVWpSREN2coJ7U8B6rlFazkotRD7kON/XDwdB9MGBOLNmASzMhLZPNTWXK/Mp481AWHRQFsscHZdQ0n2uHj3Y1ARWW+iebj6xcNWFo4DqaIVfJh4wxiIw+ZTLOPirZbt82D4fcPDbYhsSIygysbenXdHG3SrB2v8lg3vHekE7r6PXUHIhHHM0+Vt9RSl0OVZ6NVZqUNKL1kSej5/j3TQrL9U62DcLJlEJ6nbe4R0mxeh8RYz/clSoxmcUVp6w6XyKmk43VMIDYvGeKzk4EE+ameOtoGB/c6pLykL0qEiNlXDAGJxZ7vWoE8CuYXoC4unz/2CNtp6RqshfHJkZsaWIeJY+Lc/ytmZ8Ir+1rh1X3tzO2hiCrZ5gKJZIoKVJai1yhPCQYMo+oUkcqSQRqCqXNoDWHtsXXYBS2gEkbUEUc5lsmmCadgswswaVY2xI8Jro2SXXt4XzOcPNqqFFS+M9xWB5VYkAhILFSBN+ODDTy5KbgbebeXFeb8rkw67ux3seVOzI1XsxCyNGNzqG/deRra+5xKLVEtLHiTSwrzCC51UXAvcJ2UZEIBRwgKKolkCqpSSElCIaEcS371MskYElLjYPLMbIgNcsIRERl6YPdpcNR38sXmYfHKFVr4Le29tbVxCZD8gMm0WmzEdhvfMayrf+g1lkw4BQwHTHqVXjMBtu44DQ0dQ4qBrp00VCulvBYFl354mSYzSyWXRB8dqWSiKeHcOTUl7zgyMiekQt7UjKDa/BicKKY/rqqH1uZeTdoy3PsCfGh8tTXwS6zE9pT78LbPNZMQiu2VD8zNauTDWuKbtnf154qpCfYR6xk3JikGfnTlePjFi3XQ3e8Exa+gJxchymzHnFUvgeq/do2kUQklhWjsIy6OrC51UkmRVpJIs2F9Z8KMLEgOUvUxDA44Ye+H9dDd2a+RjnIBpTK2HqxYUgvlQSdvGj6J9ZPK5hwQ6DozieAH/ZeKeXnP68PXL1rkfHNfw4nCKannhFPIcMEGmK68LAe2oORiKsKLXKBKKLU5myoVRSMHLFBuH7Q2FuhIpSERZ4Mp8bmwxIwEJFUm2IOs9TF0tfXDx9UNMIDk0pBK8+veeZ96fyuWwiexXIJrHT5qE0OESEeMi6z1dba+beBfSCxTw7IjCTYF9sJpqfD2J50qMyRyyTaVJ1S7cpcU0xCqxAGtGgQ9wbgwZZ+TbHgsII/G5mfAmHGpIbVZOE51wJF9Te7u04qq5ow6rSqk/ww+h+BgSKx7K9tSEwVyu8k01j8wP7vJ18nOrt4tLpHeMxpGuFx9QYbbFaHWFHV+ecWoAk+7ooG0AtB8+RqJJZ8zJpIaDlSrLuNT4iDv/EyIC2FGQJbmiUMtUFfb5nFl6MuolEORW67hGNcLQWcUJAzvJEEYuhMLYWZA4/4OIed3/iL8cPmFx2sOO7qm5yWZHSAZMbBmoKL8FHivtst9LHu1POBUIIBGLRpDrQ3KG62NxROJJ5tsZ4FbYo6dkuY20kORUs5hEQ5hza/tTC+XD2//qdahaufB20ceXHYm+NyCgxexPPN7w92mribCfdvmQsDROMda+t5AYl0ffPGsx4UTk+DdI12S+pPVIXgWr6QS2YhKEl/vWyu1OPtJ2lGklFzrA60kS0yLg5xpGRCbEFqTandHPxza44CB3iGlDByFfKpBEYiXLRwJeBErP99xA5YkP9CF+BIqN87L3mEmk1MNPasGz8+8Pm4UDJuaMS7JvciAi3MzePb4vg+gs68MzXd1T1UzHLk4wx1Um4o1xTAplZoTeoN144kOVH/N4HKplQC+AsCXTVHHnvIME6f4bMgZBwFvVUjhDjMX4RR7gAAAEHdJREFUIvN/aTaTNTddePyNvfVH5+WnmXJdRBKsaSUzJQaaOockO4pw9ULQ1QxlGCtEI/tKkWBUfbFyyunjkyFrUioIIXpfhodccHSvQ/FPyVKJl1a82lWkl1Jg+vSBLUsbDRO3GBpi3V/VkAnEZqaheU9FUc6/gnGD1Db1VCCxfHdlPotg5KKcxJJ9pm6LS1aRoL4QrUfLG4Y+LekE28alxELO1AyISwq9QZq5Eo585IBB5ovj8tBLK5XsqtGulA3AVJcnK6AhllOwX4cPNaDSJ4Ruo8bP2CdWLjl/274TzVvY5KrBFtJqJEldbtx9kkA24j0Pn+vjoMT3daM8/XiDWSaUEINqLz8N0rJDV3sUa7D1R1uhobbd03aoVBrMSivFp1ZzoOLKiDbj8NAQi4jiYhN9RoYEUXwmlMw+OtX7BBJrZSjXWokBVCki5UZUy6zg+tbIr0ffRx646Mqx9KP6HAmkjQtP7TH0dQ/CsY+boadjQGvDaaSiGWnllsKGS5NEClobi5ArTFzz0oNF41tDyeyoePLuE61J3x5pqcX6bvENxAS0rgYAztbSd3YAUN+o7pS7tpceD9lT00Ou7XnSoXD6aDs0HGVSSlRtNY70Gr8Yf8zdlxwPTclP4rsznwq5QCFAIdbq6tMT7SDkBrqAUBJyrYI18fzlrdpfI7FKQ00jXLBuLG19chXdtwqUieYLeqkVk2B31/aSs8KbSrK/B6XUPpRSnYMaQskqT2+w+yKT4vLw3ElJzTZzq35ZBYVYMWCbbab5yBkjvhdOhrcsmrpud23T3dNyElPCSSdU7DnVDaI0LkXT4Cz3+wPVd2UorXjgOdamlzk5DdJzk0LrNC+BtWE2Hm+H08faQJTdCDoPvca5qlOB+jZHOQ6qwA/2b1ryAlSEXLSQwKlCaqZ/+ulNc/LC7nm4p657PRJrc7jphIL3azsV94Cxt90jyZRu8D4g2ARIz0M7anKqez8cdLX1wamDLdDXM+Tl9/IilS8VCKqNx11LqSisinSDsxFUYlEyzu+T9GC3FZl+94qpW17/T/3dReeeXb9WW+8w7DrR7e6l6fGuq32u1I59DN72kyy8GInGjEuBTDTMbWH2Bhrqd0LdJy3Q5vZLeTtTtV1vQEcwncqjaly57CKQ/3vwV4sj2u/KFxRiiQTGBhTkFNqtyvij5o4rzslOOM6WlbUqzUB44n2He+I09T55l4JqZwHX20GGECNA5vhUyJyQEjahmAuh6QSqPVR9LidVCQS+SKWXWlx8AC35VBur0eYSR6yTpUIs/F7NeO86A0cxh1VXzqp7/M3aB24szPlvq9L0h/0NvfDOJx3Ske8GZ23DDkBsnA2yJqVBRl4KSqvwe2h0tvRB3aEW6O8bVj32elVnRCowIJXecOdJSeCO/ZuXBjXTsZUY0bmlb79i6vo39tZ/a15+WkQ7AjZ3DUHFKyc9KhCAa3B299OXvO7SS5Zsq4TkOMicmAIZOSlBj4oxwiASqe6TVug406sjDHDqzA+pvIx17Tm1FshAHj1Qvvjl8EsdOlRiEWgLaOIRMLP4dFD4j6NjUV56fO2EjLiIzK7B7Kr1zx+TBlTIbgQA1ZpSVSCbxz1tbBJkjU8JqVuwEUQXBceJDnAwtefi/ORe5NKpOjmOIem8vOp8GkdEoX+NJYUPAyqxRGgyMZDufKsLwFTib1+pXX5DYdaryfHWLlO6v6EHJdUpaGUDWeWU5W4yjFCS5R4Tb4dstJ3GoA0VY6HJ19bYDXVHWtFId+kIBYZSyhNsRCofYTq7CsO6iE284dDGFd2W3USIUIiF5dof8K0SmMwGr5ZdknfQykL8YNnU7X96/fBPry/MfcCKnqZdA054troZnt99BlyiSiDerrJh7S4jOxky85JRSiVASD3tfIDZUQ21rdDbOeSXUO5DneEOvP0EOgL5CvMkjPKQfPPAxqX7LbuRMKBKLJuwW/Ec+gEVBLamyl1WF+S2L5/34DMfHF+wdFbWtaFcz+yn2qY++PfhDnjpozMwMKRdeMCj8gikZiVC1jiUTjlJbnJZiZ72AahHCdXV7pnFmq/6a2wgf1IKdOQyQSqpCnLfgYrF/7L0hsKAQqzyudlHS6odx3DXryFNCP1uSY3jf8sKc6usLsyNC/KXb3350Cu9Q+JV+rUHgZtTQZYtTBp1Dbigq98JBxt7obvfpV3FSzKoUjPiIRONcCadYoOcSMMMWDNM3eE2xTBn4Mkk7UrhPKEMiKTE9eOC0IcB/BqN9a2W31gY0D9l1m3VeE5R/hoKz6zZ03ipFV54Pe65+vxlM9dsfwgt6VL9qlzGq9Kzq7hl4fCXuQUymBGem4ySKdlSu4lHb8cANKBR3tHc65aYbujc3Fp3gHFYQHL5J9XvD1YsuS+SYwRDgYZYNoH+0SWSVRDY4Jhoc5LKkprmb5cVmuueHAz2b7pyXUHxDkaVEn5AqfJmNB30iLvNLykpFsagzcQINQb/rfA5+UIH2lCs9wFritFXpJUiytaVbFsBqH4rAAOppD/mr/fl1yJbDlYsXq3j8qiAhlgPzs07hOqQLVmywsS1OUDFV0urmn4tEqG8fF54KxnocXDTknUFa3bE4MNb5QmhSo2O6bj4hFjIzPaQiP3HRUDFaUGhtbEHGo61Q2/XoPLS+fMcp1QyuX/0KpFzM4BeSnnXAr3CPFf+CtXfmtEmqWR4vQ2RkJ8IlC4D1uEhMARK6H0EXN8vqW76C77wxxILc2vWB1jh3Aw8z3HJ6hnFOw/FxJBHMjISY9LGJEA6/uM+xCdFdMJABayfeXN9JzhOdsJAv0HPEwpe4oJXdXwcXuV54mmlmr8JRpR0Kav9wU8OVCwpg1EML2JVFOZ8XFLV9H0kyR+DSCce73glPoWVfdWO1hKAHShc3qUgHBZFWnvyZM6pp27yv1KFe9jZpIY8aiOTBbBNxMc6EdOcvuLmWWyx8rM+e2w31uwaT3bAGUePuyJvBKr9MbCtPKFag16xjTSEks/7NtzdB214/PUDm6603PworWq+iBLxRxRcD5fPG/+fcNMz1B9lRTmPYc1vGt5NSQhpZuL/1/FhfJ0JLuaWyp/iGCqpBjZKlP33oW3kmaqbsqVjSTweJ+dPgRTkj52ooh6s9C2ZgcspQvPpbiRUu7ujnWnopBblArxUIBffH6EMHKgHBJd43f7NS2tDv0M/IOLP8PerQIUxuA17DKhPwwRV2v19VY5x+G6/HW4mCNZckyX9c29BIs4Imp7s5bJuK031XdCK0skl+fL4Zh8/V3vZWr5qhL6MeF7tydfofFxs93+HB52rjjy8rCu0uwwMvOtJUm17khXp+SQWs5NIUe6ta6scx/D5rrcis9GE3u5BaKxD2+lUJwwNsumNuAXNwUi5BQDVXqMnk14l8hJKDVNtKYlcJ/HnzkioPj0EIOOkT2CcFen5rUq5768o9+draxo7CSWsc+vIzZQfJthL62wbgDON3dDc2AX9bGi6vjnax7RFAdPW7ajHXG1Q+pFp55tQngAsyzZR6F97qCzy7X6lu9rTsETyeIexqz6oHxPs4uJ6mKqjlxfmbSmpbPoA64B/xsPzwsnwbIL1LGhv7UUi9UBTQxcMDrBanSqZCCddtBTTwvcAe20opQZxfJBJVoHuXc6uQpX0hk0Q1+0vW2p5y4ZPuIauAXVRLSEmxsZWc3sinCRNO3/K5ud8uOHAmbl9fa4KVvtjBQgn44gA305X1wDaTD1wpqkXWs/0uMkljx/UTlfE/rgZGyRHrN9pi3xnqznQqEQ92XQ+LSWMwD6sSf/iYPmSp03fr0WghGr8lqidroOzRSyG9QVje3Dz/ZIPGx/G6t46fAvfhJFXj8fwUexE5fFe70Dvm2+9dnQ2kuNeNEK/DNLsnZqOfaCduEhf/6TckT+VSH0cGUst4zZD6e99SsjmQxWLnxsJD3pxVVM+1txv4MOwENeF24slJHe1lOEtpVXNv8KX9gMsyo14PCbUQpgGgXYkRjVlU0mLYo3dFlOpn/cULju3Dn9fnLH69fNAEO9GsfpdPE5S5JVEMvc+gCLN5BfuazBFIGilllF7Ia8SSTdS/u+E0N/tL1/i8RmNkAddIHQjeGrtPOzERn6B2xtDTTesdpCNnrWDv7fhwIF7+vsyl6HUuAEf3nziWeokHCeUA9OpwwQYSY7ji9gFVKiR5483g4O/+vJh3Pzo3NKd/x3vostFoF/B9JZiWKJ2Gkit+vP2oPlWjkbE83Y/KCqR9aV5A/eeF/pinvz4kUU9Zu8lUiitcjDb6iajc1jqr5TWNF23sTAnpGklLWlgW19QwKpY/5T+3YuPxwzGFeHnMA4lRhYWMhf/E1EvdeFr7MJS9xIi9lORtAuEDLgI6RdEVwel9s6k/t669YumWLYUx9GNi9kAELZm9V8LN7yU2Nsbv4xQuhzLs4CwiogirYghwbyqiX7EmIFtdQqvfRnF5EvdrqQ36jYv6LfinqxASc3p6UBsfwWgvgQAoSL9a3Fl8xcr5mfvDTb9iLTcbpk9hQ2H2R7a1WMtLQuPmvXX9uHmWekfZtz/eiZxivORC5fgA74YyTCF9ZLFJ53svkBreGmhdS2w6mYtvqO9VCD/EUTxI9FGPjpUtuR0xG4mDJRWO2aiEnwJS5/uNyKBZIGILyG5rg2WXCM6SmekcfDBL7PJTV6W/hVcuO5fGUPO+IkCiBOI2z7zgIoQj4Z2PH7KZwQQWpw255lYwdW896FrLBtvGWmUVjctB48ENzsn7EQk13vFVY23VBR5T7nuC59rYvmCRBT2H7QKGK24v6rhPFGw/ZJ6DPLg7F8muYA8V1rduNMl2labkV5RYn2GsWZXY5ZNJMuxUnUdIbZrUG+H9b7RPl4sCOKukmrHyyi5/2m30RcfnJNrOANzlFifIbi7voD4ILMT8X+cjZIMFh7sWjwBwDizAitAK1xOrARUO5g5cRol4QkbEdc/VDhujxwpis8IKHF9B2l0tefgrGXLukllInUvEClhC0ncyQKjxPoMQbDZt4ouF1taOR//WaPyZPyPi2CWbOBkIxDagISuI0CU6SijxPoM4aGLx7JOgLfJx6s+qE+ItccspkS8DsXZ14Gr4YaBAbS1ngEi/iMp0f6a1MznhSixPsPYvGACc8iywTEvoiFfahPhZyhZfgChvXcRTbVnCQilDxVmHwsUOUqszwk2zc1jqwf/qLS6+Uk08J8DNsrKLAi0iyDcXFGYvdPsJVFifc6wcV72+2v2NM63OQkbjj/TxCVHqcu2rCKIdlqGKLE+h2Aj2JFc1yC5WGfCbF/xsKbX5RRhxaYgScUQJdbnFIxcpbsav0pF8iYY84CKIr1p0/y8A6GkHyXW5xgb5+a9W1Ld9Dhy6E79OQr07+Xz80LsSBAl1ucedsG23ik6WU9g3hUxBIItrLlho8T6nIP1wC2tcjxJCXxHDiME/lk2N/toOOlGiRUFUIH8EyhViCWK4a/CGiVWFDA8PLwjxm5ncwqw5h9xOLb/lXDTjBIrCreHvqTaUY+7bKWQJqkHcFiIEisKGawb9blAwJLu1FFiReEGBXKSAL2U9VKwIr0osaJww2YTNlCneIa6xD9YkV6UWFG4IXW5WWVVelFiRRER/H8G9CDtAt8RCQAAAABJRU5ErkJggg==">
<VersionHistory>
<Change Ver="2" Date="2024-12-11" Type="Modified">Update logo and add images to authentication instructions</Change>
<Change Date="2024-04-05" Type="Fix">Change default rows per page (MaxItemCount) from 100 to 1000 for performance improvement</Change>
<Change Date="2024-04-05" Type="Fix">Maximum 10000 rows are fetched because PagingByUrlMaxPages is set to 100 by default. It needs to be 0 for unlimited pages.</Change>
<Change Date="2023-08-31" Type="Fix">get_document throws error on UI due to bad options for ConsistencyLevel</Change>
<Change Date="2023-05-20" Type="New">Initial version</Change>
</VersionHistory>
<ServiceUrls>
<ServiceUrl Name="Cosmos DB Service Url" Url="https://[$Account$].documents.azure.com" />
</ServiceUrls>
<Auths>
<Auth Name="ApiKey"
Label="API Key"
Type="Http"
ConnStr="CredentialType=HashSignature;HashSignatureFormat=[$http-method$]-lc[$lf$][$url-part-regex-(/(?<resourcetype>dbs|colls|docs|users|permissions|sprocs|attachments|pkranges)(/([\w\d-\$\.=])+)?$){{0,resourcetype}}$]-lc[$lf$][$url-part-regex-(?<id>dbs/([\w \d-+=.]+)$)|((?<id>dbs/(.*?))/(colls|docs|users|attachments|permissions||pkranges)$)|(?<id>dbs/(.*)/(colls|docs|users|attachments|permissions)/[\w \d-+.=]+$){{0,id}}$][$lf$][$timestamp$]-lc[$lf$][$lf$];ExtraHeaders=x-ms-date: [$timestamp$]||x-ms-version: [$ApiVersion$]||Authorization:type%3dmaster%26ver%3d1.0%26sig%3d[$signature$]-enc;HashTimestampFormat=r;"
ContentType="application/json"
TestEndPoint="get_tables">
<Notes>
<![CDATA[Connecting to your Azure Cosmos DB data requires you to authenticate your REST API access. Follow the instructions below:
<ol>
<li>Go to your Azure portal homepage: <a target="_blank" href="https://portal.azure.com/">https://portal.azure.com/</a>.</li>
<li>In the search bar at the top of the homepage, enter <strong>Azure Cosmos DB</strong>. In the dropdown that appears, select <strong>Azure Cosmos DB</strong>.</li>
<li>Click on the name of the database account you want to connect to (also copy and paste the name of the database account for later use).</li>
<li>
On the next page where you can see all of the database account information, look along the left side and select <strong>Keys</strong>:
<img src="https://cdn.zappysys.com/api/Images/authentication/cosmosdb/API-Key/use-api-key-to-get-cosmos-db-data-via-rest-api-in-azure.png"
loading="lazy"
decoding="async"
class="img-thumbnail block"
alt="Use API key to get Cosmos DB data via REST API in Azure"
title="Using API key to get Cosmos DB data via REST API in Azure"
width="720"
height="500" />
</li>
<li>
On the <strong>Keys</strong> page, you will have two tabs: <strong>Read-write Keys</strong> and <strong>Read-only Keys</strong>.
If you are going to write data to your database, you need to remain on the <strong>Read-write Keys</strong> tab.
If you are only going to read data from your database, you should select the <strong>Read-only Keys</strong> tab.</li>
<li>
On the <strong>Keys</strong> page, copy the <strong>PRIMARY KEY</strong> value and paste it somewhere for later use
(the <strong>SECONDARY KEY</strong> value may also be copied and used).</li>
<li>
Now go to SSIS package or ODBC data source and use this <strong>PRIMARY KEY</strong> in <strong>API Key</strong> authentication configuration.
</li>
<li>Enter the primary or secondary key you recorded in step 6 into the <strong>Primary or Secondary Key</strong> field.</li>
<li>Then enter the database account you recorded in step 3 into the <strong>Database Account</strong> field.</li>
<li>Next, enter or select the default database you want to connect to using the <strong>Default Database</strong> field.</li>
<li>Continue by entering or selecting the default table (i.e. container/collection) you want to connect to using the <strong>Default Table (Container/Collection)</strong> field.</li>
<li>Select the <strong>Test Connection</strong> button at the bottom of the window to verify proper connectivity with your Azure Cosmos DB account.</li>
<li>If the connection test succeeds, select <strong>OK</strong>.</li>
<li>
Done! Now you are ready to use Cosmos DB Connector!
</li>
</ol>]]>
</Notes>
<Params>
<Param Name="Password" Label="Primary or Secondary Key" Required="True" Secret="True" />
<Param Name="Account" Label="Account Name (Case-Sensitive)" Required="True" Desc="Login to your Cosmos DB Page and look in the title (copy that name). URL usually ends with /databaseAccounts/your-cosmos-db-account/overview" />
<Param Name="Database" Required="True" Template="ParaDatabase"/>
<Param Name="Table" Label="Default Table (needed to invoke #DirectSQL)" Template="ParaTable"/>
<Param Name="ApiVersion" Label="API Version" Value="2020-07-15" Options="2020-07-15;2015-08-06" Required="True" Hidden="True" />
</Params>
</Auth>
</Auths>
<Template>
<Param Name="ParaDatabase" Label="Database Name (keep blank to use default) Case-Sensitive" Desc="Leave blank to use default DB set on connection screen" OptionsEndPoint="get_databases" OptionsEndPointValueColumn="id" />
<Param Name="ParaTable" Label="Table Name (Case-Sensitive)" Desc="" OptionsEndPoint="get_tables" OptionsEndPointValueColumn="id" OptionsEndPointParameters="Database=[$Database$]" />
<Param Name="ParaUser" Label="User Name (Case-Sensitive)" Desc="" OptionsEndPoint="get_users" OptionsEndPointValueColumn="id" OptionsEndPointParameters="Database=[$Database$]" />
<Param Name="ParaFilter" Type="Property" Value="$.Documents[*]" Options="$.Documents[*];$.Documents[*].SomeArray[*];$.Documents[*].SomeArray2ndLevel[*].SomeArray3rdLevel[*];$.Documents[*].SomeNestedProp" HelpLink="https://zappysys.com/links/?id=jpath_help" />
<Param Name="ParaPartitionKey" Label="Partition Key Value (default is supplied Id)" Key="x-ms-documentdb-partitionkey" Type="Header"
Value="."
Options="Default=.;SingleKeyValue=["someValue1"];MultiKeyValue=["some_value1","some_value2" ]"
ValueTemplate="<<{$value$}|~|Eq|~|.|~|["[$Id$]"]|~|$1,FUN_IF>>"
Desc="The partition key value for the document. Must be included if and only if the collection is created with a partitionKey definition"/>
<EndPoint Name="Pagination">
<Params>
<Param Name="PagingMode" Type="Property" Value="ByResponseHeaderContinuationToken" />
<Param Name="PagingByUrlAttributeName" Type="Property" Value="x-ms-continuation" />
<Param Name="PagingByUrlMaxPages" Type="Property" Value="0" />
<Param Name="MaxItemCount" Label="Max Rows Per Page (Adjust for Speed)" Value="1000" Type="Header" Key="x-ms-max-item-count" Desc="An integer indicating the maximum number of items to be returned per page."/>
</Params>
</EndPoint>
<EndPoint Name="CommonOutputColumns">
<OutputColumns>
<Column Name="id" DataType="DT_WSTR" Label="Id" Length="255" Desc="The unique name that identifies the collection." />
<Column Name="_rid" DataType="DT_WSTR" Label="ResourceId" Length="2000" Desc="System generated property. The resource ID is a unique identifier that is also hierarchical per the resource stack on the resource model. It is used internally for placement and navigation of the permission resource." />
<Column Name="_ts" DataType="DT_I4" Label="LastUpdated" Desc="System generated property. Specifies the last updated timestamp of the resource." />
<Column_unused Name="_self" DataType="DT_WSTR" Label="UniqueUri" Length="2048" Desc="System generated property. The unique addressable URI for the resource." />
<Column Name="_etag" DataType="DT_WSTR" Label="ETag" Length="4000" Desc="System generated property representing the resource etag required for optimistic concurrency control." />
</OutputColumns>
</EndPoint>
<EndPoint Name="UserOutputColumns" Template="CommonOutputColumns">
<OutputColumns>
<Column Name="_permissions" DataType="DT_WSTR" Label="Permissions" Length="4000" Desc="System generated property that specifies the addressable path of the conflicts resource. During an operation on a resource within a collection, if a conflict occurs, users can inspect the conflicting resources by performing a GET on the conflicts URI path." />
</OutputColumns>
</EndPoint>
<EndPoint Name="DatabaseOutputColumns" Template="CommonOutputColumns">
<OutputColumns>
<Column Name="_colls" DataType="DT_WSTR" Label="Collections" Length="4000" />
<Column Name="_users" DataType="DT_WSTR" Label="Users" Length="4000" />
</OutputColumns>
</EndPoint>
<EndPoint Name="TableOutputColumns" Template="CommonOutputColumns">
<OutputColumns>
<Column Name="uniqueKeyPolicy.uniqueKeys" DataType="DT_WSTR" Label="UniqueKeys" Length="4000" Desc="Unique keys for the container." />
<Column Name="indexingPolicy.indexingMode" DataType="DT_WSTR" Label="IndexingPolicyIndexingMode" Length="12" Desc="By default, the indexing mode is Consistent. This means that indexing occurs synchronously during insertion, replacement, or deletion of documents. To have indexing occur asynchronously, set the indexing mode to lazy." />
<Column Name="indexingPolicy.automatic" DataType="DT_BOOL" Label="IndexingPolicyAutomatic" Desc="Indicates whether automatic indexing is on or off. The default value is True, thus all documents are indexed. Setting the value to False would allow manual configuration of indexing paths." />
<Column Name="indexingPolicy.includedPaths" DataType="DT_WSTR" Label="IndexingPolicyIncludedPaths" Length="4000" Desc="The array containing document paths to be indexed. By default, two paths are included: the / path which specifies that all document paths be indexed, and the _ts path, which indexes for a timestamp range comparison." />
<Column Name="indexingPolicy.excludedPaths" DataType="DT_WSTR" Label="IndexingPolicyExcludedPaths" Length="4000" Desc="The array containing document paths to be excluded from being indexed." />
<Column Name="conflictResolutionPolicy.mode" DataType="DT_WSTR" Label="ConflictResolutionMode" Length="20" Desc="Policy-driven mechanism to resolve write conflicts. You can select from two conflict resolution policies on an Azure Cosmos DB container. (LastWriterWins and Custom)" />
<Column Name="conflictResolutionPolicy.conflictResolutionPath" DataType="DT_WSTR" Label="ConflictResolutionPath" Length="4000" Desc="Policy-driven mechanism to resolve write conflicts. This is the conflict resolution path." />
<Column Name="conflictResolutionPolicy.conflictResolutionProcedure" DataType="DT_WSTR" Label="ConflictResolutionProcedure" Length="4000" Desc="Policy-driven mechanism to resolve write conflicts. This is the conflict resolution procedure." />
<Column Name="geospatialConfig.type" DataType="DT_WSTR" Label="GeospatialConfigType" Length="100" Desc="The type of geospatial data describing the position and shape of objects in space." />
<Column Name="partitionKey.paths" DataType="DT_WSTR" Label="PartitionKeyPaths" Length="4000" Desc="An array of paths using which data within the collection can be partitioned. Paths must not contain a wildcard or a trailing slash. For example, the JSON property 'AccountNumber' is specified as '/AccountNumber'. The array must contain only a single value." />
<Column Name="partitionKey.kind" DataType="DT_WSTR" Label="PartitionKeyKind" Length="4000" Desc="The algorithm used for partitioning. Only Hash is supported." />
<Column Name="partitionKey.version" DataType="DT_I4" Label="PartitionKeyVersion" Desc="The partition key version." />
<Column Name="_docs" DataType="DT_WSTR" Label="Documents" Length="2048" Desc="System generated property that specifies the addressable path of the documents resource." />
<Column Name="_sprocs" DataType="DT_WSTR" Label="StoredProcedures" Length="2048" Desc="System generated property that specifies the addressable path of the stored procedures (sprocs) resource." />
<Column Name="_triggers" DataType="DT_WSTR" Label="Triggers" Length="2048" Desc="System generated property that specifies the addressable path of the triggers resource." />
<Column Name="_udfs" DataType="DT_WSTR" Label="UserDefinedFunctions" Length="2048" Desc="System generated property that specifies the addressable path of the user-defined functions (udfs) resource." />
<Column Name="_conflicts" DataType="DT_WSTR" Label="Conflicts" Length="2048" Desc="System generated property that specifies the addressable path of the conflicts resource. During an operation on a resource within a collection, if a conflict occurs, users can inspect the conflicting resources by performing a GET on the conflicts URI path." />
</OutputColumns>
</EndPoint>
<EndPoint Name="CreateDocument"
Url="/dbs/[$Database$]/colls/[$Table$]/docs"
OutputHeaders="StatusCode"
Body="[$Document$]"
Method="POST"
>
<Params>
<Param Name="Table" Template="ParaTable" Required="True" />
<Param Name="Database" Template="ParaDatabase"/>
<Param Name="Document" />
<Param Name="PartitionKey" Template="ParaPartitionKey" Value="[]"/>
<Param Name="Upsert" Hidden="True" Label="Enable Upsert Mode (update if document found)" Key="x-ms-documentdb-is-upsert" Type="Header" Options=";true;false"/>
<Param Name="IsMultiPart" Type="Property" Label="Read Document from File Path" />
</Params>
<InputColumns>
<Column Name="PartitionKey" MapToParam="True" DataType="DT_WSTR" />
<Column Name="Document" MapToParam="True" DataType="DT_NTEXT" />
</InputColumns>
<OutputColumns>
<Column Name="id" />
<Column Name="_rid" />
<Column Name="_ts" DataType="DT_I8"/>
<Column Name="ResponseHeaders_StatusCode" Label="http_status" DataType="DT_I4" />
</OutputColumns>
</EndPoint>
<EndPoint Name="UpdateDocument"
Label="Replace Full Document (PUT) or Specific Part (PATCH)"
Url="/dbs/[$Database$]/colls/[$Table$]/docs/[$Id$]"
OutputHeaders="StatusCode"
Body="[$Document$]"
>
<Params>
<Param Name="RequestMethod" Type="Property" Hidden="False" Label="Full Replace (PUT) or Partial (PATCH)?" Value="PUT" Options="Full Replace=PUT;Partial Replace=PATCH" />
<Param Name="Id" Label="Document Id" IsKey="True" />
<Param Name="Table" Template="ParaTable" Required="True" />
<Param Name="Database" Template="ParaDatabase"/>
<Param Name="Document" Desc="Full Document if RequestMethod=PUT else Partial Document" HelpLink="https://learn.microsoft.com/en-us/azure/cosmos-db/partial-document-update" />
<Param Name="PartitionKey" Template="ParaPartitionKey" Value="[]"/>
<Param Name="IsMultiPart" Type="Property" Label="Read Document from File Path" />
</Params>
<InputColumns>
<Column Name="RequestMethod" MapToParam="True" DataType="DT_WSTR" />
<Column Name="PartitionKey" MapToParam="True" DataType="DT_WSTR" />
<Column Name="Id" MapToParam="True" Key="True" />
<Column Name="Document" MapToParam="True" DataType="DT_NTEXT" />
</InputColumns>
<OutputColumns>
<Column Name="id" />
<Column Name="_rid" />
<Column Name="_ts" DataType="DT_I8"/>
<Column Name="ResponseHeaders_StatusCode" Label="http_status" DataType="DT_I4" />
</OutputColumns>
</EndPoint>
</Template>
<EndPoints>
<EndPoint Name="get_databases"
Label="Get List of Databases"
Url="/dbs"
Method="GET"
Filter="$.Databases[*]"
Template="Pagination,DatabaseOutputColumns"
Desc="Gets a list of the databases in the current database account."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/list-databases"
CachedTtl="60"
>
</EndPoint>
<EndPoint Name="get_database"
Label="Get Database Information by Id or Name"
Url="/dbs/[$Id$]"
Method="GET"
Template="DatabaseOutputColumns"
Desc="Gets a database by its Id."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/get-a-database"
CachedTtl="60"
>
<Params>
<Param Name="Id" IsKey="True" Required="True" Template="ParaDatabase"/>
</Params>
</EndPoint>
<EndPoint Name="get_tables"
Label="Get List of Tables"
Url="/dbs/[$Database$]/colls"
Method="GET"
Filter="$.DocumentCollections[*]"
Template="Pagination,TableOutputColumns"
Desc="Gets a list of the tables in the database. (Tables are also called 'containers' or 'collections')"
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/list-collections"
CachedTtl="10"
>
<Params>
<Param Name="Database" Template="ParaDatabase"/>
</Params>
</EndPoint>
<EndPoint Name="get_table"
Label="Get table information by Id or Name"
Url="/dbs/[$Database$]/colls/[$Id$]"
Method="GET"
Template="TableOutputColumns"
Desc="Gets a table by its Id. (Tables are also called 'containers' or 'collections')"
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/get-a-collection"
CachedTtl="10"
>
<Params>
<Param Name="Id" IsKey="True" Required="True" Template="ParaTable"/>
<Param Name="Database" Template="ParaDatabase"/>
</Params>
</EndPoint>
<EndPoint Name="get_partition_keyranges"
Label="Get table partition key ranges"
Url="/dbs/[$Database$]/colls/[$Table$]/pkranges"
Method="GET"
Filter="$.PartitionKeyRanges[*]"
Desc="Gets Partition Key Ranges for a table. This is useful for query if you want to minimize scan to specific partition (Tables are also called 'containers' or 'collections')"
HelpLink=""
CachedTtl="30"
>
<Params>
<Param Name="Table" IsKey="True" Required="True" Template="ParaTable"/>
<Param Name="Database" Template="ParaDatabase"/>
</Params>
</EndPoint>
<EndPoint Name="query_documents"
Label="Query documents using Cosmos DB SQL query language"
Url="/dbs/[$Database$]/colls/[$Table$]/docs"
Method="POST"
IsSqlEndPoint="True"
Headers="content-type:application/query+json||x-ms-documentdb-query-enablecrosspartition:true||x-ms-documentdb-query-enable-scan:[$AllowScan$]"
Filter="$.Documents[*]"
Template="Pagination"
Desc="Gets data based on the specified SQL query."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/querying-cosmosdb-resources-using-the-rest-api"
CachedTtl="15"
>
<Body>
<![CDATA[{
"query": "[$Query$]"
}
]]>
</Body>
<Params>
<Param Name="Table" Template="ParaTable" Required="True" />
<Param Name="Query" IsSqlParameter="True" Value="select * from root" Label="SQL Query" Required="True" Editor="MultiLine" Desc="Query for Cosmos DB" HelpLink="https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/query/select"/>
<Param Name="Filter" Template="ParaFilter" Required="True" />
<Param Name="Database" Template="ParaDatabase" />
<Param Name="AllowScan" Label="Allow Query Scan" Value="true" Options="true;false"/>
<Param Name="AllowCrossPartition" Label="Allow Cross Partition Query" Value="true" Options="true;false"/>
<Param Name="PartitionKeyRangeId" Type="Header" Key="x-ms-documentdb-partitionkeyrangeid" Label="Cross Partition Key Range Id" Value="0" OptionsEndPoint="get_partition_keyranges"
OptionsEndPointValueColumn="id" OptionsEndPointLabelColumn="minInclusive,maxExclusive" OptionsEndPointParameters="Database=[$Database$];Table=[$Table$]" />
</Params>
</EndPoint>
<EndPoint Name="get_documents"
Label="Get All Documents for a Table"
Url="/dbs/[$Database$]/colls/[$Table$]/docs"
Method="GET"
Template="Pagination"
Filter="$.Documents[*]"
Desc="Gets all documents for a Table."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/list-documents">
<Params>
<Param Name="Table" Template="ParaTable" Required="True" />
<Param Name="Database" Template="ParaDatabase"/>
</Params>
</EndPoint>
<EndPoint Name="get_document"
Label="Get Document by Id"
Url="/dbs/[$Database$]/colls/[$Table$]/docs/[$Id$]"
Method="GET"
Headers="x-ms-documentdb-query-enablecrosspartition:[$EnableCrossPartition$]"
Desc="Gets Document by Id."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/get-a-document"
CachedTtl="5"
>
<Params>
<Param Name="Id" Label="Document Id" Required="True" IsKey="True" />
<Param Name="Table" Template="ParaTable" Required="True" />
<Param Name="Database" Template="ParaDatabase"/>
<Param Name="EnableCrossPartition" Value="true" Options="true;false"/>
<Param Name="PartitionKey" Template="ParaPartitionKey"/>
<Param Name="ConsistencyLevel" Key="x-ms-consistency-level" Type="Header" Options=";Strong;Bounded;Session;Eventual" Desc="This is the consistency level override. The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). The override must be the same or weaker than the account's configured consistency level."/>
</Params>
</EndPoint>
<EndPoint Name="delete_document"
Label="Delete a Document by Id"
Url="/dbs/[$Database$]/colls/[$Table$]/docs/[$Id$]"
Method="DELETE"
Headers="x-ms-documentdb-query-enablecrosspartition:[$EnableCrossPartition$]"
Desc="Deletes a Document by Id."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/delete-a-document">
<Params>
<Param Name="Id" Label="Document Id" Required="True" IsKey="True"/>
<Param Name="Table" Template="ParaTable" Required="True" />
<Param Name="Database" Template="ParaDatabase"/>
<Param Name="EnableCrossPartition" Value="true" Options="true;false"/>
<Param Name="PartitionKey" Template="ParaPartitionKey"/>
<Param Name="RawOutputDataRowTemplate" Value="{}" ValueTemplate="{Status:'Deleted', Id:'[$Id$]', Table: [$Table$]}" Type="Property" />
<Param Name="EnableRawOutputModeSingleRow" Value="True" Type="Property" />
<Param Name="ContineOnErrorForStatusCode" Value="True" Type="Property" />
<Param Name="ErrorStatusCodeToMatchRegex" Value="404|405" Type="Property" />
</Params>
<InputColumns>
<Column Name="Id" MapToParam="True" Key="True" />
</InputColumns>
<OutputColumns>
<Column Name="Id" />
<Column Name="Status" />
<Column Name="Table" />
<Column Name="ResponseHeaders_StatusCode" Label="StatusCode" DataType="DT_I4" />
</OutputColumns>
</EndPoint>
<EndPoint Name="get_users"
Label="Get All Users for a Database"
Url="/dbs/[$Database$]/users"
Method="GET"
Template="Pagination,UserOutputColumns"
Filter="$.Users[*]"
Desc="Gets all users for a Database."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/list-users">
<Params>
<Param Name="Database" Template="ParaDatabase"/>
</Params>
</EndPoint>
<EndPoint Name="get_user"
Label="Get User by Id or Name"
Url="/dbs/[$Database$]/users/[$Id$]"
Method="GET"
Template="UserOutputColumns"
Desc="Gets database user information for a specific Id"
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/get-a-user">
<Params>
<Param Name="Id" Required="True" Template="ParaUser" IsKey="True"/>
<Param Name="Database" Template="ParaDatabase"/>
</Params>
</EndPoint>
<EndPoint Name="create_user"
Label="Create User for Database"
Url="/dbs/[$Database$]/users"
Method="POST"
Template="UserOutputColumns"
Body="[$RequestBody$]"
Desc="Create a new user which you can later use to create permission set and obtain resource token."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/list-users">
<Params>
<Param Name="Database" Template="ParaDatabase"/>
<Param Name="RequestBody" Editor="MultiLine" Value="{"id": "TYPE_USERNAME_HERE"}"/>
</Params>
</EndPoint>
<EndPoint Name="create_document" Template="CreateDocument"
Label="Create a document in the container"
Desc="Insert JSON document in Cosmos DB Container."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/create-a-document" >
<Params>
</Params>
</EndPoint>
<EndPoint Name="upsert_document" Template="CreateDocument"
Label="Upsert a document in the container"
Desc="Insert JSON document in Cosmos DB Container."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/create-a-document">
<Params>
<Param Name="Upsert" Value="true" />
</Params>
</EndPoint>
<EndPoint Name="update_document" Template="UpdateDocument"
Label="Update Document in the Container"
Desc="Update full or part of the document in Cosmos DB Container."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/replace-a-document">
<Params>
</Params>
</EndPoint>
<EndPoint Name="create_token"
Label="Create Permission Token for a User (One Table)"
Url="/dbs/[$Database$]/users/[$User$]/permissions"
Method="POST"
Desc="Create a new user which you can later use to create permission set and obtain resource token."
HelpLink="https://learn.microsoft.com/en-us/rest/api/cosmos-db/list-users">
<Body>{"id": "[$PermissionName$]","permissionMode": "[$PermissionMode$]","resource": "[$Table$]"}</Body>
<Params>
<Param Name="PermissionName" Label="Permission Name (e.g. read_orders)" Required="True" />
<Param Name="Database" Template="ParaDatabase"/>
<Param Name="User" Template="ParaUser" Required="True" />
<Param Name="PermissionMode" Required="True" Value="all" Options="All;Read;Write;Delete"/>
<Param Name="Table" Template="ParaTable" Label="Table (Add Permission for this)" Required="True" ValueTemplate="dbs/[$Database$]/colls/{$value$}"/>
<Param Name="ExpiresInSecond" Value="3600" Type="Header" Key="x-ms-documentdb-expiry-seconds" Desc="The validity period of the resource token returned by the operation. By default, a resource token is valid for one hour. To override the default, set this header with the desired validity period in seconds. The max override value is 18000, which is five hours." />
</Params>
<OutputColumns>
<Column Name="id" Label="Id" />
<Column Name="permissionMode" Label="PermissionMode" />
<Column Name="resource" Label="Resource" />
<Column Name="_token" Label="Token" />
</OutputColumns>
</EndPoint>
</EndPoints>
<Tables>
<Table Name="SysDatabases" SelectEndPoint="get_databases" LookupEndPoint="get_database" />
<Table Name="SysTables" SelectEndPoint="get_tables" LookupEndPoint="get_table" />
<Table Name="SysUsers" SelectEndPoint="get_users" LookupEndPoint="get_user" />
<Table Name="[$parent.id$]"
SelectEndPoint="get_documents"
LookupEndPoint="get_document"
InsertEndPoint="create_document"
UpdateEndPoint="update_document"
UpsertEndPoint="upsert_document"
DeleteEndPoint="delete_document"
DataEndPoint="get_tables" Expand="True" >
<Params>
<Param Name="Table" Value="[$parent.id$]" />
<Param Name="Query" Value="SELECT * FROM [$parent.id$]" />
</Params>
</Table>
</Tables>
<Examples>
<Example Group="ODBC" Slug="query-documents-default-container" Default="True" Label="Query documents (default container)">
<Desc><![CDATA[<p>Runs a Cosmos DB SQL query against the default container from the connection settings. Use the <code>#DirectSQL</code> prefix so the query is sent as-is; <code>root</code> refers to the container. Filter and order as needed (e.g. by <code>root._ts</code> for last-updated).</p><p>For query syntax see <a href="https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/query/select">Cosmos DB SQL query reference</a>.</p>]]></Desc>
<Code><![CDATA[#DirectSQL SELECT * FROM root where root.id !=null order by root._ts desc]]></Code>
</Example>
<Example Group="ODBC" Slug="list-all-documents-in-container" Label="List all documents in a container">
<Desc><![CDATA[<p>Returns all documents in the specified container (table). Use the container name as the table in the <code>FROM</code> clause; the default database and container from the connection are used unless you override with <code>WITH</code>. Use for small containers or when you need a full dump; for large data sets consider a query with a filter.</p>]]></Desc>
<Code><![CDATA[SELECT * FROM TestContainer]]></Code>
</Example>
<Example Group="ODBC" Slug="get-document-by-id" Label="Get document by ID">
<Desc><![CDATA[<p>Returns a single document by its <code>id</code>. Filter with a <code>WHERE</code> clause on <code>Id</code>; the container must be the one from the connection or specified in <code>WITH</code>. For partitioned containers, partition key is inferred from the document when possible, or you can supply it in <code>WITH</code>.</p>]]></Desc>
<Code><![CDATA[SELECT * FROM TestContainer Where Id='user2']]></Code>
</Example>
<Example Group="ODBC" Slug="query-documents-with-cosmos-db-sql" Label="Query documents with Cosmos DB SQL">
<Desc><![CDATA[<p>Runs a Cosmos DB SQL query against a container via the <code>query_documents</code> endpoint. Supply the container name, the query text, and optionally <code>Meta</code> to define result columns and types. Use for filtered or ordered queries, or when you need a custom SELECT. Cross-partition and scan behavior can be set in <code>WITH</code>.</p><p>For query syntax see <a href="https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/query/select">Cosmos DB SQL query reference</a>.</p>]]></Desc>
<Code><![CDATA[SELECT *
FROM query_documents
WITH(
-- Database='TestDB', --if you dont supply connection level Default Database name is used
Table='TestContainer',
Query='select * from root Where root.id!=null order by root._ts desc',
Meta='id:string(50);name:string(50);city;age'
--Meta='id; name; city; age' -- no types at all. Default is string(2000)
--Meta='id; name:string(50); city; age: int' --Mixed types. If type is missing default string(2000) used
--check below URL for more information on Query Language Syntax
--https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/query/select
)
]]></Code>
</Example>
<Example Group="ODBC" Slug="create-document-with-partition-key" Label="Create document with partition key">
<Desc><![CDATA[<p>Inserts a new document into the container. If the container has a partition key, supply it in the <code>PartitionKey</code> column as a JSON array (e.g. ["user2"]). The value must match the document attribute used as the partition key. The <code>Document</code> column holds the full JSON body. Use the <code>Upsert</code> option in <code>WITH</code> to update if a document with the same <code>id</code> already exists.</p>]]></Desc>
<Code><![CDATA[
INSERT INTO TestContainer (PartitionKey, Document)
VALUES(
'["user2"]', --partition key value must match its attribute from document else it will throw error. In this example container PartitionKey is /id so we used its value. For multiple key use JSON array ["val1","val2"]
'{
"id": "user2",
"name": "John Doe",
"email": "jdoe@contoso.com",
"phone": ["12345"],
"level": "platinum"
}'
)
WITH(Upsert='true')
]]></Code>
</Example>
<Example Group="ODBC" Slug="create-document-from-file-path" Label="Create document from file path">
<Desc><![CDATA[<p>Inserts a document whose JSON body is read from a local file. The file path must start with the <code>@</code> symbol (e.g. @c:\data\order.json). Set <code>IsMultiPart=1</code> in <code>WITH</code> so the driver reads from disk. Partition key rules are the same as for inline document insert.</p>]]></Desc>
<Code><![CDATA[
INSERT INTO TestContainer (PartitionKey, Document)
VALUES(
'["user2"]', --partition key value must match its attribute from document else it will throw error. In this example container PartitionKey is /id so we used its value. For multiple key use JSON array ["val1","val2"]
'@c:\data\order.json' --path must start with @ symbol
)
WITH(Upsert='true', IsMultiPart=1)
]]></Code>
</Example>
<Example Group="ODBC" Slug="upsert-document-insert-or-update-if-exists" Label="Upsert document (insert or update if exists)">
<Desc><![CDATA[<p>Inserts the document or updates it if a document with the same <code>id</code> already exists. Use the <code>Upsert</code> option in <code>WITH</code> on <code>INSERT</code> to enable upsert. Handy for sync or idempotent loads where you do not want to fail on duplicate id.</p>]]></Desc>
<Code><![CDATA[
INSERT INTO TestContainer (PartitionKey, Document)
VALUES(
'["user2"]', --partition key value must match its attribute from document else it will throw error. In this example container PartitionKey is /id so we used its value. For multiple key use JSON array ["val1","val2"]
'{
"id": "user2",
"name": "John Doe",
"email": "jdoe@contoso.com",
"phone": ["12345"],
"level": "platinum"
}')
WITH(Upsert='true')
]]></Code>
</Example>
<Example Group="ODBC" Slug="upsert-document-using-upsert-keyword" Label="Upsert document using UPSERT keyword">
<Desc><![CDATA[<p>Same as upsert with <code>INSERT</code> and the <code>Upsert</code> option in <code>WITH</code>, but uses the <code>UPSERT INTO</code> syntax so you do not need the <code>WITH</code> clause. Use whichever style you prefer; behavior is the same.</p>]]></Desc>
<Code><![CDATA[
UPSERT INTO TestContainer (PartitionKey, Document)
VALUES(
'["user2"]', --partition key value must match its attribute from document else it will throw error. In this example container PartitionKey is /id so we used its value. For multiple key use JSON array ["val1","val2"]
'{
"id": "user2",
"name": "John Doe",
"email": "jdoe@contoso.com",
"phone": ["12345"],
"level": "platinum"
}')
]]></Code>
</Example>
<Example Group="ODBC" Slug="update-document-full-replace" Label="Update document (full replace)">
<Desc><![CDATA[<p>Replaces the entire document for the given <code>Id</code>. Set <code>PartitionKey</code> and <code>Document</code> to the full JSON body. The default request method is PUT (full replace). Use this when you want to overwrite the document completely; for changing only some fields use the partial update (PATCH) example.</p>]]></Desc>
<Code><![CDATA[
UPDATE TestContainer
SET
PartitionKey='["user2"]'
,Document=
'{
"id" : "user2",
"name": "John Doe at <<FUN_NOW>>",
"email": "jdoe@contoso.com",
"phone": ["<<FUN_TODAY>>"],
"level": "platinum"
}'
Where Id='user2'
]]></Code>
</Example>
<Example Group="ODBC" Slug="partial-update-document-patch" Label="Partial update document (PATCH)">
<Desc><![CDATA[<p>Updates only specified attributes using the PATCH method. Set <code>RequestMethod</code> to PATCH in <code>WITH</code> and supply a <code>Document</code> body with a JSON Patch <code>operations</code> array (e.g. set, add, remove, incr, move). Use when you need to change a few fields without sending the full document.</p><p>For operations and syntax see <a href="https://learn.microsoft.com/en-us/azure/cosmos-db/partial-document-update">partial document update</a> and <a href="https://learn.microsoft.com/en-us/rest/api/cosmos-db/patch-a-document">REST API</a>.</p>]]></Desc>
<Code><![CDATA[
UPDATE TestContainer
SET
PartitionKey='["user2"]'
,Document=
'{
"operations": [
{ "op": "set", "path": "/name", "value": "updated name" }
,{ "op": "set", "path": "/email", "value": "updated@email.com" }
]
}'
Where Id='user2'
WITH(
RequestMethod='PATCH' --Partial Replace (change name and email only)
)
/*
Example Document Operations
https://learn.microsoft.com/en-us/azure/cosmos-db/partial-document-update
https://learn.microsoft.com/en-us/rest/api/cosmos-db/patch-a-document
[
{ "op": "add", "path": "/color", "value": "silver" },
{ "op": "remove", "path": "/used" },
{ "op": "set", "path": "/price", "value": 355.45 }
{ "op": "incr", "path": "/inventory/quantity", "value": 10 },
{ "op": "add", "path": "/tags/-", "value": "featured-bikes" },
{ "op": "move", "from": "/color", "path": "/inventory/color" }
]
*/
]]></Code>
</Example>
<Example Group="ODBC" Slug="partial-update-document-patch-from-file" Label="Partial update document (PATCH) from file">
<Desc><![CDATA[<p>Same as partial update (PATCH) but the JSON Patch operations are read from a local file. The path must start with the <code>@</code> symbol; set <code>IsMultiPart=1</code> in <code>WITH</code> to enable file upload. Useful when the patch payload is large or generated externally.</p><p>For operations and syntax see <a href="https://learn.microsoft.com/en-us/azure/cosmos-db/partial-document-update">partial document update</a> and <a href="https://learn.microsoft.com/en-us/rest/api/cosmos-db/patch-a-document">REST API</a>.</p>]]></Desc>
<Code><![CDATA[
UPDATE TestContainer
SET
PartitionKey='["user2"]'
,Document='@c:\temp\b.txt' --path must start with @ symbol
Where Id='user2'
WITH(
RequestMethod='PATCH' --Partial Replace (change name and email only)
,IsMultiPart=1 --this enables file upload
)
/*
Example Document Operations
https://learn.microsoft.com/en-us/azure/cosmos-db/partial-document-update
https://learn.microsoft.com/en-us/rest/api/cosmos-db/patch-a-document
[
{ "op": "add", "path": "/color", "value": "silver" },
{ "op": "remove", "path": "/used" },
{ "op": "set", "path": "/price", "value": 355.45 }
{ "op": "incr", "path": "/inventory/quantity", "value": 10 },
{ "op": "add", "path": "/tags/-", "value": "featured-bikes" },
{ "op": "move", "from": "/color", "path": "/inventory/color" }
]
*/
]]></Code>
</Example>
<Example Group="ODBC" Slug="list-databases" Label="List databases">
<Desc><![CDATA[<p>Returns all databases in the Cosmos DB account. Use this to discover database names and IDs for connection defaults or for querying a specific database. Columns include <code>Id</code>, <code>ResourceId</code>, <code>LastUpdated</code>, and <code>ETag</code>.</p>]]></Desc>
<Code><![CDATA[SELECT * FROM SysDatabases]]></Code>
</Example>
<Example Group="ODBC" Slug="list-containers-tables" Label="List containers (tables)">
<Desc><![CDATA[<p>Returns all containers (tables/collections) in the default database from the connection. Use to discover container names for <code>SELECT</code> or <code>INSERT</code>. For a different database, use the next example with <code>WITH (Database='...')</code>.</p>]]></Desc>
<Code><![CDATA[SELECT * FROM SysTables]]></Code>
</Example>
<Example Group="ODBC" Slug="list-containers-for-database" Label="List containers for a database">
<Desc><![CDATA[<p>Returns all containers in a specific database by passing the database name in the <code>WITH</code> clause. Use when the connection default database is not the one you need.</p>]]></Desc>
<Code><![CDATA[SELECT * FROM SysTables WITH (Database='MyCosmos DB')]]></Code>
</Example>
<Example Group="ODBC" Slug="list-users" Label="List users">
<Desc><![CDATA[<p>Returns all users for the default database. Users are used for resource-token permissions (e.g. create a permission and obtain a token for a specific container). Specify the database in <code>WITH</code> if not using the connection default.</p>]]></Desc>
<Code><![CDATA[SELECT * FROM SysUsers]]></Code>
</Example>
</Examples>
</ApiConfig>