Error while listing slot application settings

[lcssanches]

• Package Name: @azure/arm-appservice
• Package Version: 13.0.0
• Operating system: Windows
• nodejs
  • version: 12.20.1
• browser
  • name/version:
• typescript
  • version: 4.8.2
• Is the bug related to documentation in
  • README.md
  • source code documentation
  • SDK API docs on https://docs.microsoft.com

Describe the bug

listApplicationSettingsSlot and updateApplicationSettingsSlot only work when slot is specified even though doc suggests otherwise:

@param slot Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.

• When null is specified the SDK throws Error: slot cannot be null or undefined.
• When empty is specified it throws: RestError: The Resource 'Microsoft.Web/sites/xxxxx-xxxxx/slots/config' under resource group 'xxxxxxxxx-xxxxxxxx' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
• When "production" is specified it throws: The Resource 'Microsoft.Web/sites/xxxxx-xxxxx/slots/production' under resource group 'xxxxxxxxx-xxxxxxxx' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix

To Reproduce
Steps to reproduce the behavior:

// index.js
const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

async function run() {
    const appname = "xxxxx"
    const subscription_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    const resource_group = "xxxxx"
    const creds = new DefaultAzureCredential()
    const clientWebApps = new WebSiteManagementClient(creds, subscription_id);
    const res = await clientWebApps.webApps.listApplicationSettingsSlot(resource_group, appname, null)
    //const res = await clientWebApps.webApps.listApplicationSettings(resource_group, appname) // works, to prove app exists
    console.log({res})
}

run();

Expected behavior
SDK should allow listing and updating specific settings for the production slot.

Screenshots
none

Additional context
none

[qiaozha]

@kazrael2119 Could you help take a look at this issue ? Thanks

[kazrael2119]

Hi @lcssanches ,
That's becausce in swagger:https://github.com/Azure/azure-rest-api-specs/blob/7a6ec0f1e66aac22421f9338c00cbb2d1c97547d/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json#L9813,the slot name is required. So it can't be null or empty.
And when you use listApplicationSettings, slot name is not required in swagger:https://github.com/Azure/azure-rest-api-specs/blob/7a6ec0f1e66aac22421f9338c00cbb2d1c97547d/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json#L1062 , so it works.
So you should create a slot first.
If you don't know how to create a slot, you can refer to this code
const res1=await clientWebApps.webApps.beginCreateOrUpdateSlotAndWait(resourceGroupName, appname, "slottest", { location:location, identity:{type:"SystemAssigned"} });
Or you need more detailed parameters, please refer here https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/create-or-update-slot#site

[kazrael2119]

SDK and it's parameter definition is coming from swagger definition, slot Name is defined in swagger:

[lcssanches]

Hello @kazrael2119 ,

Thank you for you message.

I should have state this before but my goal is to create multiple app settings as "Deployment slot setting" in the "production"/default slot, because I don't want them to be swapped later.

[navba-MSFT]

Adding Service team to look into this.

[ghost]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @antcp, @AzureAppServiceCLI.

Issue Details

---

• Package Name: @azure/arm-appservice
• Package Version: 13.0.0
• Operating system: Windows
• nodejs
  • version: 12.20.1
• browser
  • name/version:
• typescript
  • version: 4.8.2
• Is the bug related to documentation in
  • README.md
  • source code documentation
  • SDK API docs on https://docs.microsoft.com

Describe the bug

listApplicationSettingsSlot and updateApplicationSettingsSlot only work when slot is specified even though doc suggests otherwise:

@param slot Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.

• When null is specified the SDK throws Error: slot cannot be null or undefined.
• When empty is specified it throws: RestError: The Resource 'Microsoft.Web/sites/xxxxx-xxxxx/slots/config' under resource group 'xxxxxxxxx-xxxxxxxx' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
• When "production" is specified it throws: The Resource 'Microsoft.Web/sites/xxxxx-xxxxx/slots/production' under resource group 'xxxxxxxxx-xxxxxxxx' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix

To Reproduce
Steps to reproduce the behavior:

// index.js
const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

async function run() {
    const appname = "xxxxx"
    const subscription_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    const resource_group = "xxxxx"
    const creds = new DefaultAzureCredential()
    const clientWebApps = new WebSiteManagementClient(creds, subscription_id);
    const res = await clientWebApps.webApps.listApplicationSettingsSlot(resource_group, appname, null)
    //const res = await clientWebApps.webApps.listApplicationSettings(resource_group, appname) // works, to prove app exists
    console.log({res})
}

run();

Expected behavior
SDK should allow listing and updating specific settings for the production slot.

Screenshots
none

Additional context
none

Author:	lcssanches
Assignees:	qiaozha
Labels:	question, customer-reported, Mgmt, App Services, Service Attention
Milestone:	-

[navba-MSFT]

@antcp, @AzureAppServiceCLI Could you please look into this issue and provide an update ?