Description for Updates whether user publishing credentials are allowed on the site or not.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm?api-version=2024-04-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\._\(\)]+[^\.]$
|
|
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
|
Request Body
| Name |
Required |
Type |
Description |
|
properties.allow
|
True
|
boolean
|
true to allow access to a publishing method; otherwise, false.
|
|
kind
|
|
string
|
Kind of resource.
|
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
Update SCM Allowed
Sample request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/basicPublishingCredentialsPolicies/scm?api-version=2024-04-01
{
"properties": {
"allow": true
}
}
import com.azure.resourcemanager.appservice.fluent.models.CsmPublishingCredentialsPoliciesEntityInner;
/**
* Samples for WebApps UpdateFtpAllowed.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicy.
* json
*/
/**
* Sample code: Update FTP Allowed.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void updateFTPAllowed(com.azure.resourcemanager.AzureResourceManager azure) {
azure.webApps().manager().serviceClient().getWebApps().updateFtpAllowedWithResponse("rg", "testSite",
new CsmPublishingCredentialsPoliciesEntityInner().withAllow(true), 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
package armappservice_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicy.json
func ExampleWebAppsClient_UpdateFtpAllowed() {
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().UpdateFtpAllowed(ctx, "rg", "testSite", armappservice.CsmPublishingCredentialsPoliciesEntity{
Properties: &armappservice.CsmPublishingCredentialsPoliciesEntityProperties{
Allow: to.Ptr(true),
},
}, 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/basicPublishingCredentialsPolicies/ftp"),
// Properties: &armappservice.CsmPublishingCredentialsPoliciesEntityProperties{
// Allow: to.Ptr(true),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService;
// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdatePublishingCredentialsPolicy.json
// this example is just showing the usage of "WebApps_UpdateScmAllowed" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this ScmSiteBasicPublishingCredentialsPolicyResource created on azure
// for more information of creating ScmSiteBasicPublishingCredentialsPolicyResource, please refer to the document of ScmSiteBasicPublishingCredentialsPolicyResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testSite";
ResourceIdentifier scmSiteBasicPublishingCredentialsPolicyResourceId = ScmSiteBasicPublishingCredentialsPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
ScmSiteBasicPublishingCredentialsPolicyResource scmSiteBasicPublishingCredentialsPolicy = client.GetScmSiteBasicPublishingCredentialsPolicyResource(scmSiteBasicPublishingCredentialsPolicyResourceId);
// invoke the operation
CsmPublishingCredentialsPoliciesEntityData data = new CsmPublishingCredentialsPoliciesEntityData()
{
Allow = true,
};
ArmOperation<ScmSiteBasicPublishingCredentialsPolicyResource> lro = await scmSiteBasicPublishingCredentialsPolicy.CreateOrUpdateAsync(WaitUntil.Completed, data);
ScmSiteBasicPublishingCredentialsPolicyResource result = lro.Value;
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CsmPublishingCredentialsPoliciesEntityData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
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/basicPublishingCredentialsPolicies/ftp",
"properties": {
"allow": true
}
}
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.
|