github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/testing/test/testdata/output-funcs/docs/getclientconfig/_index.md (about) 1 2 --- 3 title: "getClientConfig" 4 title_tag: "mypkg.getClientConfig" 5 meta_desc: "Documentation for the mypkg.getClientConfig function with examples, input properties, output properties, and supporting types." 6 layout: api 7 no_edit_this_page: true 8 --- 9 10 11 12 <!-- WARNING: this file was generated by test. --> 13 <!-- Do not edit by hand unless you're certain you know what you are doing! --> 14 15 Failing example taken from azure-native. Original doc: Use this function to access the current configuration of the native Azure provider. 16 17 18 19 20 ## Using getClientConfig {#using} 21 22 <div> 23 <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser> 24 </div> 25 26 27 <div> 28 <pulumi-choosable type="language" values="javascript,typescript"> 29 <div class="highlight" 30 ><pre class="chroma"><code class="language-typescript" data-lang="typescript" 31 ><span class="k">function </span>getClientConfig<span class="p">(</span><span class="nx">opts</span><span class="p">?:</span> <span class="nx"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#InvokeOptions">InvokeOptions</a></span><span class="p">): Promise<<span class="nx"><a href="#result">GetClientConfigResult</a></span>></span 32 ></code></pre></div> 33 </pulumi-choosable> 34 </div> 35 36 37 <div> 38 <pulumi-choosable type="language" values="python"> 39 <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python" 40 ><span class="k">def </span>get_client_config<span class="p">(</span><span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.InvokeOptions">Optional[InvokeOptions]</a></span> = None<span class="p">) -></span> <span>GetClientConfigResult</span 41 ></code></pre></div> 42 </pulumi-choosable> 43 </div> 44 45 46 <div> 47 <pulumi-choosable type="language" values="go"> 48 <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go" 49 ><span class="k">func </span>GetClientConfig<span class="p">(</span><span class="nx">ctx</span><span class="p"> *</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span><span class="p">,</span> <span class="nx">opts</span><span class="p"> ...</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#InvokeOption">InvokeOption</a></span><span class="p">) (*<span class="nx"><a href="#result">GetClientConfigResult</a></span>, error)</span 50 ></code></pre></div> 51 52 > Note: This function is named `GetClientConfig` in the Go SDK. 53 54 </pulumi-choosable> 55 </div> 56 57 58 <div> 59 <pulumi-choosable type="language" values="csharp"> 60 <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static class </span><span class="nx">GetClientConfig </span><span class="p"> 61 {</span><span class="k"> 62 public static </span>Task<<span class="nx"><a href="#result">GetClientConfigResult</a></span>> <span class="p">InvokeAsync(</span><span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.InvokeOptions.html">InvokeOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span><span class="p"> 63 }</span></code></pre></div> 64 </pulumi-choosable> 65 </div> 66 67 68 <div> 69 <pulumi-choosable type="language" values="java"> 70 <div class="highlight"><pre class="chroma"><code class="language-java" data-lang="java"><span class="k">public static CompletableFuture<<span class="nx"><a href="#result">GetClientConfigResult</a></span>> </span>getClientConfig<span class="p">(</span><span class="nx">InvokeOptions</span><span class="p"> </span><span class="nx">options<span class="p">)</span> 71 <span class="c">// Output-based functions aren't available in Java yet</span> 72 </code></pre></div> 73 </pulumi-choosable> 74 </div> 75 76 77 <div> 78 <pulumi-choosable type="language" values="yaml"> 79 <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="k">fn::invoke:</span> 80 <span class="k"> function:</span> mypkg:getClientConfig 81 <span class="k"> arguments:</span> 82 <span class="c"> # arguments dictionary</span></code></pre></div> 83 </pulumi-choosable> 84 </div> 85 86 87 88 89 ## getClientConfig Result {#result} 90 91 The following output properties are available: 92 93 94 95 <div> 96 <pulumi-choosable type="language" values="csharp"> 97 <dl class="resources-properties"><dt class="property-" 98 title=""> 99 <span id="clientid_csharp"> 100 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#clientid_csharp" style="color: inherit; text-decoration: inherit;">Client<wbr>Id</a> 101 </span> 102 <span class="property-indicator"></span> 103 <span class="property-type">string</span> 104 </dt> 105 <dd><p>Azure Client ID (Application Object ID).</p> 106 </dd><dt class="property-" 107 title=""> 108 <span id="objectid_csharp"> 109 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#objectid_csharp" style="color: inherit; text-decoration: inherit;">Object<wbr>Id</a> 110 </span> 111 <span class="property-indicator"></span> 112 <span class="property-type">string</span> 113 </dt> 114 <dd><p>Azure Object ID of the current user or service principal.</p> 115 </dd><dt class="property-" 116 title=""> 117 <span id="subscriptionid_csharp"> 118 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#subscriptionid_csharp" style="color: inherit; text-decoration: inherit;">Subscription<wbr>Id</a> 119 </span> 120 <span class="property-indicator"></span> 121 <span class="property-type">string</span> 122 </dt> 123 <dd><p>Azure Subscription ID</p> 124 </dd><dt class="property-" 125 title=""> 126 <span id="tenantid_csharp"> 127 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#tenantid_csharp" style="color: inherit; text-decoration: inherit;">Tenant<wbr>Id</a> 128 </span> 129 <span class="property-indicator"></span> 130 <span class="property-type">string</span> 131 </dt> 132 <dd><p>Azure Tenant ID</p> 133 </dd></dl> 134 </pulumi-choosable> 135 </div> 136 137 <div> 138 <pulumi-choosable type="language" values="go"> 139 <dl class="resources-properties"><dt class="property-" 140 title=""> 141 <span id="clientid_go"> 142 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#clientid_go" style="color: inherit; text-decoration: inherit;">Client<wbr>Id</a> 143 </span> 144 <span class="property-indicator"></span> 145 <span class="property-type">string</span> 146 </dt> 147 <dd><p>Azure Client ID (Application Object ID).</p> 148 </dd><dt class="property-" 149 title=""> 150 <span id="objectid_go"> 151 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#objectid_go" style="color: inherit; text-decoration: inherit;">Object<wbr>Id</a> 152 </span> 153 <span class="property-indicator"></span> 154 <span class="property-type">string</span> 155 </dt> 156 <dd><p>Azure Object ID of the current user or service principal.</p> 157 </dd><dt class="property-" 158 title=""> 159 <span id="subscriptionid_go"> 160 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#subscriptionid_go" style="color: inherit; text-decoration: inherit;">Subscription<wbr>Id</a> 161 </span> 162 <span class="property-indicator"></span> 163 <span class="property-type">string</span> 164 </dt> 165 <dd><p>Azure Subscription ID</p> 166 </dd><dt class="property-" 167 title=""> 168 <span id="tenantid_go"> 169 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#tenantid_go" style="color: inherit; text-decoration: inherit;">Tenant<wbr>Id</a> 170 </span> 171 <span class="property-indicator"></span> 172 <span class="property-type">string</span> 173 </dt> 174 <dd><p>Azure Tenant ID</p> 175 </dd></dl> 176 </pulumi-choosable> 177 </div> 178 179 <div> 180 <pulumi-choosable type="language" values="java"> 181 <dl class="resources-properties"><dt class="property-" 182 title=""> 183 <span id="clientid_java"> 184 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#clientid_java" style="color: inherit; text-decoration: inherit;">client<wbr>Id</a> 185 </span> 186 <span class="property-indicator"></span> 187 <span class="property-type">String</span> 188 </dt> 189 <dd><p>Azure Client ID (Application Object ID).</p> 190 </dd><dt class="property-" 191 title=""> 192 <span id="objectid_java"> 193 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#objectid_java" style="color: inherit; text-decoration: inherit;">object<wbr>Id</a> 194 </span> 195 <span class="property-indicator"></span> 196 <span class="property-type">String</span> 197 </dt> 198 <dd><p>Azure Object ID of the current user or service principal.</p> 199 </dd><dt class="property-" 200 title=""> 201 <span id="subscriptionid_java"> 202 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#subscriptionid_java" style="color: inherit; text-decoration: inherit;">subscription<wbr>Id</a> 203 </span> 204 <span class="property-indicator"></span> 205 <span class="property-type">String</span> 206 </dt> 207 <dd><p>Azure Subscription ID</p> 208 </dd><dt class="property-" 209 title=""> 210 <span id="tenantid_java"> 211 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#tenantid_java" style="color: inherit; text-decoration: inherit;">tenant<wbr>Id</a> 212 </span> 213 <span class="property-indicator"></span> 214 <span class="property-type">String</span> 215 </dt> 216 <dd><p>Azure Tenant ID</p> 217 </dd></dl> 218 </pulumi-choosable> 219 </div> 220 221 <div> 222 <pulumi-choosable type="language" values="javascript,typescript"> 223 <dl class="resources-properties"><dt class="property-" 224 title=""> 225 <span id="clientid_nodejs"> 226 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#clientid_nodejs" style="color: inherit; text-decoration: inherit;">client<wbr>Id</a> 227 </span> 228 <span class="property-indicator"></span> 229 <span class="property-type">string</span> 230 </dt> 231 <dd><p>Azure Client ID (Application Object ID).</p> 232 </dd><dt class="property-" 233 title=""> 234 <span id="objectid_nodejs"> 235 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#objectid_nodejs" style="color: inherit; text-decoration: inherit;">object<wbr>Id</a> 236 </span> 237 <span class="property-indicator"></span> 238 <span class="property-type">string</span> 239 </dt> 240 <dd><p>Azure Object ID of the current user or service principal.</p> 241 </dd><dt class="property-" 242 title=""> 243 <span id="subscriptionid_nodejs"> 244 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#subscriptionid_nodejs" style="color: inherit; text-decoration: inherit;">subscription<wbr>Id</a> 245 </span> 246 <span class="property-indicator"></span> 247 <span class="property-type">string</span> 248 </dt> 249 <dd><p>Azure Subscription ID</p> 250 </dd><dt class="property-" 251 title=""> 252 <span id="tenantid_nodejs"> 253 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#tenantid_nodejs" style="color: inherit; text-decoration: inherit;">tenant<wbr>Id</a> 254 </span> 255 <span class="property-indicator"></span> 256 <span class="property-type">string</span> 257 </dt> 258 <dd><p>Azure Tenant ID</p> 259 </dd></dl> 260 </pulumi-choosable> 261 </div> 262 263 <div> 264 <pulumi-choosable type="language" values="python"> 265 <dl class="resources-properties"><dt class="property-" 266 title=""> 267 <span id="client_id_python"> 268 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#client_id_python" style="color: inherit; text-decoration: inherit;">client_<wbr>id</a> 269 </span> 270 <span class="property-indicator"></span> 271 <span class="property-type">str</span> 272 </dt> 273 <dd><p>Azure Client ID (Application Object ID).</p> 274 </dd><dt class="property-" 275 title=""> 276 <span id="object_id_python"> 277 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#object_id_python" style="color: inherit; text-decoration: inherit;">object_<wbr>id</a> 278 </span> 279 <span class="property-indicator"></span> 280 <span class="property-type">str</span> 281 </dt> 282 <dd><p>Azure Object ID of the current user or service principal.</p> 283 </dd><dt class="property-" 284 title=""> 285 <span id="subscription_id_python"> 286 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#subscription_id_python" style="color: inherit; text-decoration: inherit;">subscription_<wbr>id</a> 287 </span> 288 <span class="property-indicator"></span> 289 <span class="property-type">str</span> 290 </dt> 291 <dd><p>Azure Subscription ID</p> 292 </dd><dt class="property-" 293 title=""> 294 <span id="tenant_id_python"> 295 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#tenant_id_python" style="color: inherit; text-decoration: inherit;">tenant_<wbr>id</a> 296 </span> 297 <span class="property-indicator"></span> 298 <span class="property-type">str</span> 299 </dt> 300 <dd><p>Azure Tenant ID</p> 301 </dd></dl> 302 </pulumi-choosable> 303 </div> 304 305 <div> 306 <pulumi-choosable type="language" values="yaml"> 307 <dl class="resources-properties"><dt class="property-" 308 title=""> 309 <span id="clientid_yaml"> 310 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#clientid_yaml" style="color: inherit; text-decoration: inherit;">client<wbr>Id</a> 311 </span> 312 <span class="property-indicator"></span> 313 <span class="property-type">String</span> 314 </dt> 315 <dd><p>Azure Client ID (Application Object ID).</p> 316 </dd><dt class="property-" 317 title=""> 318 <span id="objectid_yaml"> 319 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#objectid_yaml" style="color: inherit; text-decoration: inherit;">object<wbr>Id</a> 320 </span> 321 <span class="property-indicator"></span> 322 <span class="property-type">String</span> 323 </dt> 324 <dd><p>Azure Object ID of the current user or service principal.</p> 325 </dd><dt class="property-" 326 title=""> 327 <span id="subscriptionid_yaml"> 328 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#subscriptionid_yaml" style="color: inherit; text-decoration: inherit;">subscription<wbr>Id</a> 329 </span> 330 <span class="property-indicator"></span> 331 <span class="property-type">String</span> 332 </dt> 333 <dd><p>Azure Subscription ID</p> 334 </dd><dt class="property-" 335 title=""> 336 <span id="tenantid_yaml"> 337 <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#tenantid_yaml" style="color: inherit; text-decoration: inherit;">tenant<wbr>Id</a> 338 </span> 339 <span class="property-indicator"></span> 340 <span class="property-type">String</span> 341 </dt> 342 <dd><p>Azure Tenant ID</p> 343 </dd></dl> 344 </pulumi-choosable> 345 </div> 346 347 348 349 350 351 <h2 id="package-details">Package Details</h2> 352 <dl class="package-details"> 353 <dt>Repository</dt> 354 <dd><a href=""></a></dd> 355 <dt>License</dt> 356 <dd></dd> 357 </dl> 358