Static Sites - Reset Static Site Api Key

Usługa:

App Service

Wersja interfejsu API:

2024-11-01

Opis resetowania klucza interfejsu API dla istniejącej witryny statycznej.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/resetapikey?api-version=2024-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa witryny statycznej.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nazwa grupy zasobów, do której należy zasób.
subscriptionId	path	True	string	Twój identyfikator subskrypcji Azure. Jest to ciąg w formacie GUID (np. 0000000000-0000-0000-0000-0000000000000).
api-version	query	True	string	Wersja interfejsu API

Treść żądania

Nazwa	Typ	Opis
kind	string	Rodzaj zasobu.
properties.repositoryToken	string	Token, który potwierdza uprawnienia administratora do repozytorium.
properties.shouldUpdateRepository	boolean	Określa, czy repozytorium powinno zostać zaktualizowane przy użyciu nowych właściwości.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		OK.
Other Status Codes	DefaultErrorResponse	Odpowiedź na błąd usługi App Service.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Reset the api key for a static site

Przykładowe żądanie

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/resetapikey?api-version=2024-11-01

{
  "properties": {
    "shouldUpdateRepository": true,
    "repositoryToken": "repoToken123"
  }
}

Java

import com.azure.resourcemanager.appservice.models.StaticSiteResetPropertiesArmResource;

/**
 * Samples for StaticSites ResetStaticSiteApiKey.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ResetStaticSiteApiKey.json
     */
    /**
     * Sample code: Reset the api key for a static site.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void resetTheApiKeyForAStaticSite(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getStaticSites().resetStaticSiteApiKeyWithResponse(
            "rg", "testStaticSite0", new StaticSiteResetPropertiesArmResource()
                .withRepositoryToken("fakeTokenPlaceholder").withShouldUpdateRepository(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 azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python reset_static_site_api_key.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",
    )

    client.static_sites.reset_static_site_api_key(
        resource_group_name="rg",
        name="testStaticSite0",
        reset_properties_envelope={"properties": {"repositoryToken": "repoToken123", "shouldUpdateRepository": True}},
    )


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ResetStaticSiteApiKey.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ResetStaticSiteApiKey.json
func ExampleStaticSitesClient_ResetStaticSiteAPIKey() {
	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)
	}
	_, err = clientFactory.NewStaticSitesClient().ResetStaticSiteAPIKey(ctx, "rg", "testStaticSite0", armappservice.StaticSiteResetPropertiesARMResource{
		Properties: &armappservice.StaticSiteResetPropertiesARMResourceProperties{
			RepositoryToken:        to.Ptr("repoToken123"),
			ShouldUpdateRepository: to.Ptr(true),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Resets the api key for an existing static site.
 *
 * @summary Description for Resets the api key for an existing static site.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ResetStaticSiteApiKey.json
 */
async function resetTheApiKeyForAStaticSite() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testStaticSite0";
  const resetPropertiesEnvelope = {
    repositoryToken: "repoToken123",
    shouldUpdateRepository: true,
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.staticSites.resetStaticSiteApiKey(
    resourceGroupName,
    name,
    resetPropertiesEnvelope,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ResetStaticSiteApiKey.json
// this example is just showing the usage of "StaticSites_ResetStaticSiteApiKey" 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 StaticSiteResource created on azure
// for more information of creating StaticSiteResource, please refer to the document of StaticSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
string name = "testStaticSite0";
ResourceIdentifier staticSiteResourceId = StaticSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
StaticSiteResource staticSite = client.GetStaticSiteResource(staticSiteResourceId);

// invoke the operation
StaticSiteResetContent content = new StaticSiteResetContent
{
    RepositoryToken = "repoToken123",
    ShouldUpdateRepository = true,
};
await staticSite.ResetApiKeyAsync(content);

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:

200

Definicje

Nazwa	Opis
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Error	Model błędu.
StaticSiteResetPropertiesARMResource	Zasób usługi ARM właściwości resetowania witryny statycznej.

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Objekt

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

StaticSiteResetPropertiesARMResource

Objekt

Zasób usługi ARM właściwości resetowania witryny statycznej.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.repositoryToken	string	Token, który potwierdza uprawnienia administratora do repozytorium.
properties.shouldUpdateRepository	boolean	Określa, czy repozytorium powinno zostać zaktualizowane przy użyciu nowych właściwości.
type	string	Typ zasobu.