Condividi tramite


Static Sites - List

Descrizione per Ottenere tutti i siti statici per una sottoscrizione.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites?api-version=2024-04-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
subscriptionId
path True

string

ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-000000000000000).

api-version
query True

string

Versione API

Risposte

Nome Tipo Descrizione
200 OK

StaticSiteCollection

Va bene

Other Status Codes

DefaultErrorResponse

Risposta di errore del servizio app.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Get all static sites in a subscription

Esempio di richiesta

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

Risposta di esempio

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0",
      "name": "testStaticSite0",
      "type": "Microsoft.Web/staticSites",
      "location": "West US 2",
      "properties": {
        "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net",
        "repositoryUrl": "https://github.com/username/repo",
        "branch": "demo",
        "customDomains": [],
        "privateEndpointConnections": [],
        "contentDistributionEndpoint": "",
        "keyVaultReferenceIdentity": "SystemAssigned",
        "userProvidedFunctionApps": [],
        "stagingEnvironmentPolicy": "Enabled",
        "allowConfigFileUpdates": true
      },
      "sku": {
        "name": "Standard",
        "tier": "Standard"
      }
    }
  ],
  "nextLink": null
}

Definizioni

Nome Descrizione
ArmIdWrapper

Wrapper per un ID risorsa arm

ArmPlan

L'oggetto piano in Azure Resource Manager rappresenta un piano del marketplace.

Capability

Descrive le funzionalità o le funzionalità consentite per uno SKU specifico.

DatabaseConnectionOverview

Panoramica della connessione al database del sito statico.

DefaultErrorResponse

Risposta di errore del servizio app.

Details
EnterpriseGradeCdnStatus

Stato che indica lo stato della rete CDN di livello aziendale che gestisce il traffico verso l'app Web statica.

Error

Modello di errore.

ErrorEntity

Corpo della risposta di errore restituita dall'API.

ManagedServiceIdentity

Identità del servizio gestito.

ManagedServiceIdentityType

Tipo di identità del servizio gestito.

PrivateLinkConnectionState

Stato di una connessione di collegamento privato

RemotePrivateEndpointConnection

Una connessione endpoint privato remoto

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Busta messaggio che contiene le proprietà comuni di Azure Resource Manager e il contenuto specifico del provider di risorse.

SkuCapacity

Descrizione delle opzioni di scalabilità del piano di servizio app.

SkuDescription

Descrizione di uno SKU per una risorsa scalabile.

StagingEnvironmentPolicy

Stato che indica se gli ambienti di staging sono consentiti o meno per un'app Web statica.

StaticSiteARMResource

Risorsa ARM sito statico.

StaticSiteBuildProperties

Compilare le proprietà per il sito statico.

StaticSiteCollection

Raccolta di siti statici.

StaticSiteDatabaseConnectionConfigurationFileOverview

Un file di configurazione della connessione al database

StaticSiteLinkedBackend

Risorsa ARM back-end collegato sito statico.

StaticSiteTemplateOptions

Opzioni modello per il sito statico.

StaticSiteUserProvidedFunctionApp

Funzione fornita dall'utente del sito statico.

userAssignedIdentity

Identità assegnata dall'utente.

ArmIdWrapper

Wrapper per un ID risorsa arm

Nome Tipo Descrizione
id

string

ArmPlan

L'oggetto piano in Azure Resource Manager rappresenta un piano del marketplace.

Nome Tipo Descrizione
name

string

Nome.

product

string

Il prodotto.

promotionCode

string

Codice promozionale.

publisher

string

Autore.

version

string

Versione del prodotto.

Capability

Descrive le funzionalità o le funzionalità consentite per uno SKU specifico.

Nome Tipo Descrizione
name

string

Nome della funzionalità SKU.

reason

string

Motivo della funzionalità SKU.

value

string

Valore della funzionalità SKU.

DatabaseConnectionOverview

Panoramica della connessione al database del sito statico.

Nome Tipo Descrizione
configurationFiles

StaticSiteDatabaseConnectionConfigurationFileOverview[]

Elenco dei file di configurazione associati a questa connessione al database.

connectionIdentity

string

Se presente, l'identità viene usata insieme alla stringa di connessione per connettersi al database. L'uso dell'identità gestita assegnata dal sistema è indicato con la stringa "SystemAssigned", mentre l'uso di un'identità gestita assegnata dall'utente è indicato con l'ID risorsa della risorsa identità gestita.

name

string

Se presente, nome della risorsa di connessione del database.

region

string

Area della risorsa di database.

resourceId

string

ID risorsa del database.

DefaultErrorResponse

Risposta di errore del servizio app.

Nome Tipo Descrizione
error

Error

Modello di errore.

Details

Nome Tipo Descrizione
code

string

Stringa standardizzata per identificare l'errore a livello di codice.

message

string

Descrizione dettagliata dell'errore e informazioni di debug.

target

string

Descrizione dettagliata dell'errore e informazioni di debug.

EnterpriseGradeCdnStatus

Stato che indica lo stato della rete CDN di livello aziendale che gestisce il traffico verso l'app Web statica.

Valore Descrizione
Disabled
Disabling
Enabled
Enabling

Error

Modello di errore.

Nome Tipo Descrizione
code

string

Stringa standardizzata per identificare l'errore a livello di codice.

details

Details[]

Errori dettagliati.

innererror

string

Altre informazioni per eseguire il debug dell'errore.

message

string

Descrizione dettagliata dell'errore e informazioni di debug.

target

string

Descrizione dettagliata dell'errore e informazioni di debug.

ErrorEntity

Corpo della risposta di errore restituita dall'API.

Nome Tipo Descrizione
code

string

Codice di errore di base.

details

ErrorEntity[]

Dettagli errore.

extendedCode

string

Tipo di errore.

innerErrors

ErrorEntity[]

Errori interni.

message

string

Qualsiasi dettaglio dell'errore.

messageTemplate

string

Modello di messaggio.

parameters

string[]

Parametri per il modello.

target

string

Destinazione dell'errore.

ManagedServiceIdentity

Identità del servizio gestito.

Nome Tipo Descrizione
principalId

string

ID entità dell'identità del servizio gestito.

tenantId

string

Tenant dell'identità del servizio gestito.

type

ManagedServiceIdentityType

Tipo di identità del servizio gestito.

userAssignedIdentities

<string,  userAssignedIdentity>

Elenco di identità assegnate dall'utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Tipo di identità del servizio gestito.

Valore Descrizione
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateLinkConnectionState

Stato di una connessione di collegamento privato

Nome Tipo Descrizione
actionsRequired

string

ActionsRequired per una connessione di collegamento privato

description

string

Descrizione di una connessione di collegamento privato

status

string

Stato di una connessione di collegamento privato

RemotePrivateEndpointConnection

Una connessione endpoint privato remoto

Nome Tipo Descrizione
id

string

ID risorsa.

kind

string

Tipo di risorsa.

name

string

Nome risorsa.

properties.ipAddresses

string[]

IPAddresses privato mappato all'endpoint privato remoto

properties.privateEndpoint

ArmIdWrapper

PrivateEndpoint di una connessione endpoint privato remoto

properties.privateLinkServiceConnectionState

PrivateLinkConnectionState

Stato di una connessione di collegamento privato

properties.provisioningState

string

type

string

Tipo di risorsa.

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Busta messaggio che contiene le proprietà comuni di Azure Resource Manager e il contenuto specifico del provider di risorse.

Nome Tipo Descrizione
error

ErrorEntity

Azure-AsyncOperation informazioni sull'errore.

id

string

ID risorsa. In genere l'ID viene popolato solo per le risposte alle richieste GET. Il chiamante è responsabile del passaggio di questo valore solo per le richieste GET. Ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}

identity

ManagedServiceIdentity

Risorsa MSI

location

string

La risorsa dell'area geografica appartiene ad esempio SouthCentralUS, SouthEastAsia.

name

string

Nome della risorsa.

plan

ArmPlan

Piano di Azure Resource Manager.

properties

RemotePrivateEndpointConnection

Proprietà specifiche della risorsa.

sku

SkuDescription

Descrizione SKU della risorsa.

status

string

Azure-AsyncOperation informazioni sullo stato.

tags

object

Tag associati alla risorsa.

type

string

Tipo di risorsa, ad esempio "Microsoft.Web/sites".

zones

string[]

Zone di disponibilità logiche in cui è ospitato il servizio

SkuCapacity

Descrizione delle opzioni di scalabilità del piano di servizio app.

Nome Tipo Descrizione
default

integer (int32)

Numero predefinito di ruoli di lavoro per questo SKU del piano di servizio app.

elasticMaximum

integer (int32)

Numero massimo di ruoli di lavoro elastici per questo SKU del piano di servizio app.

maximum

integer (int32)

Numero massimo di ruoli di lavoro per questo SKU del piano di servizio app.

minimum

integer (int32)

Numero minimo di ruoli di lavoro per questo SKU del piano di servizio app.

scaleType

string

Configurazioni di scalabilità disponibili per un piano di servizio app.

SkuDescription

Descrizione di uno SKU per una risorsa scalabile.

Nome Tipo Descrizione
capabilities

Capability[]

Le funzionalità dello SKU, ad esempio, sono abilitate per Gestione traffico?

capacity

integer (int32)

Numero corrente di istanze assegnate alla risorsa.

family

string

Codice della famiglia dello SKU della risorsa.

locations

string[]

Posizioni dello SKU.

name

string

Nome dello SKU della risorsa.

size

string

Identificatore di dimensioni dello SKU della risorsa.

skuCapacity

SkuCapacity

Valori di scala minimo, massimo e predefinito dello SKU.

tier

string

Livello di servizio dello SKU della risorsa.

StagingEnvironmentPolicy

Stato che indica se gli ambienti di staging sono consentiti o meno per un'app Web statica.

Valore Descrizione
Disabled
Enabled

StaticSiteARMResource

Risorsa ARM sito statico.

Nome Tipo Descrizione
id

string

ID risorsa.

identity

ManagedServiceIdentity

Identità del servizio gestito.

kind

string

Tipo di risorsa. Se la risorsa è un'app, è possibile fare riferimento a https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference per informazioni dettagliate sui valori supportati per il tipo.

location

string

Percorso risorsa.

name

string

Nome risorsa.

properties.allowConfigFileUpdates

boolean

false se il file di configurazione è bloccato per questa app Web statica; in caso contrario, true.

properties.branch

string

Ramo di destinazione nel repository.

properties.buildProperties

StaticSiteBuildProperties

Compilare le proprietà da configurare nel repository.

properties.contentDistributionEndpoint

string

Endpoint di distribuzione del contenuto per il sito statico.

properties.customDomains

string[]

Domini personalizzati associati a questo sito statico.

properties.databaseConnections

DatabaseConnectionOverview[]

Connessioni di database per il sito statico

properties.defaultHostname

string

Nome host generato automaticamente predefinito per il sito statico.

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

Stato che indica lo stato della rete CDN di livello aziendale che gestisce il traffico verso l'app Web statica.

properties.keyVaultReferenceIdentity

string

Identità da usare per l'autenticazione di riferimento di Key Vault.

properties.linkedBackends

StaticSiteLinkedBackend[]

Back-end collegati al lato statico

properties.privateEndpointConnections

ResponseMessageEnvelope[RemotePrivateEndpointConnection][]

Connessioni endpoint privato

properties.provider

string

Provider che ha inviato l'ultima distribuzione all'ambiente primario del sito statico.

properties.publicNetworkAccess

string

Stato che indica se il traffico pubblico è consentito o meno per un'app Web statica. Valori consentiti: 'Enabled', 'Disabled' o una stringa vuota.

properties.repositoryToken

string

Token del repository GitHub di un utente. Viene usato per configurare il file del flusso di lavoro di Github Actions e i segreti dell'API.

properties.repositoryUrl

string

URL per il repository del sito statico.

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

Stato che indica se gli ambienti di staging sono consentiti o meno per un'app Web statica.

properties.templateProperties

StaticSiteTemplateOptions

Opzioni di modello per la generazione di un nuovo repository.

properties.userProvidedFunctionApps

StaticSiteUserProvidedFunctionApp[]

App per le funzioni fornite dall'utente registrate con il sito statico

sku

SkuDescription

Descrizione di uno SKU per una risorsa scalabile.

tags

object

Tag di risorsa.

type

string

Tipo di risorsa.

StaticSiteBuildProperties

Compilare le proprietà per il sito statico.

Nome Tipo Descrizione
apiBuildCommand

string

Comando personalizzato da eseguire durante la distribuzione dell'applicazione API funzioni di Azure.

apiLocation

string

Percorso del codice api all'interno del repository.

appArtifactLocation

string

Deprecato: percorso degli artefatti dell'app dopo la compilazione (deprecato a favore di OutputLocation)

appBuildCommand

string

Comando personalizzato da eseguire durante la distribuzione dell'applicazione contenuto statico.

appLocation

string

Percorso del codice dell'app all'interno del repository.

githubActionSecretNameOverride

string

Override del nome segreto di Github Action.

outputLocation

string

Percorso di output dell'app dopo la compilazione.

skipGithubActionWorkflowGeneration

boolean

Ignorare la generazione del flusso di lavoro di Github Action.

StaticSiteCollection

Raccolta di siti statici.

Nome Tipo Descrizione
nextLink

string

Collegarsi alla pagina successiva delle risorse.

value

StaticSiteARMResource[]

Raccolta di risorse.

StaticSiteDatabaseConnectionConfigurationFileOverview

Un file di configurazione della connessione al database

Nome Tipo Descrizione
contents

string

Codifica Base64 del contenuto del file.

fileName

string

Nome del file di configurazione.

type

string

Tipo di file di configurazione.

StaticSiteLinkedBackend

Risorsa ARM back-end collegato sito statico.

Nome Tipo Descrizione
backendResourceId

string

ID risorsa del back-end collegato al sito statico

createdOn

string (date-time)

Data e ora in cui il back-end è stato collegato al sito statico.

provisioningState

string

Stato di provisioning del processo di collegamento.

region

string

Area del back-end collegata al sito statico

StaticSiteTemplateOptions

Opzioni modello per il sito statico.

Nome Tipo Descrizione
description

string

Descrizione del repository appena generato.

isPrivate

boolean

Indica se il repository appena generato è un repository privato. Il valore predefinito è false (ad esempio pubblico).

owner

string

Proprietario del repository appena generato.

repositoryName

string

Nome del repository appena generato.

templateRepositoryUrl

string

URL del repository di modelli. Il repository appena generato sarà basato su questo.

StaticSiteUserProvidedFunctionApp

Funzione fornita dall'utente del sito statico.

Nome Tipo Descrizione
id

string

ID risorsa.

kind

string

Tipo di risorsa.

name

string

Nome risorsa.

properties.createdOn

string (date-time)

Data e ora in cui l'app per le funzioni è stata registrata con il sito statico.

properties.functionAppRegion

string

Area dell'app per le funzioni registrata con il sito statico

properties.functionAppResourceId

string

ID risorsa dell'app per le funzioni registrata con il sito statico

type

string

Tipo di risorsa.

userAssignedIdentity

Identità assegnata dall'utente.

Nome Tipo Descrizione
clientId

string

ID client dell'identità assegnata dall'utente

principalId

string

ID entità dell'identità assegnata dall'utente