https://shields.io/assets/js/a4fbaf72.026d941b.js

1"use strict";(self.webpackChunkshields_io=self.webpackChunkshields_io||[]).push([[25858],{90699(e,s,t){t.r(s),t.d(s,{contentTitle:()=>a,default:()=>c,frontMatter:()=>l,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"type":"api","id":"azure-dev-ops-builds","title":"Azure DevOps builds","description":"","slug":"/azure-dev-ops-builds","frontMatter":{},"api":{"description":"\\n[Azure Devops](https://dev.azure.com/) (formerly VSO, VSTS) is Microsoft Azure\'s CI/CD platform.\\n\\nA badge requires three pieces of information:\\n`ORGANIZATION`, `PROJECT_ID` and `DEFINITION_ID`.\\n\\nTo start, edit your build definition and look at the url:\\n\\n<img\\n  src=\\"https://user-images.githubusercontent.com/3749820/47259976-e2d9ec80-d4b2-11e8-92cc-7c81089a7a2c.png\\"\\n  alt=\\"ORGANIZATION is after the dev.azure.com part, PROJECT_NAME is right after that, DEFINITION_ID is at the end after the id= part.\\" />\\n\\nThen use the Azure DevOps REST API to translate the\\n`PROJECT_NAME` to a `PROJECT_ID`.\\n\\nNavigate to `https://dev.azure.com/ORGANIZATION/_apis/projects/PROJECT_NAME`\\n\\n<img\\n  src=\\"https://user-images.githubusercontent.com/3749820/47266325-1d846900-d535-11e8-9211-2ee72fb91877.png\\"\\n  alt=\\"PROJECT_ID is in the id property of the API response.\\" />\\n","parameters":[{"name":"organization","in":"path","required":true,"schema":{"type":"string"},"example":"totodem"},{"name":"projectId","in":"path","required":true,"schema":{"type":"string"},"example":"8cf3ec0e-d0c2-4fcd-8206-ad204f254a96"},{"name":"definitionId","in":"path","required":true,"schema":{"type":"string"},"example":"2"},{"name":"stage","in":"query","required":false,"schema":{"type":"string"},"example":"Successful Stage"},{"name":"job","in":"query","required":false,"schema":{"type":"string"},"example":"Successful Job"},{"name":"style","in":"query","required":false,"description":"If not specified, the default style for this badge is \\"flat\\".","schema":{"type":"string","enum":["flat","flat-square","plastic","for-the-badge","social"]},"example":"flat"},{"name":"logo","in":"query","required":false,"description":"Icon slug from simple-icons. You can click the icon title on <a href=\\"https://simpleicons.org/\\" rel=\\"noopener noreferrer\\" target=\\"_blank\\">simple-icons</a> to copy the slug or they can be found in the <a href=\\"https://github.com/simple-icons/simple-icons/blob/master/slugs.md\\">slugs.md file</a> in the simple-icons repository. <a href=\\"/docs/logos\\">Further info</a>.","schema":{"type":"string"},"example":"appveyor"},{"name":"logoColor","in":"query","required":false,"description":"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.","schema":{"type":"string"},"example":"violet"},{"name":"logoSize","in":"query","required":false,"description":"Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.","schema":{"type":"string"},"example":"auto"},{"name":"label","in":"query","required":false,"description":"Override the default left-hand-side text (<a href=\\"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding\\">URL-Encoding</a> needed for spaces or special characters!)","schema":{"type":"string"},"example":"healthiness"},{"name":"labelColor","in":"query","required":false,"description":"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).","schema":{"type":"string"},"example":"abcdef"},{"name":"color","in":"query","required":false,"description":"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).","schema":{"type":"string"},"example":"fedcba"},{"name":"cacheSeconds","in":"query","required":false,"description":"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).","schema":{"type":"string"},"example":"3600"},{"name":"link","in":"query","required":false,"description":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","style":"form","explode":true,"schema":{"type":"array","maxItems":2,"items":{"type":"string"}}}],"x-code-samples":[{"lang":"URL","label":"URL","source":"$url"},{"lang":"Markdown","label":"Markdown","source":"![Azure DevOps builds]($url)"},{"lang":"reStructuredText","label":"rSt","source":".. image:: $url\\n   :alt: Azure DevOps builds"},{"lang":"AsciiDoc","label":"AsciiDoc","source":"image:$url[Azure DevOps builds]"},{"lang":"HTML","label":"HTML","source":"<img alt=\\"Azure DevOps builds\\" src=\\"$url\\">"}],"method":"get","path":"/azure-devops/build/{organization}/{projectId}/{definitionId}","info":{"version":"1.0.0","title":"Build","license":{"name":"CC0"}},"postman":{"name":"Azure DevOps builds","description":{"content":"\\n[Azure Devops](https://dev.azure.com/) (formerly VSO, VSTS) is Microsoft Azure\'s CI/CD platform.\\n\\nA badge requires three pieces of information:\\n`ORGANIZATION`, `PROJECT_ID` and `DEFINITION_ID`.\\n\\nTo start, edit your build definition and look at the url:\\n\\n<img\\n  src=\\"https://user-images.githubusercontent.com/3749820/47259976-e2d9ec80-d4b2-11e8-92cc-7c81089a7a2c.png\\"\\n  alt=\\"ORGANIZATION is after the dev.azure.com part, PROJECT_NAME is right after that, DEFINITION_ID is at the end after the id= part.\\" />

1\\n\\nThen use the Azure DevOps REST API to translate the\\n`PROJECT_NAME` to a `PROJECT_ID`.\\n\\nNavigate to `https://dev.azure.com/ORGANIZATION/_apis/projects/PROJECT_NAME`\\n\\n<img\\n  src=\\"https://user-images.githubusercontent.com/3749820/47266325-1d846900-d535-11e8-9211-2ee72fb91877.png\\"\\n  alt=\\"PROJECT_ID is in the id property of the API response.\\" />\\n","type":"text/plain"},"url":{"path":["azure-devops","build",":organization",":projectId",":definitionId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"stage","value":"<string>"},{"disabled":false,"key":"job","value":"<string>"},{"disabled":false,"description":{"content":"If not specified, the default style for this badge is \\"flat\\".","type":"text/plain"},"key":"style","value":"<string>"},{"disabled":false,"description":{"content":"Icon slug from simple-icons. You can click the icon title on <a href=\\"https://simpleicons.org/\\" rel=\\"noopener noreferrer\\" target=\\"_blank\\">simple-icons</a> to copy the slug or they can be found in the <a href=\\"https://github.com/simple-icons/simple-icons/blob/master/slugs.md\\">slugs.md file</a> in the simple-icons repository. <a href=\\"/docs/logos\\">Further info</a>.","type":"text/plain"},"key":"logo","value":"<string>"},{"disabled":false,"description":{"content":"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.","type":"text/plain"},"key":"logoColor","value":"<string>"},{"disabled":false,"description":{"content":"Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.","type":"text/plain"},"key":"logoSize","value":"<string>"},{"disabled":false,"description":{"content":"Override the default left-hand-side text (<a href=\\"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding\\">URL-Encoding</a> needed for spaces or special characters!)","type":"text/plain"},"key":"label","value":"<string>"},{"disabled":false,"description":{"content":"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).","type":"text/plain"},"key":"labelColor","value":"<string>"},{"disabled":false,"description":{"content":"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).","type":"text/plain"},"key":"color","value":"<string>"},{"disabled":false,"description":{"content":"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).","type":"text/plain"},"key":"cacheSeconds","value":"<string>"},{"disabled":false,"description":{"content":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","type":"text/plain"},"key":"link","value":"<string>"},{"disabled":false,"description":{"content":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","type":"text/plain"},"key":"link","value":"<string>"}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"<string>","key":"organization"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"<string>","key":"projectId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"<string>","key":"definitionId"}]},"method":"GET"}},"source":"@site/categories/build.yaml","sourceDirName":".","permalink":"/badges/azure-dev-ops-builds","previous":{"title":"AppVeyor Job (with branch)","permalink":"/badges/app-veyor-job-with-branch"},"next":{"title":"Azure DevOps builds (branch)","permalink":"/badges/azure-dev-ops-builds-branch"}}');var r=t(74848),n=t(28453);const l={},a="Azure DevOps builds",o=[];function d(e){const s={a:"a",code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,n.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(s.header,{children:(0,r.jsx)(s.h1,{id:"azure-devops-builds",children:"Azure DevOps builds"})}),"\n",(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.a,{href:"https://dev.azure.com/",children:"Azure Devops"})," (formerly VSO, VSTS) is Microsoft Azure's CI/CD platform."]}),"\n",(0,r.jsxs)(s.p,{children:["A badge requires three pieces of information:\n",(0,r.jsx)(s.code,{children:"ORGANIZATION"}),", ",(0,r.jsx)(s.code,{children:"PROJECT_ID"})," and ",(0,r.jsx)(s.code,{children:"DEFINITION_ID"}),"."]}),"\n",(0,r.jsx)(s.p,{children:"To start, edit your build definition and look at the url:"}),"\n",(0,r.jsx)("img",{src:"https://user-images.githubusercontent.com/3749820/47259976-e2d9ec80-d4b2-11e8-92cc-7c81089a7a2c.png",alt:"ORGANIZATION is after the dev.azure.com part, PROJECT_NAME is right after that, DEFINITION_ID is at the end after the id= part."}),"\n",(0,r.jsxs)(s.p,{children:["Then use the Azure DevOps REST API to translate the\n",(0,r.jsx)(s.code,{children:"PROJECT_NAME"})," to a ",(0,r.jsx)(s.code,{children:"PROJECT_ID"}),"."]}),"\n",(0,r.jsxs)(s.p,{children:["Navigate to ",(0,r.jsx)(s.code,{children:"https://dev.azure.com/ORGANIZATION/_apis/projects/PROJECT_NAME"})]}),"\n",(0,r.jsx)("img",{src:"https://user-images.githubusercontent.com/3749820/47266325-1d846900-d535-11e8-9211-2ee72fb91877.png",alt:"PROJECT_ID is in the id property of the API response."}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"organization"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"totodem"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"projectId"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"8cf3ec0e-d0c2-4fcd-8206-ad204f254a96"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"definitionId"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,r.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"2"})]})})]})})]})]}),"\n",(0,r.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,r.jsx)("thead",{children:(0,r.jsx)("tr",{children:(0,r.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,r.jsxs)("tbody",{children:[(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"stage"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"Successful Stage"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"job"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"Successful Job"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"style"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:[(0,r.jsx)(s.strong,{children:"Possible values:"})," [",(0,r.jsx)(s.code,{children:"flat"}),", ",(0,r.jsx)(s.code,{children:"flat-square"}),", ",(0,r.jsx)(s.code,{children:"plastic"}),", ",(0,r.jsx)(s.code,{children:"for-the-badge"}),", ",(0,r.jsx)(s.code,{children:"social"}),"]"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:'If not specified, the default style for this badge is "flat".'})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"flat"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"logo"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Icon slug from simple-icons. You can click the icon title on ",(0,r.jsx)("a",{href:"https://simpleicons.org/",rel:"noopener noreferrer",target:"_blank",children:"simple-icons"})," to copy the slug or they can be found in the ",(0,r.jsx)("a",{href:"https://github.com/simple-icons/simple-icons/blob/master/slugs.md",children:"slugs.md file"})," in the simple-icons repository. ",(0,r.jsx)("a",{href:"/docs/logos",children:"Further info"}),"."]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"appveyor"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"logoColor"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos."})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"violet"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"logoSize"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Make icons adaptively resize by setting ",(0,r.jsx)(s.code,{children:"auto"}),". Useful for some wider logos like ",(0,r.jsx)(s.code,{children:"amd"})," and ",(0,r.jsx)(s.code,{children:"amg"}),". Supported for simple-icons logos but not for custom logos."]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"auto"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"label"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Override the default left-hand-side text (",(0,r.jsx)("a",{href:"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding",children:"URL-Encoding"})," needed for spaces or special characters!)"]})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"healthiness"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"labelColor"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"}

1,children:(0,r.jsx)(s.p,{children:"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported)."})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"abcdef"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"color"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported)."})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"fedcba"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"cacheSeconds"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsx)(s.p,{children:"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored)."})}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Example:\n",(0,r.jsx)("code",{children:"3600"})]})})]})}),(0,r.jsx)("tr",{children:(0,r.jsxs)("td",{children:[(0,r.jsx)("code",{children:"link"}),(0,r.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,r.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,r.jsxs)(s.p,{children:["Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an ",(0,r.jsx)(s.code,{children:"<object>"})," HTML tag, but not an ",(0,r.jsx)(s.code,{children:"<img>"})," tag or a markup language."]})})]})})]})]})]})}function c(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,r.jsx)(s,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},28453(e,s,t){t.d(s,{R:()=>l,x:()=>a});var i=t(96540);const r={},n=i.createContext(r);function l(e){const s=i.useContext(n);return i.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function a(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(n.Provider,{value:s},e.children)}}}]);