Static Sites - List Basic Auth

Hizmet:

App Service

API Sürümü:

2024-11-01

Statik sitenin koleksiyon olarak temel kimlik doğrulama özelliklerini alır açıklaması.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
name	path	True	string	Statik sitenin adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Kaynağın ait olduğu kaynak grubunun adı.
subscriptionId	path	True	string	Azure abonelik kimliğiniz. Bu, GUID biçimli bir dizedir (örneğin, 00000000-0000-0000-0000-000000000000000).
api-version	query	True	string	API Sürümü

Yanıtlar

Name	Tür	Description
200 OK	StaticSiteBasicAuthPropertiesCollection	TAMAM.
Other Status Codes	DefaultErrorResponse	App Service hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Lists the basic auth properties for a static site.

Örnek isteği

HTTP

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

Java

/**
 * Samples for StaticSites ListBasicAuth.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListStaticSiteBasicAuth.json
     */
    /**
     * Sample code: Lists the basic auth properties for a static site.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listsTheBasicAuthPropertiesForAStaticSite(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getStaticSites().listBasicAuth("rg", "testStaticSite0",
            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 list_static_site_basic_auth.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.static_sites.list_basic_auth(
        resource_group_name="rg",
        name="testStaticSite0",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListStaticSiteBasicAuth.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/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/ListStaticSiteBasicAuth.json
func ExampleStaticSitesClient_NewListBasicAuthPager() {
	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)
	}
	pager := clientFactory.NewStaticSitesClient().NewListBasicAuthPager("rg", "testStaticSite0", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.StaticSiteBasicAuthPropertiesCollection = armappservice.StaticSiteBasicAuthPropertiesCollection{
		// 	Value: []*armappservice.StaticSiteBasicAuthPropertiesARMResource{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/basicAuth/default"),
		// 			Properties: &armappservice.StaticSiteBasicAuthPropertiesARMResourceProperties{
		// 				ApplicableEnvironmentsMode: to.Ptr("AllEnvironments"),
		// 				SecretState: to.Ptr("Password"),
		// 			},
		// 	}},
		// }
	}
}

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 Gets the basic auth properties for a static site as a collection.
 *
 * @summary Description for Gets the basic auth properties for a static site as a collection.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/ListStaticSiteBasicAuth.json
 */
async function listsTheBasicAuthPropertiesForAStaticSite() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testStaticSite0";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.staticSites.listBasicAuth(resourceGroupName, name)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/ListStaticSiteBasicAuth.json
// this example is just showing the usage of "StaticSites_ListBasicAuth" 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);

// get the collection of this StaticSiteBasicAuthPropertyResource
StaticSiteBasicAuthPropertyCollection collection = staticSite.GetStaticSiteBasicAuthProperties();

// invoke the operation and iterate over the result
await foreach (StaticSiteBasicAuthPropertyResource item in collection.GetAllAsync())
{
    // the variable item 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
    StaticSiteBasicAuthPropertyData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/basicAuth/default",
      "name": "default",
      "properties": {
        "environments": null,
        "secretUrl": null,
        "applicableEnvironmentsMode": "AllEnvironments",
        "secretState": "Password"
      }
    }
  ],
  "nextLink": ""
}

Tanımlar

Name	Description
DefaultErrorResponse	App Service hata yanıtı.
Details
Error	Hata modeli.
StaticSiteBasicAuthPropertiesARMResource	Statik site temel kimlik doğrulama özellikleri ARM kaynağı.
StaticSiteBasicAuthPropertiesCollection	Statik site temel kimlik doğrulaması koleksiyonu.

DefaultErrorResponse

Object

App Service hata yanıtı.

Name	Tür	Description
error	Error	Hata modeli.

Details

Object

Name	Tür	Description
code	string	Hatayı program aracılığıyla tanımlamak için standartlaştırılmış dize.
message	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.
target	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.

Error

Object

Hata modeli.

Name	Tür	Description
code	string	Hatayı program aracılığıyla tanımlamak için standartlaştırılmış dize.
details	Details[]	Ayrıntılı hatalar.
innererror	string	Hata ayıklamak için daha fazla bilgi.
message	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.
target	string	Ayrıntılı hata açıklaması ve hata ayıklama bilgileri.

StaticSiteBasicAuthPropertiesARMResource

Object

Statik site temel kimlik doğrulama özellikleri ARM kaynağı.

Name	Tür	Description
id	string	Kaynak Kimliği.
kind	string	Kaynak türü.
name	string	Kaynak Adı.
properties.applicableEnvironmentsMode	string	Temel kimlik doğrulamasının etkinleştirilip etkinleştirilmediğini ve etkin olduğu ortamları gösteren durum.
properties.environments	string[]	ApplicableEnvironmentsMode değeri SpecifiedEnvironments olarak ayarlanmışsa Temel Kimlik Doğrulaması için etkin ortamların listesi.
properties.password	string	Temel kimlik doğrulaması için parola.
properties.secretState	string	Temel kimlik doğrulamasında gizli dizi olup olmadığını ve ne tür olduğunu belirten durum.
properties.secretUrl	string	Key Vault'taki gizli dizi url'si.
type	string	Kaynak türü.

StaticSiteBasicAuthPropertiesCollection

Object

Statik site temel kimlik doğrulaması koleksiyonu.

Name	Tür	Description
nextLink	string	Sonraki kaynak sayfasına bağlanın.
value	StaticSiteBasicAuthPropertiesARMResource[]	Kaynak koleksiyonu.