1. Packages
  2. Azure Classic
  3. API Docs
  4. appservice
  5. getFunctionAppHostKeys

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.appservice.getFunctionAppHostKeys

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

Use this data source to fetch the Host Keys of an existing Function App

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.appservice.getFunctionAppHostKeys({
    name: "example-function",
    resourceGroupName: exampleAzurermResourceGroup.name,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.appservice.get_function_app_host_keys(name="example-function",
    resource_group_name=example_azurerm_resource_group["name"])
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appservice.GetFunctionAppHostKeys(ctx, &appservice.GetFunctionAppHostKeysArgs{
			Name:              "example-function",
			ResourceGroupName: exampleAzurermResourceGroup.Name,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.AppService.GetFunctionAppHostKeys.Invoke(new()
    {
        Name = "example-function",
        ResourceGroupName = exampleAzurermResourceGroup.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.appservice.AppserviceFunctions;
import com.pulumi.azure.appservice.inputs.GetFunctionAppHostKeysArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = AppserviceFunctions.getFunctionAppHostKeys(GetFunctionAppHostKeysArgs.builder()
            .name("example-function")
            .resourceGroupName(exampleAzurermResourceGroup.name())
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:appservice:getFunctionAppHostKeys
      arguments:
        name: example-function
        resourceGroupName: ${exampleAzurermResourceGroup.name}
Copy

Using getFunctionAppHostKeys

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFunctionAppHostKeys(args: GetFunctionAppHostKeysArgs, opts?: InvokeOptions): Promise<GetFunctionAppHostKeysResult>
function getFunctionAppHostKeysOutput(args: GetFunctionAppHostKeysOutputArgs, opts?: InvokeOptions): Output<GetFunctionAppHostKeysResult>
Copy
def get_function_app_host_keys(name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetFunctionAppHostKeysResult
def get_function_app_host_keys_output(name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetFunctionAppHostKeysResult]
Copy
func GetFunctionAppHostKeys(ctx *Context, args *GetFunctionAppHostKeysArgs, opts ...InvokeOption) (*GetFunctionAppHostKeysResult, error)
func GetFunctionAppHostKeysOutput(ctx *Context, args *GetFunctionAppHostKeysOutputArgs, opts ...InvokeOption) GetFunctionAppHostKeysResultOutput
Copy

> Note: This function is named GetFunctionAppHostKeys in the Go SDK.

public static class GetFunctionAppHostKeys 
{
    public static Task<GetFunctionAppHostKeysResult> InvokeAsync(GetFunctionAppHostKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetFunctionAppHostKeysResult> Invoke(GetFunctionAppHostKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFunctionAppHostKeysResult> getFunctionAppHostKeys(GetFunctionAppHostKeysArgs args, InvokeOptions options)
public static Output<GetFunctionAppHostKeysResult> getFunctionAppHostKeys(GetFunctionAppHostKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:appservice/getFunctionAppHostKeys:getFunctionAppHostKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the Function App.
ResourceGroupName This property is required. string
The name of the Resource Group where the Function App exists.
Name This property is required. string
The name of the Function App.
ResourceGroupName This property is required. string
The name of the Resource Group where the Function App exists.
name This property is required. String
The name of the Function App.
resourceGroupName This property is required. String
The name of the Resource Group where the Function App exists.
name This property is required. string
The name of the Function App.
resourceGroupName This property is required. string
The name of the Resource Group where the Function App exists.
name This property is required. str
The name of the Function App.
resource_group_name This property is required. str
The name of the Resource Group where the Function App exists.
name This property is required. String
The name of the Function App.
resourceGroupName This property is required. String
The name of the Resource Group where the Function App exists.

getFunctionAppHostKeys Result

The following output properties are available:

BlobsExtensionKey string
Function App resource's Blobs Extension system key.
DefaultFunctionKey string
Function App resource's default function key.
DurabletaskExtensionKey string
Function App resource's Durable Task Extension system key.
EventGridExtensionConfigKey string
Function App resource's Event Grid Extension Config system key.
EventGridExtensionKey string
Id string
The provider-assigned unique ID for this managed resource.
Name string
PrimaryKey string
Function App resource's secret key
ResourceGroupName string
SignalrExtensionKey string
Function App resource's SignalR Extension system key.
WebpubsubExtensionKey string
Function App resource's Web PubSub Extension system key.
BlobsExtensionKey string
Function App resource's Blobs Extension system key.
DefaultFunctionKey string
Function App resource's default function key.
DurabletaskExtensionKey string
Function App resource's Durable Task Extension system key.
EventGridExtensionConfigKey string
Function App resource's Event Grid Extension Config system key.
EventGridExtensionKey string
Id string
The provider-assigned unique ID for this managed resource.
Name string
PrimaryKey string
Function App resource's secret key
ResourceGroupName string
SignalrExtensionKey string
Function App resource's SignalR Extension system key.
WebpubsubExtensionKey string
Function App resource's Web PubSub Extension system key.
blobsExtensionKey String
Function App resource's Blobs Extension system key.
defaultFunctionKey String
Function App resource's default function key.
durabletaskExtensionKey String
Function App resource's Durable Task Extension system key.
eventGridExtensionConfigKey String
Function App resource's Event Grid Extension Config system key.
eventGridExtensionKey String
id String
The provider-assigned unique ID for this managed resource.
name String
primaryKey String
Function App resource's secret key
resourceGroupName String
signalrExtensionKey String
Function App resource's SignalR Extension system key.
webpubsubExtensionKey String
Function App resource's Web PubSub Extension system key.
blobsExtensionKey string
Function App resource's Blobs Extension system key.
defaultFunctionKey string
Function App resource's default function key.
durabletaskExtensionKey string
Function App resource's Durable Task Extension system key.
eventGridExtensionConfigKey string
Function App resource's Event Grid Extension Config system key.
eventGridExtensionKey string
id string
The provider-assigned unique ID for this managed resource.
name string
primaryKey string
Function App resource's secret key
resourceGroupName string
signalrExtensionKey string
Function App resource's SignalR Extension system key.
webpubsubExtensionKey string
Function App resource's Web PubSub Extension system key.
blobs_extension_key str
Function App resource's Blobs Extension system key.
default_function_key str
Function App resource's default function key.
durabletask_extension_key str
Function App resource's Durable Task Extension system key.
event_grid_extension_config_key str
Function App resource's Event Grid Extension Config system key.
event_grid_extension_key str
id str
The provider-assigned unique ID for this managed resource.
name str
primary_key str
Function App resource's secret key
resource_group_name str
signalr_extension_key str
Function App resource's SignalR Extension system key.
webpubsub_extension_key str
Function App resource's Web PubSub Extension system key.
blobsExtensionKey String
Function App resource's Blobs Extension system key.
defaultFunctionKey String
Function App resource's default function key.
durabletaskExtensionKey String
Function App resource's Durable Task Extension system key.
eventGridExtensionConfigKey String
Function App resource's Event Grid Extension Config system key.
eventGridExtensionKey String
id String
The provider-assigned unique ID for this managed resource.
name String
primaryKey String
Function App resource's secret key
resourceGroupName String
signalrExtensionKey String
Function App resource's SignalR Extension system key.
webpubsubExtensionKey String
Function App resource's Web PubSub Extension system key.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi