- Notifications
You must be signed in to change notification settings - Fork 469
Key management API
The Functions Runtime exposes a management API that enables consumers to programmatically add, delete, and update function keys.
Since this API is exposed by the runtime, the base URL is: https://<functionappname>.azurewebsites.net/
Retrieves the function keys
Request:
GET /admin/functions/{functionname}/keys
Response:
{ "keys": [ { "name": "keyname", "value": "keyvalue", "links": [ { "rel": "self", "href": "https://baseuri/admin/functions/{functionname}/keys/{keyname}" } ] } ], "links": [ { "rel": "self", "href": "http://baseuri/admin/functions/{functionname}/keys" } ] }
Creates or updates the key at the specified resource
Request:
PUT /admin/functions/{functionname}/keys/{keyname} { "name": "keyname", "value" : "keyvalue" }
Response:
HTTP Status: 200
or 201
if created
{ "name" : "keyname", "value" : "keyvalue", "links": [ { "rel": "self", "href": "https://baseuri/admin/functions/{functionname}/keys/{keyname}" } ] }
Creates or updates the key at the specified resource with an auto generated key
Request:
POST /admin/functions/{functionname}/keys/{keyname}
Response:
HTTP Status: 200
or 201
if created
{ "name" : "keyname", "value" : "keyvalue", "links": [ { "rel": "self", "href": "https://baseuri/admin/functions/{functionname}/keys/{keyname}" } ] }
Deletes the key identified by the URI
Request:
DELETE /admin/functions/{functionname}/keys/{keyname}
Response:
HTTP Status: 204
The host keys collection resource exposes the same APIs as the function keys collection resource.
Note: The master key is not returned on a GET request
The host key resource exposes the same APIs as the function keys collection resource.
Note: The master key is exposed under the reserved name _master and DELETE is not supported
- Configuration Settings
- function.json
- host.json
- host.json (v2)
- Http Functions
- Function Runtime Versioning
- Official Functions developers guide
- Host Health Monitor
- Managing Connections
- Renaming a Function
- Retrieving information about the currently running function
- Site Extension Resolution
- Linux Consumption Regions
- Using LinuxFxVersion for Linux Function apps
- Out-of-proc Cancellation Tokens
- Assembly Resolution in Azure Functions
- ILogger
- Precompiled functions
- Official Functions C# developer reference
- Contributor Onboarding
- Development Process
- Deploying the Functions runtime as a private site extension
- Authoring & Testing Language Extensions
- Bindings in out-of-proc
- Language Extensibility
- Worker Capabilities
- Investigating and reporting issues with timer triggered functions not firing
- Sharing Your Function App name privately
- Azure Functions CLI release notes [moved here]
- Function App Zipped Deployment [deprecated]