Static Sites - Get Static Sites By Resource Group
Beschreibung für ruft alle statischen Websites in der angegebenen Ressourcengruppe ab.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites?api-version=2024-11-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$ |
Name der Ressourcengruppe, zu der die Ressource gehört. |
subscription
|
path | True |
string |
die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000). |
api-version
|
query | True |
string |
API-Version |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
OKAY. |
|
Other Status Codes |
Fehlerantwort des App-Diensts. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
Get static sites for a resource group
Beispielanforderung
Beispiel für eine Antwort
{
"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": null,
"linkedBackends": [],
"stagingEnvironmentPolicy": "Enabled",
"allowConfigFileUpdates": true
},
"sku": {
"name": "Standard",
"tier": "Standard"
}
}
],
"nextLink": null
}
Definitionen
Name | Beschreibung |
---|---|
Arm |
Ein Wrapper für eine ARM-Ressourcen-ID |
Arm |
Das Planobjekt in Azure Resource Manager stellt einen Marketplace-Plan dar. |
Capability |
Beschreibt die für eine bestimmte SKU zulässigen Funktionen/Features. |
Database |
Übersicht über statische Websitedatenbankverbindung. |
Default |
Fehlerantwort des App-Diensts. |
Details | |
Enterprise |
Status, der den Status des CDN der Unternehmensklasse angibt, der Datenverkehr an die statische Web-App angibt. |
Error |
Fehlermodell. |
Error |
Der Textkörper der von der API zurückgegebenen Fehlerantwort. |
Managed |
Verwaltete Dienstidentität. |
Managed |
Typ der verwalteten Dienstidentität. |
Private |
Der Status einer privaten Verknüpfungsverbindung |
Remote |
Eine private Remoteendpunktverbindung |
Response |
Nachrichtenumschlag, der die allgemeinen Eigenschaften des Azure-Ressourcen-Managers und den spezifischen Inhalt des Ressourcenanbieters enthält. |
Sku |
Beschreibung der Skalierungsoptionen für den App Service-Plan. |
Sku |
Beschreibung einer SKU für eine skalierbare Ressource. |
Staging |
Status, der angibt, ob Stagingumgebungen für eine statische Web-App zulässig oder nicht zulässig sind. |
Static |
Arm-Ressource für statische Website. |
Static |
Erstellen Sie Eigenschaften für die statische Website. |
Static |
Sammlung statischer Websites. |
Static |
Konfigurationsdatei für Datenbankverbindung |
Static |
Static Site Linked Back-End ARM-Ressource. |
Static |
Vorlagenoptionen für die statische Website. |
Static |
Eine von einem statischen Websitebenutzer bereitgestellte Funktion. |
user |
Vom Benutzer zugewiesene Identität. |
ArmIdWrapper
Ein Wrapper für eine ARM-Ressourcen-ID
Name | Typ | Beschreibung |
---|---|---|
id |
string |
ArmPlan
Das Planobjekt in Azure Resource Manager stellt einen Marketplace-Plan dar.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Der Name. |
product |
string |
Das Produkt. |
promotionCode |
string |
Der Heraufsufungscode. |
publisher |
string |
Der Herausgeber. |
version |
string |
Produktversion. |
Capability
Beschreibt die für eine bestimmte SKU zulässigen Funktionen/Features.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Name der SKU-Funktion. |
reason |
string |
Grund der SKU-Funktion. |
value |
string |
Wert der SKU-Funktion. |
DatabaseConnectionOverview
Übersicht über statische Websitedatenbankverbindung.
Name | Typ | Beschreibung |
---|---|---|
configurationFiles |
Eine Liste der Konfigurationsdateien, die dieser Datenbankverbindung zugeordnet sind. |
|
connectionIdentity |
string |
Wenn vorhanden, wird die Identität in Verbindung mit der Verbindungszeichenfolge verwendet, um eine Verbindung mit der Datenbank herzustellen. Die Verwendung der vom System zugewiesenen verwalteten Identität wird mit der Zeichenfolge "SystemAssigned" angegeben, während die Verwendung einer vom Benutzer zugewiesenen verwalteten Identität mit der Ressourcen-ID der verwalteten Identitätsressource angegeben wird. |
name |
string |
Wenn vorhanden, der Name dieser Datenbankverbindungsressource. |
region |
string |
Der Bereich der Datenbankressource. |
resourceId |
string |
Die Ressourcen-ID der Datenbank. |
DefaultErrorResponse
Fehlerantwort des App-Diensts.
Name | Typ | Beschreibung |
---|---|---|
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. |
EnterpriseGradeCdnStatus
Status, der den Status des CDN der Unternehmensklasse angibt, der Datenverkehr an die statische Web-App angibt.
Wert | Beschreibung |
---|---|
Disabled | |
Disabling | |
Enabled | |
Enabling |
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 von Fehlern. |
message |
string |
Detaillierte Fehlerbeschreibung und Debuginformationen. |
target |
string |
Detaillierte Fehlerbeschreibung und Debuginformationen. |
ErrorEntity
Der Textkörper der von der API zurückgegebenen Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Einfacher Fehlercode. |
details |
Fehlerdetails. |
|
extendedCode |
string |
Typ des Fehlers. |
innerErrors |
Innere Fehler. |
|
message |
string |
Alle Details des Fehlers. |
messageTemplate |
string |
Nachrichtenvorlage. |
parameters |
string[] |
Parameter für die Vorlage. |
target |
string |
Das Fehlerziel. |
ManagedServiceIdentity
Verwaltete Dienstidentität.
Name | Typ | Beschreibung |
---|---|---|
principalId |
string |
Prinzipal-ID der verwalteten Dienstidentität. |
tenantId |
string |
Mandant der verwalteten Dienstidentität. |
type |
Typ der verwalteten Dienstidentität. |
|
userAssignedIdentities |
<string,
user |
Die Liste der benutzer zugewiesenen Identitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
ManagedServiceIdentityType
Typ der verwalteten Dienstidentität.
Wert | Beschreibung |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
PrivateLinkConnectionState
Der Status einer privaten Verknüpfungsverbindung
Name | Typ | Beschreibung |
---|---|---|
actionsRequired |
string |
AktionenErforderlich für eine Private Link-Verbindung |
description |
string |
Beschreibung einer privaten Verknüpfungsverbindung |
status |
string |
Status einer privaten Verknüpfungsverbindung |
RemotePrivateEndpointConnection
Eine private Remoteendpunktverbindung
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID. |
kind |
string |
Art der Ressource. |
name |
string |
Ressourcenname. |
properties.ipAddresses |
string[] |
Private IPAddresses, die dem privaten Remoteendpunkt zugeordnet sind |
properties.privateEndpoint |
PrivateEndpoint einer remote-privaten Endpunktverbindung |
|
properties.privateLinkServiceConnectionState |
Der Status einer privaten Verknüpfungsverbindung |
|
properties.provisioningState |
string |
|
type |
string |
Ressourcentyp. |
ResponseMessageEnvelope[RemotePrivateEndpointConnection]
Nachrichtenumschlag, der die allgemeinen Eigenschaften des Azure-Ressourcen-Managers und den spezifischen Inhalt des Ressourcenanbieters enthält.
Name | Typ | Beschreibung |
---|---|---|
error |
Azure-AsyncOperation Fehlerinformationen. |
|
id |
string |
Ressourcen-ID. In der Regel wird die ID nur für Antworten auf GET-Anforderungen aufgefüllt. Der Aufrufer ist dafür verantwortlich, diesen Wert nur für GET-Anforderungen zu übergeben. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} |
identity |
MSI-Ressource |
|
location |
string |
Die Ressource der geografischen Region gehört z.B. SouthCentralUS, SouthEastAsia. |
name |
string |
Name der Ressource. |
plan |
Azure-Ressourcen-Manager-Plan. |
|
properties |
Ressourcenspezifische Eigenschaften. |
|
sku |
SKU-Beschreibung der Ressource. |
|
status |
string |
Azure-AsyncOperation Statusinformationen. |
tags |
object |
Tags, die einer Ressource zugeordnet sind. |
type |
string |
Typ der Ressource, z. B. "Microsoft.Web/Sites". |
zones |
string[] |
Logische Verfügbarkeitszonen, in der der Dienst gehostet wird |
SkuCapacity
Beschreibung der Skalierungsoptionen für den App Service-Plan.
Name | Typ | Beschreibung |
---|---|---|
default |
integer (int32) |
Standardanzahl der Mitarbeiter für diese App Service-Plan-SKU. |
elasticMaximum |
integer (int32) |
Maximale Anzahl von elastic Workern für diese App Service-Plan-SKU. |
maximum |
integer (int32) |
Maximale Anzahl von Mitarbeitern für diese App Service-Plan-SKU. |
minimum |
integer (int32) |
Mindestanzahl der Mitarbeiter für diese App Service-Plan-SKU. |
scaleType |
string |
Verfügbare Skalierungskonfigurationen für einen App Service-Plan. |
SkuDescription
Beschreibung einer SKU für eine skalierbare Ressource.
Name | Typ | Beschreibung |
---|---|---|
capabilities |
Funktionen der SKU, z. B. ist der Datenverkehrs-Manager aktiviert? |
|
capacity |
integer (int32) |
Aktuelle Anzahl der Instanzen, die der Ressource zugewiesen sind. |
family |
string |
Familiencode der Ressourcen-SKU. |
locations |
string[] |
Speicherorte der SKU. |
name |
string |
Name der Ressourcen-SKU. |
size |
string |
Größenbezeichner der Ressourcen-SKU. |
skuCapacity |
Min-, Max- und Standardwerte der SKU. |
|
tier |
string |
Dienstebene der Ressourcen-SKU. |
StagingEnvironmentPolicy
Status, der angibt, ob Stagingumgebungen für eine statische Web-App zulässig oder nicht zulässig sind.
Wert | Beschreibung |
---|---|
Disabled | |
Enabled |
StaticSiteARMResource
Arm-Ressource für statische Website.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID. |
identity |
Verwaltete Dienstidentität. |
|
kind |
string |
Art der Ressource. Wenn es sich bei der Ressource um eine App handelt, können Sie auf https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference für details unterstützte Werte für die Art verweisen. |
location |
string |
Ressourcenspeicherort. |
name |
string |
Ressourcenname. |
properties.allowConfigFileUpdates |
boolean |
|
properties.branch |
string |
Der Zielzweig im Repository. |
properties.buildProperties |
Erstellen Sie Eigenschaften, die für das Repository konfiguriert werden sollen. |
|
properties.contentDistributionEndpoint |
string |
Der Inhaltsverteilungsendpunkt für die statische Website. |
properties.customDomains |
string[] |
Die benutzerdefinierten Domänen, die dieser statischen Website zugeordnet sind. |
properties.databaseConnections |
Datenbankverbindungen für die statische Website |
|
properties.defaultHostname |
string |
Der standardmäßige automatisch generierte Hostname für die statische Website. |
properties.enterpriseGradeCdnStatus |
Status, der den Status des CDN der Unternehmensklasse angibt, der Datenverkehr an die statische Web-App angibt. |
|
properties.keyVaultReferenceIdentity |
string |
Identität, die für die Key Vault-Referenzauthentifizierung verwendet werden soll. |
properties.linkedBackends |
Back-Ends, die mit der statischen Seite verknüpft sind |
|
properties.privateEndpointConnections |
Private Endpunktverbindungen |
|
properties.provider |
string |
Der Anbieter, der die letzte Bereitstellung an die primäre Umgebung der statischen Website übermittelt hat. |
properties.publicNetworkAccess |
string |
Status, der angibt, ob der öffentliche Datenverkehr für eine statische Web-App zulässig ist oder nicht. Zulässige Werte: 'Enabled', 'Disabled' oder eine leere Zeichenfolge. |
properties.repositoryToken |
string |
GitHub-Repositorytoken eines Benutzers. Dies wird verwendet, um die Github Actions-Workflowdatei und API-Geheimnisse einzurichten. |
properties.repositoryUrl |
string |
URL für das Repository der statischen Website. |
properties.stagingEnvironmentPolicy |
Status, der angibt, ob Stagingumgebungen für eine statische Web-App zulässig oder nicht zulässig sind. |
|
properties.templateProperties |
Vorlagenoptionen zum Generieren eines neuen Repositorys. |
|
properties.userProvidedFunctionApps |
Vom Benutzer bereitgestellte Funktions-Apps, die bei der statischen Website registriert sind |
|
sku |
Beschreibung einer SKU für eine skalierbare Ressource. |
|
tags |
object |
Ressourcentags. |
type |
string |
Ressourcentyp. |
StaticSiteBuildProperties
Erstellen Sie Eigenschaften für die statische Website.
Name | Typ | Beschreibung |
---|---|---|
apiBuildCommand |
string |
Ein benutzerdefinierter Befehl, der während der Bereitstellung der Azure Functions-API-Anwendung ausgeführt werden soll. |
apiLocation |
string |
Der Pfad zum API-Code im Repository. |
appArtifactLocation |
string |
Veraltet: Der Pfad der App-Artefakte nach dem Erstellen (veraltet zugunsten von OutputLocation) |
appBuildCommand |
string |
Ein benutzerdefinierter Befehl, der während der Bereitstellung der statischen Inhaltsanwendung ausgeführt werden soll. |
appLocation |
string |
Der Pfad zum App-Code im Repository. |
githubActionSecretNameOverride |
string |
Überschreibung des geheimen Namens der Github-Aktion. |
outputLocation |
string |
Der Ausgabepfad der App nach dem Erstellen. |
skipGithubActionWorkflowGeneration |
boolean |
Überspringen Sie die Github-Aktionsworkflowgenerierung. |
StaticSiteCollection
Sammlung statischer Websites.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Link zur nächsten Seite von Ressourcen. |
value |
Sammlung von Ressourcen. |
StaticSiteDatabaseConnectionConfigurationFileOverview
Konfigurationsdatei für Datenbankverbindung
Name | Typ | Beschreibung |
---|---|---|
contents |
string |
Die Base64-Codierung des Dateiinhalts. |
fileName |
string |
Der Name der Konfigurationsdatei. |
type |
string |
Der Typ der Konfigurationsdatei. |
StaticSiteLinkedBackend
Static Site Linked Back-End ARM-Ressource.
Name | Typ | Beschreibung |
---|---|---|
backendResourceId |
string |
Die Ressourcen-ID des Back-End,das mit der statischen Website verknüpft ist |
createdOn |
string (date-time) |
Das Datum und die Uhrzeit, zu dem das Back-End mit der statischen Website verknüpft wurde. |
provisioningState |
string |
Der Bereitstellungsstatus des Verknüpfungsprozesses. |
region |
string |
Der Bereich des Back-End-Bereichs, der mit der statischen Website verknüpft ist |
StaticSiteTemplateOptions
Vorlagenoptionen für die statische Website.
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Beschreibung des neu generierten Repositorys. |
isPrivate |
boolean |
Gibt an, ob es sich bei dem neu generierten Repository um ein privates Repository handelt. Standardwert ist "false" (d. h. öffentlich). |
owner |
string |
Besitzer des neu generierten Repositorys. |
repositoryName |
string |
Name des neu generierten Repositorys. |
templateRepositoryUrl |
string |
URL des Vorlagen-Repositorys. Das neu generierte Repository basiert auf diesem Repository. |
StaticSiteUserProvidedFunctionApp
Eine von einem statischen Websitebenutzer bereitgestellte Funktion.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID. |
kind |
string |
Art der Ressource. |
name |
string |
Ressourcenname. |
properties.createdOn |
string (date-time) |
Das Datum und die Uhrzeit, zu dem die Funktions-App bei der statischen Website registriert wurde. |
properties.functionAppRegion |
string |
Der Bereich der Funktions-App, die bei der statischen Website registriert ist |
properties.functionAppResourceId |
string |
Die Ressourcen-ID der Funktions-App, die bei der statischen Website registriert ist |
type |
string |
Ressourcentyp. |
userAssignedIdentity
Vom Benutzer zugewiesene Identität.
Name | Typ | Beschreibung |
---|---|---|
clientId |
string |
Client-ID der vom Benutzer zugewiesenen Identität |
principalId |
string |
Prinzipal-ID der vom Benutzer zugewiesenen Identität |