Keys mangement endpoints are not documented or exposed via Azure SDK for .NET consistently #37862
Labels
App Services
customer-reported
Issues that are reported by GitHub users external to the Azure organization.
Mgmt
This issue is related to a management-plane library.
needs-team-attention
Workflow: This issue needs attention from Azure service team or SDK team
question
The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Milestone
The create/update and delete host/functions or system key endpoints added to resolve Azure/azure-functions-host#3994 are not documented in Azure REST API reference (https://learn.microsoft.com/en-us/rest/api/azure/) or exposed via the Azure SDK for .NET (https://learn.microsoft.com/en-us/dotnet/api/overview/azure/?view=azure-dotnet), and I suspect other languages too but haven't verified this.
PUT
api/sites/{name}[/slots/{slot}]/host/default/{functionkeys|systemkeys}/{keyName}
DELETE
api/sites/{name}[/slots/{slot}]/host/default/{functionkeys|systemkeys}/{keyName}
The current version of the SDK
Azure.ResourceManager.AppService
does not expose theHttpClient
it uses and so it's not possible (without creating anotherHttpClient
instance) to make requests to these endpoints.There is inconsistency across other key management endpoints too:
The list host keys endpoint is documented and exposed via the Azure SDK for .NET
POST
/host/default/listkeys
https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/list-host-keys
https://learn.microsoft.com/en-us/dotnet/api/azure.resourcemanager.appservice.websiteresource.gethostkeysasync?view=azure-dotnet
The list function key endpoint is documented and exposed via the Azure SDK for .NET
POST
/functions/{functionName}/listkeys
https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/list-function-keys
https://learn.microsoft.com/en-us/dotnet/api/azure.resourcemanager.appservice.sitefunctionresource.getfunctionkeysasync?view=azure-dotnet#azure-resourcemanager-appservice-sitefunctionresource-getfunctionkeysasync(system-threading-cancellationtoken)
The create/update and delete function key endpoint is not document but is exposed via the Azure SDK for .NET
PUT
/functions/{functionName}/keys/{keyName}
https://learn.microsoft.com/en-us/dotnet/api/azure.resourcemanager.appservice.sitefunctionresource.createorupdatefunctionsecretasync?view=azure-dotnet#azure-resourcemanager-appservice-sitefunctionresource-createorupdatefunctionsecretasync(system-string-azure-resourcemanager-appservice-models-webappkeyinfo-system-threading-cancellationtoken)
https://learn.microsoft.com/en-us/dotnet/api/azure.resourcemanager.appservice.sitefunctionresource.deletefunctionsecretasync?view=azure-dotnet
The text was updated successfully, but these errors were encountered: