Web Apps - Get Function

Reference

Service:: App Service

API Version:: 2024-04-01

Description for Get function information by its ID for web site, or a deployment slot.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
functionName	path	True	string	Function name.
name	path	True	string	Site name.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	FunctionEnvelope	Function information returned.
404 Not Found		Function with a name of {functionName} does not exist.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
FunctionEnvelope	Function information.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

FunctionEnvelope

Function information.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.config	object	Config information.
properties.config_href	string	Config URI.
properties.files	object	File list.
properties.function_app_id	string	Function App ID.
properties.href	string	Function URI.
properties.invoke_url_template	string	The invocation URL
properties.isDisabled	boolean	Gets or sets a value indicating whether the function is disabled
properties.language	string	The function language
properties.script_href	string	Script URI.
properties.script_root_path_href	string	Script root path URI.
properties.secrets_file_href	string	Secrets file URI.
properties.test_data	string	Test data used when testing via the Azure Portal.
properties.test_data_href	string	Test data URI.
type	string	Resource type.

Dela via