Web Apps - Update Scm Allowed Slot

Dienst:

App Service

API-Version:

2023-12-01

Beschreibung für Updates, ob Anmeldeinformationen zum Veröffentlichen von Benutzern auf der Website zulässig sind oder nicht.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm?api-version=2023-12-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der App
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. RegEx-Muster: ^[-\w\._\(\)]+[^\.]$
slot	path	True	string
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 00000000-0000-0000-0000-00000000000000).
api-version	query	True	string	API-Version

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.allow	True	boolean	true um den Zugriff auf eine Veröffentlichungsmethode zuzulassen; falseandernfalls .
kind		string	Art der Ressource.

Antworten

Name	Typ	Beschreibung
200 OK	CsmPublishingCredentialsPoliciesEntity	OK
Other Status Codes	DefaultErrorResponse	App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Update SCM Allowed

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/basicPublishingCredentialsPolicies/scm?api-version=2023-12-01

{
  "properties": {
    "allow": true
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.CsmPublishingCredentialsPoliciesEntityInner;

/**
 * Samples for WebApps UpdateFtpAllowedSlot.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdatePublishingCredentialsPolicySlot
     * .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().updateFtpAllowedSlotWithResponse("rg", "testSite",
            "stage", 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

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python update_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.update_ftp_allowed_slot(
        resource_group_name="rg",
        name="testSite",
        slot="stage",
        csm_publishing_access_policies_entity={"properties": {"allow": True}},
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdatePublishingCredentialsPolicySlot.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

Go

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdatePublishingCredentialsPolicySlot.json
func ExampleWebAppsClient_UpdateFtpAllowedSlot() {
	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().UpdateFtpAllowedSlot(ctx, "rg", "testSite", "stage", 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/slots/stage/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

JavaScript

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

/**
 * This sample demonstrates how to Description for Updates whether user publishing credentials are allowed on the site or not.
 *
 * @summary Description for Updates whether user publishing credentials are allowed on the site or not.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdatePublishingCredentialsPolicySlot.json
 */
async function updateScmAllowed() {
  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 csmPublishingAccessPoliciesEntity = { allow: true };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.updateScmAllowedSlot(
    resourceGroupName,
    name,
    slot,
    csmPublishingAccessPoliciesEntity,
  );
  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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/sites/testSite/slots/stage/basicPublishingCredentialsPolicies/ftp",
  "properties": {
    "allow": true
  }
}

Definitionen

Name	Beschreibung
CsmPublishingCredentialsPoliciesEntity	Veröffentlichungsrichtlinienparameter für Anmeldeinformationen.
DefaultErrorResponse	App Service Fehlerantwort.
Details
Error	Fehlermodell.

CsmPublishingCredentialsPoliciesEntity

Veröffentlichungsrichtlinienparameter für Anmeldeinformationen.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.allow	boolean	true um den Zugriff auf eine Veröffentlichungsmethode zuzulassen; falseandernfalls .
type	string	Der Ressourcentyp.

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen eines Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.