github.com/myhau/pulumi/pkg/v3@v3.70.2-0.20221116134521-f2775972e587/codegen/testing/test/testdata/simple-plain-schema/docs/dofoo/_index.md (about)

     1  
     2  ---
     3  title: "doFoo"
     4  title_tag: "example.doFoo"
     5  meta_desc: "Documentation for the example.doFoo 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  
    16  
    17  
    18  ## Using doFoo {#using}
    19  
    20  <div>
    21  <pulumi-chooser type="language" options="typescript,python,go,csharp,java,yaml"></pulumi-chooser>
    22  </div>
    23  
    24  
    25  <div>
    26  <pulumi-choosable type="language" values="javascript,typescript">
    27  <div class="highlight"
    28  ><pre class="chroma"><code class="language-typescript" data-lang="typescript"
    29  ><span class="k">function </span>doFoo<span class="p">(</span><span class="nx">args</span><span class="p">:</span> <span class="nx">DoFooArgs</span><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&lt;<span class="nx"><a href="#result">DoFooResult</a></span>></span
    30  ></code></pre></div>
    31  </pulumi-choosable>
    32  </div>
    33  
    34  
    35  <div>
    36  <pulumi-choosable type="language" values="python">
    37  <div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"
    38  ><span class="k">def </span>do_foo<span class="p">(</span><span class="nx">foo</span><span class="p">:</span> <span class="nx">Optional[Foo]</span> = None<span class="p">,</span>
    39             <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">) -&gt;</span> <span>DoFooResult</span
    40  ></code></pre></div>
    41  </pulumi-choosable>
    42  </div>
    43  
    44  
    45  <div>
    46  <pulumi-choosable type="language" values="go">
    47  <div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"
    48  ><span class="k">func </span>DoFoo<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">args</span><span class="p"> *</span><span class="nx">DoFooArgs</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">DoFooResult</a></span>, error)</span
    49  ></code></pre></div>
    50  
    51  &gt; Note: This function is named `DoFoo` in the Go SDK.
    52  
    53  </pulumi-choosable>
    54  </div>
    55  
    56  
    57  <div>
    58  <pulumi-choosable type="language" values="csharp">
    59  <div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public static class </span><span class="nx">DoFoo </span><span class="p">
    60  {</span><span class="k">
    61      public static </span>Task&lt;<span class="nx"><a href="#result">DoFooResult</a></span>> <span class="p">InvokeAsync(</span><span class="nx">DoFooArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</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">
    62  }</span></code></pre></div>
    63  </pulumi-choosable>
    64  </div>
    65  
    66  
    67  <div>
    68  <pulumi-choosable type="language" values="java">
    69  <div class="highlight"><pre class="chroma"><code class="language-java" data-lang="java"><span class="k">public static CompletableFuture&lt;<span class="nx"><a href="#result">DoFooResult</a></span>> </span>doFoo<span class="p">(</span><span class="nx">DoFooArgs</span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx">InvokeOptions</span><span class="p"> </span><span class="nx">options<span class="p">)</span>
    70  <span class="c">// Output-based functions aren't available in Java yet</span>
    71  </code></pre></div>
    72  </pulumi-choosable>
    73  </div>
    74  
    75  
    76  <div>
    77  <pulumi-choosable type="language" values="yaml">
    78  <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml"><span class="k">fn::invoke:</span>
    79  <span class="k">&nbsp;&nbsp;function:</span> example:doFoo
    80  <span class="k">&nbsp;&nbsp;arguments:</span>
    81  <span class="c">&nbsp;&nbsp;&nbsp;&nbsp;# arguments dictionary</span></code></pre></div>
    82  </pulumi-choosable>
    83  </div>
    84  
    85  
    86  
    87  The following arguments are supported:
    88  
    89  
    90  <div>
    91  <pulumi-choosable type="language" values="csharp">
    92  <dl class="resources-properties"><dt class="property-required"
    93              title="Required">
    94          <span id="foo_csharp">
    95  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#foo_csharp" style="color: inherit; text-decoration: inherit;">Foo</a>
    96  </span>
    97          <span class="property-indicator"></span>
    98          <span class="property-type"><a href="#foo">Foo</a></span>
    99      </dt>
   100      <dd></dd></dl>
   101  </pulumi-choosable>
   102  </div>
   103  
   104  <div>
   105  <pulumi-choosable type="language" values="go">
   106  <dl class="resources-properties"><dt class="property-required"
   107              title="Required">
   108          <span id="foo_go">
   109  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#foo_go" style="color: inherit; text-decoration: inherit;">Foo</a>
   110  </span>
   111          <span class="property-indicator"></span>
   112          <span class="property-type"><a href="#foo">Foo</a></span>
   113      </dt>
   114      <dd></dd></dl>
   115  </pulumi-choosable>
   116  </div>
   117  
   118  <div>
   119  <pulumi-choosable type="language" values="java">
   120  <dl class="resources-properties"><dt class="property-required"
   121              title="Required">
   122          <span id="foo_java">
   123  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#foo_java" style="color: inherit; text-decoration: inherit;">foo</a>
   124  </span>
   125          <span class="property-indicator"></span>
   126          <span class="property-type"><a href="#foo">Foo</a></span>
   127      </dt>
   128      <dd></dd></dl>
   129  </pulumi-choosable>
   130  </div>
   131  
   132  <div>
   133  <pulumi-choosable type="language" values="javascript,typescript">
   134  <dl class="resources-properties"><dt class="property-required"
   135              title="Required">
   136          <span id="foo_nodejs">
   137  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#foo_nodejs" style="color: inherit; text-decoration: inherit;">foo</a>
   138  </span>
   139          <span class="property-indicator"></span>
   140          <span class="property-type"><a href="#foo">Foo</a></span>
   141      </dt>
   142      <dd></dd></dl>
   143  </pulumi-choosable>
   144  </div>
   145  
   146  <div>
   147  <pulumi-choosable type="language" values="python">
   148  <dl class="resources-properties"><dt class="property-required"
   149              title="Required">
   150          <span id="foo_python">
   151  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#foo_python" style="color: inherit; text-decoration: inherit;">foo</a>
   152  </span>
   153          <span class="property-indicator"></span>
   154          <span class="property-type"><a href="#foo">Foo</a></span>
   155      </dt>
   156      <dd></dd></dl>
   157  </pulumi-choosable>
   158  </div>
   159  
   160  <div>
   161  <pulumi-choosable type="language" values="yaml">
   162  <dl class="resources-properties"><dt class="property-required"
   163              title="Required">
   164          <span id="foo_yaml">
   165  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#foo_yaml" style="color: inherit; text-decoration: inherit;">foo</a>
   166  </span>
   167          <span class="property-indicator"></span>
   168          <span class="property-type"><a href="#foo">Property Map</a></span>
   169      </dt>
   170      <dd></dd></dl>
   171  </pulumi-choosable>
   172  </div>
   173  
   174  
   175  
   176  
   177  ## doFoo Result {#result}
   178  
   179  The following output properties are available:
   180  
   181  
   182  
   183  
   184  
   185  
   186  ## Supporting Types
   187  
   188  
   189  <h4 id="foo">Foo</h4>
   190  
   191  
   192  
   193  <div>
   194  <pulumi-choosable type="language" values="csharp">
   195  <dl class="resources-properties"><dt class="property-required"
   196              title="Required">
   197          <span id="a_csharp">
   198  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_csharp" style="color: inherit; text-decoration: inherit;">A</a>
   199  </span>
   200          <span class="property-indicator"></span>
   201          <span class="property-type">bool</span>
   202      </dt>
   203      <dd></dd><dt class="property-required"
   204              title="Required">
   205          <span id="c_csharp">
   206  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#c_csharp" style="color: inherit; text-decoration: inherit;">C</a>
   207  </span>
   208          <span class="property-indicator"></span>
   209          <span class="property-type">int</span>
   210      </dt>
   211      <dd></dd><dt class="property-required"
   212              title="Required">
   213          <span id="e_csharp">
   214  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#e_csharp" style="color: inherit; text-decoration: inherit;">E</a>
   215  </span>
   216          <span class="property-indicator"></span>
   217          <span class="property-type">string</span>
   218      </dt>
   219      <dd></dd><dt class="property-optional"
   220              title="Optional">
   221          <span id="b_csharp">
   222  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_csharp" style="color: inherit; text-decoration: inherit;">B</a>
   223  </span>
   224          <span class="property-indicator"></span>
   225          <span class="property-type">bool</span>
   226      </dt>
   227      <dd></dd><dt class="property-optional"
   228              title="Optional">
   229          <span id="d_csharp">
   230  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#d_csharp" style="color: inherit; text-decoration: inherit;">D</a>
   231  </span>
   232          <span class="property-indicator"></span>
   233          <span class="property-type">int</span>
   234      </dt>
   235      <dd></dd><dt class="property-optional"
   236              title="Optional">
   237          <span id="f_csharp">
   238  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#f_csharp" style="color: inherit; text-decoration: inherit;">F</a>
   239  </span>
   240          <span class="property-indicator"></span>
   241          <span class="property-type">string</span>
   242      </dt>
   243      <dd></dd></dl>
   244  </pulumi-choosable>
   245  </div>
   246  
   247  <div>
   248  <pulumi-choosable type="language" values="go">
   249  <dl class="resources-properties"><dt class="property-required"
   250              title="Required">
   251          <span id="a_go">
   252  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_go" style="color: inherit; text-decoration: inherit;">A</a>
   253  </span>
   254          <span class="property-indicator"></span>
   255          <span class="property-type">bool</span>
   256      </dt>
   257      <dd></dd><dt class="property-required"
   258              title="Required">
   259          <span id="c_go">
   260  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#c_go" style="color: inherit; text-decoration: inherit;">C</a>
   261  </span>
   262          <span class="property-indicator"></span>
   263          <span class="property-type">int</span>
   264      </dt>
   265      <dd></dd><dt class="property-required"
   266              title="Required">
   267          <span id="e_go">
   268  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#e_go" style="color: inherit; text-decoration: inherit;">E</a>
   269  </span>
   270          <span class="property-indicator"></span>
   271          <span class="property-type">string</span>
   272      </dt>
   273      <dd></dd><dt class="property-optional"
   274              title="Optional">
   275          <span id="b_go">
   276  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_go" style="color: inherit; text-decoration: inherit;">B</a>
   277  </span>
   278          <span class="property-indicator"></span>
   279          <span class="property-type">bool</span>
   280      </dt>
   281      <dd></dd><dt class="property-optional"
   282              title="Optional">
   283          <span id="d_go">
   284  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#d_go" style="color: inherit; text-decoration: inherit;">D</a>
   285  </span>
   286          <span class="property-indicator"></span>
   287          <span class="property-type">int</span>
   288      </dt>
   289      <dd></dd><dt class="property-optional"
   290              title="Optional">
   291          <span id="f_go">
   292  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#f_go" style="color: inherit; text-decoration: inherit;">F</a>
   293  </span>
   294          <span class="property-indicator"></span>
   295          <span class="property-type">string</span>
   296      </dt>
   297      <dd></dd></dl>
   298  </pulumi-choosable>
   299  </div>
   300  
   301  <div>
   302  <pulumi-choosable type="language" values="java">
   303  <dl class="resources-properties"><dt class="property-required"
   304              title="Required">
   305          <span id="a_java">
   306  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_java" style="color: inherit; text-decoration: inherit;">a</a>
   307  </span>
   308          <span class="property-indicator"></span>
   309          <span class="property-type">Boolean</span>
   310      </dt>
   311      <dd></dd><dt class="property-required"
   312              title="Required">
   313          <span id="c_java">
   314  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#c_java" style="color: inherit; text-decoration: inherit;">c</a>
   315  </span>
   316          <span class="property-indicator"></span>
   317          <span class="property-type">Integer</span>
   318      </dt>
   319      <dd></dd><dt class="property-required"
   320              title="Required">
   321          <span id="e_java">
   322  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#e_java" style="color: inherit; text-decoration: inherit;">e</a>
   323  </span>
   324          <span class="property-indicator"></span>
   325          <span class="property-type">String</span>
   326      </dt>
   327      <dd></dd><dt class="property-optional"
   328              title="Optional">
   329          <span id="b_java">
   330  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_java" style="color: inherit; text-decoration: inherit;">b</a>
   331  </span>
   332          <span class="property-indicator"></span>
   333          <span class="property-type">Boolean</span>
   334      </dt>
   335      <dd></dd><dt class="property-optional"
   336              title="Optional">
   337          <span id="d_java">
   338  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#d_java" style="color: inherit; text-decoration: inherit;">d</a>
   339  </span>
   340          <span class="property-indicator"></span>
   341          <span class="property-type">Integer</span>
   342      </dt>
   343      <dd></dd><dt class="property-optional"
   344              title="Optional">
   345          <span id="f_java">
   346  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#f_java" style="color: inherit; text-decoration: inherit;">f</a>
   347  </span>
   348          <span class="property-indicator"></span>
   349          <span class="property-type">String</span>
   350      </dt>
   351      <dd></dd></dl>
   352  </pulumi-choosable>
   353  </div>
   354  
   355  <div>
   356  <pulumi-choosable type="language" values="javascript,typescript">
   357  <dl class="resources-properties"><dt class="property-required"
   358              title="Required">
   359          <span id="a_nodejs">
   360  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_nodejs" style="color: inherit; text-decoration: inherit;">a</a>
   361  </span>
   362          <span class="property-indicator"></span>
   363          <span class="property-type">boolean</span>
   364      </dt>
   365      <dd></dd><dt class="property-required"
   366              title="Required">
   367          <span id="c_nodejs">
   368  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#c_nodejs" style="color: inherit; text-decoration: inherit;">c</a>
   369  </span>
   370          <span class="property-indicator"></span>
   371          <span class="property-type">number</span>
   372      </dt>
   373      <dd></dd><dt class="property-required"
   374              title="Required">
   375          <span id="e_nodejs">
   376  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#e_nodejs" style="color: inherit; text-decoration: inherit;">e</a>
   377  </span>
   378          <span class="property-indicator"></span>
   379          <span class="property-type">string</span>
   380      </dt>
   381      <dd></dd><dt class="property-optional"
   382              title="Optional">
   383          <span id="b_nodejs">
   384  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_nodejs" style="color: inherit; text-decoration: inherit;">b</a>
   385  </span>
   386          <span class="property-indicator"></span>
   387          <span class="property-type">boolean</span>
   388      </dt>
   389      <dd></dd><dt class="property-optional"
   390              title="Optional">
   391          <span id="d_nodejs">
   392  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#d_nodejs" style="color: inherit; text-decoration: inherit;">d</a>
   393  </span>
   394          <span class="property-indicator"></span>
   395          <span class="property-type">number</span>
   396      </dt>
   397      <dd></dd><dt class="property-optional"
   398              title="Optional">
   399          <span id="f_nodejs">
   400  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#f_nodejs" style="color: inherit; text-decoration: inherit;">f</a>
   401  </span>
   402          <span class="property-indicator"></span>
   403          <span class="property-type">string</span>
   404      </dt>
   405      <dd></dd></dl>
   406  </pulumi-choosable>
   407  </div>
   408  
   409  <div>
   410  <pulumi-choosable type="language" values="python">
   411  <dl class="resources-properties"><dt class="property-required"
   412              title="Required">
   413          <span id="a_python">
   414  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_python" style="color: inherit; text-decoration: inherit;">a</a>
   415  </span>
   416          <span class="property-indicator"></span>
   417          <span class="property-type">bool</span>
   418      </dt>
   419      <dd></dd><dt class="property-required"
   420              title="Required">
   421          <span id="c_python">
   422  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#c_python" style="color: inherit; text-decoration: inherit;">c</a>
   423  </span>
   424          <span class="property-indicator"></span>
   425          <span class="property-type">int</span>
   426      </dt>
   427      <dd></dd><dt class="property-required"
   428              title="Required">
   429          <span id="e_python">
   430  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#e_python" style="color: inherit; text-decoration: inherit;">e</a>
   431  </span>
   432          <span class="property-indicator"></span>
   433          <span class="property-type">str</span>
   434      </dt>
   435      <dd></dd><dt class="property-optional"
   436              title="Optional">
   437          <span id="b_python">
   438  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_python" style="color: inherit; text-decoration: inherit;">b</a>
   439  </span>
   440          <span class="property-indicator"></span>
   441          <span class="property-type">bool</span>
   442      </dt>
   443      <dd></dd><dt class="property-optional"
   444              title="Optional">
   445          <span id="d_python">
   446  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#d_python" style="color: inherit; text-decoration: inherit;">d</a>
   447  </span>
   448          <span class="property-indicator"></span>
   449          <span class="property-type">int</span>
   450      </dt>
   451      <dd></dd><dt class="property-optional"
   452              title="Optional">
   453          <span id="f_python">
   454  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#f_python" style="color: inherit; text-decoration: inherit;">f</a>
   455  </span>
   456          <span class="property-indicator"></span>
   457          <span class="property-type">str</span>
   458      </dt>
   459      <dd></dd></dl>
   460  </pulumi-choosable>
   461  </div>
   462  
   463  <div>
   464  <pulumi-choosable type="language" values="yaml">
   465  <dl class="resources-properties"><dt class="property-required"
   466              title="Required">
   467          <span id="a_yaml">
   468  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#a_yaml" style="color: inherit; text-decoration: inherit;">a</a>
   469  </span>
   470          <span class="property-indicator"></span>
   471          <span class="property-type">Boolean</span>
   472      </dt>
   473      <dd></dd><dt class="property-required"
   474              title="Required">
   475          <span id="c_yaml">
   476  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#c_yaml" style="color: inherit; text-decoration: inherit;">c</a>
   477  </span>
   478          <span class="property-indicator"></span>
   479          <span class="property-type">Number</span>
   480      </dt>
   481      <dd></dd><dt class="property-required"
   482              title="Required">
   483          <span id="e_yaml">
   484  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#e_yaml" style="color: inherit; text-decoration: inherit;">e</a>
   485  </span>
   486          <span class="property-indicator"></span>
   487          <span class="property-type">String</span>
   488      </dt>
   489      <dd></dd><dt class="property-optional"
   490              title="Optional">
   491          <span id="b_yaml">
   492  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#b_yaml" style="color: inherit; text-decoration: inherit;">b</a>
   493  </span>
   494          <span class="property-indicator"></span>
   495          <span class="property-type">Boolean</span>
   496      </dt>
   497      <dd></dd><dt class="property-optional"
   498              title="Optional">
   499          <span id="d_yaml">
   500  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#d_yaml" style="color: inherit; text-decoration: inherit;">d</a>
   501  </span>
   502          <span class="property-indicator"></span>
   503          <span class="property-type">Number</span>
   504      </dt>
   505      <dd></dd><dt class="property-optional"
   506              title="Optional">
   507          <span id="f_yaml">
   508  <a data-swiftype-name="resource-property" data-swiftype-type="text" href="#f_yaml" style="color: inherit; text-decoration: inherit;">f</a>
   509  </span>
   510          <span class="property-indicator"></span>
   511          <span class="property-type">String</span>
   512      </dt>
   513      <dd></dd></dl>
   514  </pulumi-choosable>
   515  </div>
   516  
   517  
   518  
   519  
   520  
   521  <h2 id="package-details">Package Details</h2>
   522  <dl class="package-details">
   523  	<dt>Repository</dt>
   524  	<dd><a href=""></a></dd>
   525  	<dt>License</dt>
   526  	<dd></dd>
   527  </dl>
   528