<h2class="anchor anchorWithStickyNavbar_JmGV"id="properties">Properties<aclass="hash-link"aria-label="Direct link to Properties"title="Direct link to Properties"href="/api/interfaces/BuildImageOptions#properties"></a></h2>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="abortcontroller">abortController?<aclass="hash-link"aria-label="Direct link to abortController?"title="Direct link to abortController?"href="/api/interfaces/BuildImageOptions#abortcontroller"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="buildargs">buildargs?<aclass="hash-link"aria-label="Direct link to buildargs?"title="Direct link to buildargs?"href="/api/interfaces/BuildImageOptions#buildargs"></a></h3>
<p>JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the
buildargs as the environment context for commands run via the <code>Dockerfile</code> RUN instruction, or for variable
expansion in other <code>Dockerfilev</code> instructions. This is not meant for passing secret values.
For example, the build arg <code>FOO=bar</code> would become <code>{"FOO":"bar"}</code> in JSON. This would result in the query
parameter <code>buildargs={"FOO":"bar"}</code>. Note that <code>{"FOO":"bar"}</code> should be URI component encoded.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="index-signature">Index Signature<aclass="hash-link"aria-label="Direct link to Index Signature"title="Direct link to Index Signature"href="/api/interfaces/BuildImageOptions#index-signature"></a></h4>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-1">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-1"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="cachefrom">cachefrom?<aclass="hash-link"aria-label="Direct link to cachefrom?"title="Direct link to cachefrom?"href="/api/interfaces/BuildImageOptions#cachefrom"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-2">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-2"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="containerfile">containerFile?<aclass="hash-link"aria-label="Direct link to containerFile?"title="Direct link to containerFile?"href="/api/interfaces/BuildImageOptions#containerfile"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-3">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-3"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="cpuperiod">cpuperiod?<aclass="hash-link"aria-label="Direct link to cpuperiod?"title="Direct link to cpuperiod?"href="/api/interfaces/BuildImageOptions#cpuperiod"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-4">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-4"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="cpuquota">cpuquota?<aclass="hash-link"aria-label="Direct link to cpuquota?"title="Direct link to cpuquota?"href="/api/interfaces/BuildImageOptions#cpuquota"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-5">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-5"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="cpusetcpus">cpusetcpus?<aclass="hash-link"aria-label="Direct link to cpusetcpus?"title="Direct link to cpusetcpus?"href="/api/interfaces/BuildImageOptions#cpusetcpus"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-6">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-6"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="cpushares">cpushares?<aclass="hash-link"aria-label="Direct link to cpushares?"title="Direct link to cpushares?"href="/api/interfaces/BuildImageOptions#cpushares"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-7">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-7"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="extrahosts">extrahosts?<aclass="hash-link"aria-label="Direct link to extrahosts?"title="Direct link to extrahosts?"href="/api/interfaces/BuildImageOptions#extrahosts"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-8">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-8"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="forcerm">forcerm?<aclass="hash-link"aria-label="Direct link to forcerm?"title="Direct link to forcerm?"href="/api/interfaces/BuildImageOptions#forcerm"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-9">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-9"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="labels">labels?<aclass="hash-link"aria-label="Direct link to labels?"title="Direct link to labels?"href="/api/interfaces/BuildImageOptions#labels"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="index-signature-1">Index Signature<aclass="hash-link"aria-label="Direct link to Index Signature"title="Direct link to Index Signature"href="/api/interfaces/BuildImageOptions#index-signature-1"></a></h4>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-10">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-10"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="memory">memory?<aclass="hash-link"aria-label="Direct link to memory?"title="Direct link to memory?"href="/api/interfaces/BuildImageOptions#memory"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-11">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-11"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="memswap">memswap?<aclass="hash-link"aria-label="Direct link to memswap?"title="Direct link to memswap?"href="/api/interfaces/BuildImageOptions#memswap"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-12">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-12"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="networkmode">networkmode?<aclass="hash-link"aria-label="Direct link to networkmode?"title="Direct link to networkmode?"href="/api/interfaces/BuildImageOptions#networkmode"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-13">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-13"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="nocache">nocache?<aclass="hash-link"aria-label="Direct link to nocache?"title="Direct link to nocache?"href="/api/interfaces/BuildImageOptions#nocache"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-14">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-14"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="outputs">outputs?<aclass="hash-link"aria-label="Direct link to outputs?"title="Direct link to outputs?"href="/api/interfaces/BuildImageOptions#outputs"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-15">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-15"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="platform">platform?<aclass="hash-link"aria-label="Direct link to platform?"title="Direct link to platform?"href="/api/interfaces/BuildImageOptions#platform"></a></h3>
<p>Set the os/arch of the built image (and its base image, when using one) to the provided value instead of using the current operating system and architecture of the host</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-16">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-16"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="provider">provider?<aclass="hash-link"aria-label="Direct link to provider?"title="Direct link to provider?"href="/api/interfaces/BuildImageOptions#provider"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-17">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-17"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="pull">pull?<aclass="hash-link"aria-label="Direct link to pull?"title="Direct link to pull?"href="/api/interfaces/BuildImageOptions#pull"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-18">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-18"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="q">q?<aclass="hash-link"aria-label="Direct link to q?"title="Direct link to q?"href="/api/interfaces/BuildImageOptions#q"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-19">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-19"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="remote">remote?<aclass="hash-link"aria-label="Direct link to remote?"title="Direct link to remote?"href="/api/interfaces/BuildImageOptions#remote"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-20">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-20"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="rm">rm?<aclass="hash-link"aria-label="Direct link to rm?"title="Direct link to rm?"href="/api/interfaces/BuildImageOptions#rm"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-21">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-21"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="shmsize">shmsize?<aclass="hash-link"aria-label="Direct link to shmsize?"title="Direct link to shmsize?"href="/api/interfaces/BuildImageOptions#shmsize"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-22">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-22"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="squash">squash?<aclass="hash-link"aria-label="Direct link to squash?"title="Direct link to squash?"href="/api/interfaces/BuildImageOptions#squash"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-23">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-23"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="tag">tag?<aclass="hash-link"aria-label="Direct link to tag?"title="Direct link to tag?"href="/api/interfaces/BuildImageOptions#tag"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-24">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-24"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="target">target?<aclass="hash-link"aria-label="Direct link to target?"title="Direct link to target?"href="/api/interfaces/BuildImageOptions#target"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="defined-in-25">Defined in<aclass="hash-link"aria-label="Direct link to Defined in"title="Direct link to Defined in"href="/api/interfaces/BuildImageOptions#defined-in-25"></a></h4>