Is there any way to get the FTP deployment hostname programatically?

Question

I'm in the process of getting a deployment that targets Azure App Service automated and I'm using FTP deployment.

Unfortunately, the hostnames for FTP deployment seem different from app to app and I'd like my scripts to be able to infer the correct one themselves.

Is there anything in the azure CLI that can get me the FTP hostname value? I'm using 2.0 (the shiny new one) if that helps at all.

Answer 1

Base on my knowledge, there is no Azure CLI to get FTP hostname value. But we could get the hostname by using Azure Rest API ListPublishingProfileXmlWithSecrets to get the Azure WebApp FTP hostname from the PublishingProfile.

If PowerShell is possible for your case, we also can use PowerShell command Get-AzureRmWebAppPublishingProfile to get the Azure Website PublishProfile.

If FTP is not the single choice to deploy the Azue WebApp, We also can use Kudu API to deploy the Azure Website. We can get the deployment credentials easily with CLI command azure webapp publishingprofile show resourcegroup WebAppname.

Update:

For Azure CLI 2.0 az command, we could use az appservice web deployment list-site-credentials to get the website deployment credentials. More command please refer to document.

az appservice web deployment list-site-credentials --resource-group resourcegroup --name WebAppname

Answer 2

I wouldn't recommend doing this in production, but it works. It's very hacky, so beware of its fragility:

$ az appservice web show -n ${WEB_APP} -g ${RES_GRP} -o json --query "hostNames" |
    grep -v '.scm.' |
    grep azurewebsites.net | # Drop custom domains here
    xargs host | # Resolve the scale unit name
    grep cloudapp.net |
    tail -1 |
    cut -d'.' -f 1

Output:

waws-prod-am2-103

That represents the scale unit the App Service Plan lives in. Since there seems to be a 1:1 relationship between the scale unit and FTP endpoint, you may construct the FTP FQDN like this:

waws-prod-am2-103.ftp.azurewebsites.windows.net

That being said, again, i would advise AGAINST doing that and using Kudu's Zip Upload APIs instead (if you really don't want to / can't deploy from source control). Tom Sun - MSFT already recommended this approach, and i'm with him on that one.

Answer 3

For those using the Azure JavaScript SDK, you can use this snippet to get the Site Credentials (aka Publish Profile Credentials). I'm assuming you have an instance of WebSiteManagementClient and an implementation of streamToBuffer which converts a nodejs ReadableStream into a Buffer.

let credentialCreate = await webSiteManagementClient.webApps.listPublishingProfileXmlWithSecrets(
  resourceGroupName, // The resource group the Function App is in
  siteName,          // i.e. the Function App name
  {
    format: 'FileZilla3'
  }
)

let contentBuffer = await streamToBuffer(credentialCreate.readableStreamBody);
let credentialsAsXML = contentBuffer.toString();

And for a quick and dirty way to parse Host, User, and Pass...

let hostResults = credentialsAsXML.match(/<Host>(.+)<\/Host>/)
let userResults = credentialsAsXML.match(/<User>(.+)<\/User>/)
let passResults = credentialsAsXML.match(/<Pass(?: encoding="base64")?>(.+)<\/Pass>/)
let host = hostResults ? hostResults[1] : null;
let user = userResults ? userResults[1] : null;
let pass = passResults ? passResults[1] : null;
console.log(host, user, pass)

And finally, if you intend to get the "Profile Publishing Credentials" you'll need to further parse the User and Pass values.

// The "User" value in the XML is structured as: my-new-function3\$my-new-function3.
// The actual user that needs to be used in the Zip Endpoint is the last segment starting
// with the dollar sign
let ppcUser = user.replace(siteName + '\\', '');

// The "Pass" value in the XML is base64 encoded. We need to decode this before
// we use it on the Zip endpoint.
let ppcDecodedPass = Buffer.from(pass, 'base64').toString();