Skip to content

Commit f5da0e2

Browse files
Merge pull request #285458 from ggailey777/patch-4
[Functions] Reformat H2 refs in Core Tools ref
2 parents 80d7158 + 91923c2 commit f5da0e2

File tree

1 file changed

+36
-64
lines changed

1 file changed

+36
-64
lines changed

articles/azure-functions/functions-core-tools-reference.md

Lines changed: 36 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Reference documentation that supports the Azure Functions Core Tool
44
ms.topic: reference
55
ms.custom:
66
- ignite-2023
7-
ms.date: 08/22/2024
7+
ms.date: 08/20/2023
88
---
99

1010
# Azure Functions Core Tools reference
@@ -26,7 +26,7 @@ Core Tools commands are organized into the following contexts, each providing a
2626

2727
Before using the commands in this article, you must [install the Core Tools](functions-run-local.md#install-the-azure-functions-core-tools).
2828

29-
## func init
29+
## `func init`
3030

3131
Creates a new Functions project in a specific language.
3232

@@ -55,7 +55,7 @@ When you supply `<PROJECT_FOLDER>`, the project is created in a new folder with
5555
> [!NOTE]
5656
> When you use either `--docker` or `--docker-only` options, Core Tools automatically create the Dockerfile for C#, JavaScript, Python, and PowerShell functions. For Java functions, you must manually create the Dockerfile. For more information, see [Creating containerized function apps](functions-how-to-custom-container.md#creating-containerized-function-apps).
5757
58-
## func logs
58+
## `func logs`
5959

6060
Gets logs for functions running in a Kubernetes cluster.
6161

@@ -72,7 +72,7 @@ The `func logs` action supports the following options:
7272

7373
To learn more, see [Azure Functions on Kubernetes with KEDA](functions-kubernetes-keda.md).
7474

75-
## func new
75+
## `func new`
7676

7777
Creates a new function in the current project based on a template.
7878

@@ -94,7 +94,7 @@ The `func new` action supports the following options:
9494

9595
To learn more, see [Create a function](functions-run-local.md#create-func).
9696

97-
## func run
97+
## `func run`
9898

9999
*Version 1.x only.*
100100

@@ -120,13 +120,13 @@ For example, to call an HTTP-triggered function and pass content body, run the f
120120
func run MyHttpTrigger --content '{\"name\": \"Azure\"}'
121121
```
122122

123-
## func start
123+
## `func start`
124124

125125
Starts the local runtime host and loads the function project in the current folder.
126126

127127
The specific command depends on the [runtime version](functions-versions.md).
128128

129-
# [v2.x+](#tab/v2)
129+
### [v2.x+](#tab/v2)
130130

131131
```command
132132
func start
@@ -152,7 +152,7 @@ func start
152152

153153
With the project running, you can [verify individual function endpoints](functions-run-local.md#run-a-local-function).
154154

155-
# [v1.x](#tab/v1)
155+
### [v1.x](#tab/v1)
156156

157157
```command
158158
func host start
@@ -173,48 +173,26 @@ In version 1.x, you can also use the [`func run`](#func-run) command to run a sp
173173

174174
---
175175

176-
## func azure functionapp fetch-app-settings
176+
## `func azure functionapp fetch-app-settings`
177177

178178
Gets settings from a specific function app.
179179

180180
```command
181181
func azure functionapp fetch-app-settings <APP_NAME>
182182
```
183183

184-
`func azure functionapp fetch-app-settings` supports these optional arguments:
185-
186-
| Option | Description |
187-
| ------------ | -------------------------------------- |
188-
| **`--access-token`** | Lets you use a specific access token when performing authenticated `azure` actions. |
189-
| **`--access-token-stdin `** | Reads a specific access token from a standard input. Use this when reading the token directly from a previous command such as [`az account get-access-token`](/cli/azure/account#az-account-get-access-token). |
190-
| **`--management-url`** | Sets the management URL for your cloud. Use this when running in a sovereign cloud. |
191-
| **`--slot`** | Optional name of a specific slot to which to publish. |
192-
| **`--subscription`** | Sets the default subscription to use. |
193-
194184
For more information, see [Download application settings](functions-run-local.md#download-application-settings).
195185

196186
Settings are downloaded into the local.settings.json file for the project. On-screen values are masked for security. You can protect settings in the local.settings.json file by [enabling local encryption](functions-run-local.md#encrypt-the-local-settings-file).
197187

198-
## func azure functionapp list-functions
188+
## `func azure functionapp list-functions`
199189

200190
Returns a list of the functions in the specified function app.
201191

202192
```command
203193
func azure functionapp list-functions <APP_NAME>
204194
```
205-
206-
`func azure functionapp list-functions` supports these optional arguments:
207-
208-
| Option | Description |
209-
| ------------ | -------------------------------------- |
210-
| **`--access-token`** | Lets you use a specific access token when performing authenticated `azure` actions. |
211-
| **`--access-token-stdin `** | Reads a specific access token from a standard input. Use this when reading the token directly from a previous command such as [`az account get-access-token`](/cli/azure/account#az-account-get-access-token). |
212-
| **`--management-url`** | Sets the management URL for your cloud. Use this when running in a sovereign cloud. |
213-
| **`--show-keys`** | Shows HTTP function endpoint URLs that include their default access keys. These URLs can be used to access function endpoints with `function` level [HTTP authentication](functions-bindings-http-webhook-trigger.md#http-auth). |
214-
| **`--slot`** | Optional name of a specific slot to which to publish. |
215-
| **`--subscription`** | Sets the default subscription to use. |
216-
217-
## func azure functionapp logstream
195+
## `func azure functionapp logstream`
218196

219197
Connects the local command prompt to streaming logs for the function app in Azure.
220198

@@ -224,20 +202,15 @@ func azure functionapp logstream <APP_NAME>
224202

225203
The default timeout for the connection is 2 hours. You can change the timeout by adding an app setting named [SCM_LOGSTREAM_TIMEOUT](functions-app-settings.md#scm_logstream_timeout), with a timeout value in seconds. Not yet supported for Linux apps in the Consumption plan. For these apps, use the `--browser` option to view logs in the portal.
226204

227-
The `func azure functionapp logstream` command supports these optional arguments:
205+
The `deploy` action supports the following options:
228206

229207
| Option | Description |
230208
| ------------ | -------------------------------------- |
231-
| **`--access-token`** | Lets you use a specific access token when performing authenticated `azure` actions. |
232-
| **`--access-token-stdin `** | Reads a specific access token from a standard input. Use this when reading the token directly from a previous command such as [`az account get-access-token`](/cli/azure/account#az-account-get-access-token). |
233209
| **`--browser`** | Open Azure Application Insights Live Stream for the function app in the default browser. |
234-
| **`--management-url`** | Sets the management URL for your cloud. Use this when running in a sovereign cloud. |
235-
| **`--slot`** | Optional name of a specific slot to which to publish. |
236-
| **`--subscription`** | Sets the default subscription to use. |
237210

238211
For more information, see [Enable streaming execution logs in Azure Functions](streaming-logs.md).
239212

240-
## func azure functionapp publish
213+
## `func azure functionapp publish`
241214

242215
Deploys a Functions project to an existing function app resource in Azure.
243216

@@ -269,7 +242,6 @@ The following publish options apply, based on version:
269242
| **`--overwrite-settings -y`** | Suppress the prompt to overwrite app settings when `--publish-local-settings -i` is used.|
270243
| **`--publish-local-settings -i`** | Publish settings in local.settings.json to Azure, prompting to overwrite if the setting already exists. If you're using a [local storage emulator](functions-develop-local.md#local-storage-emulator), first change the app setting to an [actual storage connection](#func-azure-storage-fetch-connection-string). |
271244
| **`--publish-settings-only`**, **`-o`** | Only publish settings and skip the content. Default is prompt. |
272-
| **`--show-keys`** | Shows HTTP function endpoint URLs that include their default access keys. These URLs can be used to access function endpoints with `function` level [HTTP authentication](functions-bindings-http-webhook-trigger.md#http-auth). |
273245
| **`--slot`** | Optional name of a specific slot to which to publish. |
274246
| **`--subscription`** | Sets the default subscription to use. |
275247

@@ -283,7 +255,7 @@ The following publish options apply, based on version:
283255

284256
---
285257

286-
## func azure storage fetch-connection-string
258+
## `func azure storage fetch-connection-string`
287259

288260
Gets the connection string for the specified Azure Storage account.
289261

@@ -293,7 +265,7 @@ func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>
293265

294266
For more information, see [Download a storage connection string](functions-run-local.md#download-a-storage-connection-string).
295267

296-
## func azurecontainerapps deploy
268+
## `func azurecontainerapps deploy`
297269

298270
Deploys a containerized function app to an Azure Container Apps environment. Both the storage account used by the function app and the environment must already exist. For more information, see [Azure Container Apps hosting of Azure Functions](functions-container-apps-hosting.md).
299271

@@ -326,11 +298,11 @@ The following deployment options apply:
326298
> [!IMPORTANT]
327299
> Storage connection strings and other service credentials are important secrets. Make sure to securely store any script files using `func azurecontainerapps deploy` and don't store them in any publicly accessible source control.
328300
329-
## func deploy
301+
## `func deploy`
330302

331303
The `func deploy` command is deprecated. Instead use [`func kubernetes deploy`](#func-kubernetes-deploy).
332304

333-
## func durable delete-task-hub
305+
## `func durable delete-task-hub`
334306

335307
Deletes all storage artifacts in the Durable Functions task hub.
336308

@@ -347,7 +319,7 @@ The `delete-task-hub` action supports the following options:
347319

348320
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#delete-a-task-hub).
349321

350-
## func durable get-history
322+
## `func durable get-history`
351323

352324
Returns the history of the specified orchestration instance.
353325

@@ -365,7 +337,7 @@ The `get-history` action supports the following options:
365337

366338
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#azure-functions-core-tools-1).
367339

368-
## func durable get-instances
340+
## `func durable get-instances`
369341

370342
Returns the status of all orchestration instances. Supports paging using the `top` parameter.
371343

@@ -387,7 +359,7 @@ The `get-instances` action supports the following options:
387359

388360
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#azure-functions-core-tools-2).
389361

390-
## func durable get-runtime-status
362+
## `func durable get-runtime-status`
391363

392364
Returns the status of the specified orchestration instance.
393365

@@ -407,7 +379,7 @@ The `get-runtime-status` action supports the following options:
407379

408380
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#azure-functions-core-tools-1).
409381

410-
## func durable purge-history
382+
## `func durable purge-history`
411383

412384
Purge orchestration instance state, history, and blob storage for orchestrations older than the specified threshold.
413385

@@ -427,7 +399,7 @@ The `purge-history` action supports the following options:
427399

428400
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#azure-functions-core-tools-7).
429401

430-
## func durable raise-event
402+
## `func durable raise-event`
431403

432404
Raises an event to the specified orchestration instance.
433405

@@ -447,7 +419,7 @@ The `raise-event` action supports the following options:
447419

448420
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#azure-functions-core-tools-5).
449421

450-
## func durable rewind
422+
## `func durable rewind`
451423

452424
Rewinds the specified orchestration instance.
453425

@@ -466,7 +438,7 @@ The `rewind` action supports the following options:
466438

467439
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#azure-functions-core-tools-6).
468440

469-
## func durable start-new
441+
## `func durable start-new`
470442

471443
Starts a new instance of the specified orchestrator function.
472444

@@ -486,7 +458,7 @@ The `start-new` action supports the following options:
486458

487459
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#azure-functions-core-tools).
488460

489-
## func durable terminate
461+
## `func durable terminate`
490462

491463
Stops the specified orchestration instance.
492464

@@ -505,7 +477,7 @@ The `terminate` action supports the following options:
505477

506478
To learn more, see the [Durable Functions documentation](./durable/durable-functions-instance-management.md#azure-functions-core-tools-4).
507479

508-
## func extensions install
480+
## `func extensions install`
509481

510482
Manually installs Functions extensions in a non-.NET project or in a C# script project.
511483

@@ -547,7 +519,7 @@ The following considerations apply when using `func extensions install`:
547519

548520
+ The first time you explicitly install an extension, a .NET project file named extensions.csproj is added to the root of your app project. This file defines the set of NuGet packages required by your functions. While you can work with the [NuGet package references](/nuget/consume-packages/package-references-in-project-files) in this file, Core Tools lets you install extensions without having to manually edit this C# project file.
549521

550-
## func extensions sync
522+
## `func extensions sync`
551523

552524
Installs all extensions added to the function app.
553525

@@ -561,7 +533,7 @@ The `sync` action supports the following options:
561533

562534
Regenerates a missing extensions.csproj file. No action is taken when an extension bundle is defined in your host.json file.
563535

564-
## func kubernetes deploy
536+
## `func kubernetes deploy`
565537

566538
Deploys a Functions project as a custom docker container to a Kubernetes cluster.
567539

@@ -600,7 +572,7 @@ Core Tools uses the local Docker CLI to build and publish the image. Make sure y
600572

601573
To learn more, see [Deploying a function app to Kubernetes](functions-kubernetes-keda.md#deploying-a-function-app-to-kubernetes).
602574

603-
## func kubernetes install
575+
## `func kubernetes install`
604576

605577
Installs KEDA in a Kubernetes cluster.
606578

@@ -620,7 +592,7 @@ The `install` action supports the following options:
620592

621593
To learn more, see [Managing KEDA and functions in Kubernetes](functions-kubernetes-keda.md#managing-keda-and-functions-in-kubernetes).
622594

623-
## func kubernetes remove
595+
## `func kubernetes remove`
624596

625597
Removes KEDA from the Kubernetes cluster defined in the kubectl config file.
626598

@@ -638,7 +610,7 @@ The `remove` action supports the following options:
638610

639611
To learn more, see [Uninstalling KEDA from Kubernetes](functions-kubernetes-keda.md#uninstalling-keda-from-kubernetes).
640612

641-
## func settings add
613+
## `func settings add`
642614

643615
Adds a new setting to the `Values` collection in the [local.settings.json file].
644616

@@ -654,7 +626,7 @@ The `add` action supports the following option:
654626
| ------------ | -------------------------------------- |
655627
| **`--connectionString`** | Adds the name-value pair to the `ConnectionStrings` collection instead of the `Values` collection. Only use the `ConnectionStrings` collection when required by certain frameworks. To learn more, see [local.settings.json file]. |
656628

657-
## func settings decrypt
629+
## `func settings decrypt`
658630

659631
Decrypts previously encrypted values in the `Values` collection in the [local.settings.json file].
660632

@@ -664,7 +636,7 @@ func settings decrypt
664636

665637
Connection string values in the `ConnectionStrings` collection are also decrypted. In local.settings.json, `IsEncrypted` is also set to `false`. Encrypt local settings to reduce the risk of leaking valuable information from local.settings.json. In Azure, application settings are always stored encrypted.
666638

667-
## func settings delete
639+
## `func settings delete`
668640

669641
Removes an existing setting from the `Values` collection in the [local.settings.json file].
670642

@@ -680,7 +652,7 @@ The `delete` action supports the following option:
680652
| ------------ | -------------------------------------- |
681653
| **`--connectionString`** | Removes the name-value pair from the `ConnectionStrings` collection instead of from the `Values` collection. |
682654

683-
## func settings encrypt
655+
## `func settings encrypt`
684656

685657
Encrypts the values of individual items in the `Values` collection in the [local.settings.json file].
686658

@@ -690,7 +662,7 @@ func settings encrypt
690662

691663
Connection string values in the `ConnectionStrings` collection are also encrypted. In local.settings.json, `IsEncrypted` is also set to `true`, which specifies that the local runtime decrypts settings before using them. Encrypt local settings to reduce the risk of leaking valuable information from local.settings.json. In Azure, application settings are always stored encrypted.
692664

693-
## func settings list
665+
## `func settings list`
694666

695667
Outputs a list of settings in the `Values` collection in the [local.settings.json file].
696668

@@ -706,7 +678,7 @@ The `list` action supports the following option:
706678
| ------------ | -------------------------------------- |
707679
| **`--showValue`** | Shows the actual unmasked values in the output. |
708680

709-
## func templates list
681+
## `func templates list`
710682

711683
Lists the available function (trigger) templates.
712684

0 commit comments

Comments
 (0)