Description for Returns whether Scm basic auth is allowed on the site or not.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm?api-version=2023-01-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
name
|
path |
True
|
string
|
Name of the app.
|
|
resourceGroupName
|
path |
True
|
string
|
Name of the resource group to which the resource belongs.
Regex pattern: ^[-\w\._\(\)]+[^\.]$
|
|
slot
|
path |
True
|
string
|
|
|
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
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
|
Examples
Get SCM Allowed
Sample Request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/basicPublishingCredentialsPolicies/scm?api-version=2023-01-01
/**
* Samples for WebApps GetScmAllowedSlot.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetPublishingCredentialsPolicySlot.
* json
*/
/**
* Sample code: Get SCM Allowed.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getSCMAllowed(com.azure.resourcemanager.AzureResourceManager azure) {
azure.webApps().manager().serviceClient().getWebApps().getScmAllowedSlotWithResponse("rg", "testSite", "stage",
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-web
# USAGE
python get_publishing_credentials_policy_slot.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = WebSiteManagementClient(
credential=DefaultAzureCredential(),
subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
)
response = client.web_apps.get_ftp_allowed_slot(
resource_group_name="rg",
name="testSite",
slot="stage",
)
print(response)
# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetPublishingCredentialsPolicySlot.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armappservice_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetPublishingCredentialsPolicySlot.json
func ExampleWebAppsClient_GetFtpAllowedSlot() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewWebAppsClient().GetFtpAllowedSlot(ctx, "rg", "testSite", "stage", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.CsmPublishingCredentialsPoliciesEntity = armappservice.CsmPublishingCredentialsPoliciesEntity{
// ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/basicPublishingCredentialsPolicies/ftp"),
// Properties: &armappservice.CsmPublishingCredentialsPoliciesEntityProperties{
// Allow: to.Ptr(false),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Description for Returns whether Scm basic auth is allowed on the site or not.
*
* @summary Description for Returns whether Scm basic auth is allowed on the site or not.
* x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-01-01/examples/GetPublishingCredentialsPolicySlot.json
*/
async function getScmAllowed() {
const subscriptionId =
process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
const name = "testSite";
const slot = "stage";
const credential = new DefaultAzureCredential();
const client = new WebSiteManagementClient(credential, subscriptionId);
const result = await client.webApps.getScmAllowedSlot(resourceGroupName, name, slot);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/basicPublishingCredentialsPolicies/ftp",
"properties": {
"allow": false
}
}
Definitions
CsmPublishingCredentialsPoliciesEntity
Publishing Credentials Policies parameters.
| Name |
Type |
Description |
|
id
|
string
|
Resource Id.
|
|
kind
|
string
|
Kind of resource.
|
|
name
|
string
|
Resource Name.
|
|
properties.allow
|
boolean
|
true to allow access to a publishing method; otherwise, false.
|
|
type
|
string
|
Resource type.
|
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.
|