Static Sites - Get Static Site
Opis dla Pobiera szczegóły witryny statycznej.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}?api-version=2024-11-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
name
|
path | True |
string |
Nazwa witryny statycznej. |
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$ |
Nazwa grupy zasobów, do której należy zasób. |
subscription
|
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 |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
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
Get details for a static site
Przykładowe żądanie
Przykładowa odpowiedź
{
"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": [
{
"backendResourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ApiManagement/service/apimService0",
"region": null,
"createdOn": "2022-03-27T04:57:24.8058474",
"provisioningState": "Succeeded"
}
],
"stagingEnvironmentPolicy": "Enabled",
"allowConfigFileUpdates": true
},
"sku": {
"name": "Basic",
"tier": "Basic"
}
}
Definicje
Nazwa | Opis |
---|---|
Arm |
Otoka identyfikatora zasobu usługi ARM |
Arm |
Obiekt planu w usłudze Azure Resource Manager reprezentuje plan witryny Marketplace. |
Capability |
Opisuje możliwości/funkcje dozwolone dla określonej jednostki SKU. |
Database |
Omówienie połączenia z bazą danych lokacji statycznej. |
Default |
Odpowiedź na błąd usługi App Service. |
Details | |
Enterprise |
Stan wskazujący stan sieci CDN klasy korporacyjnej obsługujący ruch do statycznej aplikacji internetowej. |
Error |
Model błędu. |
Error |
Treść odpowiedzi o błędzie zwróconej z interfejsu API. |
Managed |
Tożsamość usługi zarządzanej. |
Managed |
Typ tożsamości usługi zarządzanej. |
Private |
Stan połączenia łącza prywatnego |
Remote |
Zdalne połączenie prywatnego punktu końcowego |
Response |
Koperta komunikatu zawierająca typowe właściwości usługi Azure Resource Manager i zawartość specyficzną dla dostawcy zasobów. |
Sku |
Opis opcji skalowania planu usługi App Service. |
Sku |
Opis jednostki SKU dla skalowalnego zasobu. |
Staging |
Stan wskazujący, czy środowiska przejściowe są dozwolone, czy niedozwolone dla statycznej aplikacji internetowej. |
Static |
Zasób usługi ARM witryny statycznej. |
Static |
Właściwości kompilacji dla witryny statycznej. |
Static |
Plik konfiguracji połączenia z bazą danych |
Static |
Zasób usługi ARM połączonej lokacji statycznej. |
Static |
Opcje szablonu dla witryny statycznej. |
Static |
Funkcja udostępniona przez użytkownika witryny statycznej. |
user |
Tożsamość przypisana przez użytkownika. |
ArmIdWrapper
Otoka identyfikatora zasobu usługi ARM
Nazwa | Typ | Opis |
---|---|---|
id |
string |
ArmPlan
Obiekt planu w usłudze Azure Resource Manager reprezentuje plan witryny Marketplace.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa. |
product |
string |
Produkt. |
promotionCode |
string |
Kod podwyższania poziomu. |
publisher |
string |
Wydawca. |
version |
string |
Wersja produktu. |
Capability
Opisuje możliwości/funkcje dozwolone dla określonej jednostki SKU.
Nazwa | Typ | Opis |
---|---|---|
name |
string |
Nazwa możliwości jednostki SKU. |
reason |
string |
Przyczyna możliwości jednostki SKU. |
value |
string |
Wartość możliwości jednostki SKU. |
DatabaseConnectionOverview
Omówienie połączenia z bazą danych lokacji statycznej.
Nazwa | Typ | Opis |
---|---|---|
configurationFiles |
Lista plików konfiguracji skojarzonych z tym połączeniem bazy danych. |
|
connectionIdentity |
string |
Jeśli istnieje, tożsamość jest używana w połączeniu z parametrami połączenia w celu nawiązania połączenia z bazą danych. Użycie tożsamości zarządzanej przypisanej przez system jest wskazywane za pomocą ciągu "SystemAssigned", podczas gdy użycie tożsamości zarządzanej przypisanej przez użytkownika jest wskazywane przy użyciu identyfikatora zasobu tożsamości zarządzanej. |
name |
string |
Jeśli istnieje, nazwa tego zasobu połączenia z bazą danych. |
region |
string |
Region zasobu bazy danych. |
resourceId |
string |
Identyfikator zasobu bazy danych. |
DefaultErrorResponse
Odpowiedź na błąd usługi App Service.
Nazwa | Typ | Opis |
---|---|---|
error |
Model błędu. |
Details
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. |
EnterpriseGradeCdnStatus
Stan wskazujący stan sieci CDN klasy korporacyjnej obsługujący ruch do statycznej aplikacji internetowej.
Wartość | Opis |
---|---|
Disabled | |
Disabling | |
Enabled | |
Enabling |
Error
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. |
ErrorEntity
Treść odpowiedzi o błędzie zwróconej z interfejsu API.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Podstawowy kod błędu. |
details |
Szczegóły błędu. |
|
extendedCode |
string |
Typ błędu. |
innerErrors |
Błędy wewnętrzne. |
|
message |
string |
Wszelkie szczegóły błędu. |
messageTemplate |
string |
Szablon wiadomości. |
parameters |
string[] |
Parametry szablonu. |
target |
string |
Element docelowy błędu. |
ManagedServiceIdentity
Tożsamość usługi zarządzanej.
Nazwa | Typ | Opis |
---|---|---|
principalId |
string |
Identyfikator jednostki tożsamości usługi zarządzanej. |
tenantId |
string |
Dzierżawa tożsamości usługi zarządzanej. |
type |
Typ tożsamości usługi zarządzanej. |
|
userAssignedIdentities |
<string,
user |
Lista tożsamości przypisanych przez użytkownika skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
ManagedServiceIdentityType
Typ tożsamości usługi zarządzanej.
Wartość | Opis |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
PrivateLinkConnectionState
Stan połączenia łącza prywatnego
Nazwa | Typ | Opis |
---|---|---|
actionsRequired |
string |
ActionsRequired dla połączenia łącza prywatnego |
description |
string |
Opis połączenia łącza prywatnego |
status |
string |
Stan połączenia łącza prywatnego |
RemotePrivateEndpointConnection
Zdalne połączenie prywatnego punktu końcowego
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
kind |
string |
Rodzaj zasobu. |
name |
string |
Nazwa zasobu. |
properties.ipAddresses |
string[] |
Prywatne adresy IPAddresses zamapowane na zdalny prywatny punkt końcowy |
properties.privateEndpoint |
PrivateEndpoint połączenia z zdalnym prywatnym punktem końcowym |
|
properties.privateLinkServiceConnectionState |
Stan połączenia łącza prywatnego |
|
properties.provisioningState |
string |
|
type |
string |
Typ zasobu. |
ResponseMessageEnvelope[RemotePrivateEndpointConnection]
Koperta komunikatu zawierająca typowe właściwości usługi Azure Resource Manager i zawartość specyficzną dla dostawcy zasobów.
Nazwa | Typ | Opis |
---|---|---|
error |
Azure-AsyncOperation Informacje o błędzie. |
|
id |
string |
Identyfikator zasobu. Zazwyczaj identyfikator jest wypełniany tylko dla odpowiedzi na żądania GET. Obiekt wywołujący jest odpowiedzialny za przekazywanie tej wartości tylko dla żądań GET. Na przykład: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} |
identity |
Zasób MSI |
|
location |
string |
Zasób regionu geograficznego należy do np. SouthCentralUS, SouthEastAsia. |
name |
string |
Nazwa zasobu. |
plan |
Plan usługi Azure Resource Manager. |
|
properties |
Właściwości specyficzne dla zasobu. |
|
sku |
Opis jednostki SKU zasobu. |
|
status |
string |
Azure-AsyncOperation informacje o stanie. |
tags |
object |
Tagi skojarzone z zasobem. |
type |
string |
Typ zasobu, np. "Microsoft.Web/sites". |
zones |
string[] |
Logiczne strefy dostępności, w których jest hostowana usługa |
SkuCapacity
Opis opcji skalowania planu usługi App Service.
Nazwa | Typ | Opis |
---|---|---|
default |
integer (int32) |
Domyślna liczba procesów roboczych dla tej jednostki SKU planu usługi App Service. |
elasticMaximum |
integer (int32) |
Maksymalna liczba elastycznych procesów roboczych dla tej jednostki SKU planu usługi App Service. |
maximum |
integer (int32) |
Maksymalna liczba procesów roboczych dla tej jednostki SKU planu usługi App Service. |
minimum |
integer (int32) |
Minimalna liczba procesów roboczych dla tej jednostki SKU planu usługi App Service. |
scaleType |
string |
Dostępne konfiguracje skalowania dla planu usługi App Service. |
SkuDescription
Opis jednostki SKU dla skalowalnego zasobu.
Nazwa | Typ | Opis |
---|---|---|
capabilities |
Możliwości jednostki SKU, np. czy usługa Traffic Manager jest włączona? |
|
capacity |
integer (int32) |
Bieżąca liczba wystąpień przypisanych do zasobu. |
family |
string |
Kod rodziny jednostki SKU zasobu. |
locations |
string[] |
Lokalizacje jednostki SKU. |
name |
string |
Nazwa jednostki SKU zasobu. |
size |
string |
Specyfikator rozmiaru jednostki SKU zasobu. |
skuCapacity |
Minimalne, maksymalne i domyślne wartości skalowania jednostki SKU. |
|
tier |
string |
Warstwa usługi jednostki SKU zasobu. |
StagingEnvironmentPolicy
Stan wskazujący, czy środowiska przejściowe są dozwolone, czy niedozwolone dla statycznej aplikacji internetowej.
Wartość | Opis |
---|---|
Disabled | |
Enabled |
StaticSiteARMResource
Zasób usługi ARM witryny statycznej.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
identity |
Tożsamość usługi zarządzanej. |
|
kind |
string |
Rodzaj zasobu. Jeśli zasób jest aplikacją, możesz zapoznać się z https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference, aby uzyskać szczegółowe informacje o obsługiwanych wartościach dla rodzaju. |
location |
string |
Lokalizacja zasobu. |
name |
string |
Nazwa zasobu. |
properties.allowConfigFileUpdates |
boolean |
|
properties.branch |
string |
Gałąź docelowa w repozytorium. |
properties.buildProperties |
Utwórz właściwości do skonfigurowania w repozytorium. |
|
properties.contentDistributionEndpoint |
string |
Punkt końcowy dystrybucji zawartości dla witryny statycznej. |
properties.customDomains |
string[] |
Domeny niestandardowe skojarzone z tą witryną statyczną. |
properties.databaseConnections |
Połączenia bazy danych dla lokacji statycznej |
|
properties.defaultHostname |
string |
Domyślna automatycznie wygenerowana nazwa hosta dla witryny statycznej. |
properties.enterpriseGradeCdnStatus |
Stan wskazujący stan sieci CDN klasy korporacyjnej obsługujący ruch do statycznej aplikacji internetowej. |
|
properties.keyVaultReferenceIdentity |
string |
Tożsamość do użycia na potrzeby uwierzytelniania referencyjnego usługi Key Vault. |
properties.linkedBackends |
Zaplecza połączone ze statyczną stroną |
|
properties.privateEndpointConnections |
Połączenia z prywatnym punktem końcowym |
|
properties.provider |
string |
Dostawca, który przesłał ostatnie wdrożenie do podstawowego środowiska lokacji statycznej. |
properties.publicNetworkAccess |
string |
Stan wskazujący, czy ruch publiczny jest dozwolony, czy nie dla statycznej aplikacji internetowej. Dozwolone wartości: "Włączone", "Wyłączone" lub pusty ciąg. |
properties.repositoryToken |
string |
Token repozytorium github użytkownika. Służy to do konfigurowania pliku przepływu pracy funkcji Github Actions i wpisów tajnych interfejsu API. |
properties.repositoryUrl |
string |
Adres URL repozytorium witryny statycznej. |
properties.stagingEnvironmentPolicy |
Stan wskazujący, czy środowiska przejściowe są dozwolone, czy niedozwolone dla statycznej aplikacji internetowej. |
|
properties.templateProperties |
Opcje szablonu do generowania nowego repozytorium. |
|
properties.userProvidedFunctionApps |
Aplikacje funkcji udostępnione przez użytkownika zarejestrowane w witrynie statycznej |
|
sku |
Opis jednostki SKU dla skalowalnego zasobu. |
|
tags |
object |
Tagi zasobów. |
type |
string |
Typ zasobu. |
StaticSiteBuildProperties
Właściwości kompilacji dla witryny statycznej.
Nazwa | Typ | Opis |
---|---|---|
apiBuildCommand |
string |
Niestandardowe polecenie uruchamiane podczas wdrażania aplikacji interfejsu API usługi Azure Functions. |
apiLocation |
string |
Ścieżka do kodu interfejsu API w repozytorium. |
appArtifactLocation |
string |
Przestarzałe: ścieżka artefaktów aplikacji po utworzeniu (przestarzała na rzecz outputLocation) |
appBuildCommand |
string |
Niestandardowe polecenie uruchamiane podczas wdrażania aplikacji zawartości statycznej. |
appLocation |
string |
Ścieżka do kodu aplikacji w repozytorium. |
githubActionSecretNameOverride |
string |
Zastąpić nazwę wpisu tajnego akcji usługi GitHub. |
outputLocation |
string |
Ścieżka wyjściowa aplikacji po utworzeniu. |
skipGithubActionWorkflowGeneration |
boolean |
Pomiń generowanie przepływu pracy akcji usługi GitHub. |
StaticSiteDatabaseConnectionConfigurationFileOverview
Plik konfiguracji połączenia z bazą danych
Nazwa | Typ | Opis |
---|---|---|
contents |
string |
Kodowanie base64 zawartości pliku. |
fileName |
string |
Nazwa pliku konfiguracji. |
type |
string |
Typ pliku konfiguracji. |
StaticSiteLinkedBackend
Zasób usługi ARM połączonej lokacji statycznej.
Nazwa | Typ | Opis |
---|---|---|
backendResourceId |
string |
Identyfikator zasobu zaplecza połączonego z witryną statyczną |
createdOn |
string (date-time) |
Data i godzina, w której zaplecze zostało połączone z witryną statyczną. |
provisioningState |
string |
Stan aprowizacji procesu łączenia. |
region |
string |
Region zaplecza połączonego z witryną statyczną |
StaticSiteTemplateOptions
Opcje szablonu dla witryny statycznej.
Nazwa | Typ | Opis |
---|---|---|
description |
string |
Opis nowo wygenerowanego repozytorium. |
isPrivate |
boolean |
Niezależnie od tego, czy nowo wygenerowane repozytorium jest repozytorium prywatnym. Wartością domyślną jest fałsz (tj. publiczna). |
owner |
string |
Właściciel nowo wygenerowanego repozytorium. |
repositoryName |
string |
Nazwa nowo wygenerowanego repozytorium. |
templateRepositoryUrl |
string |
Adres URL repozytorium szablonów. Nowo wygenerowane repozytorium będzie oparte na tym. |
StaticSiteUserProvidedFunctionApp
Funkcja udostępniona przez użytkownika witryny statycznej.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Identyfikator zasobu. |
kind |
string |
Rodzaj zasobu. |
name |
string |
Nazwa zasobu. |
properties.createdOn |
string (date-time) |
Data i godzina zarejestrowania aplikacji funkcji w witrynie statycznej. |
properties.functionAppRegion |
string |
Region aplikacji funkcji zarejestrowany w witrynie statycznej |
properties.functionAppResourceId |
string |
Identyfikator zasobu aplikacji funkcji zarejestrowanej w witrynie statycznej |
type |
string |
Typ zasobu. |
userAssignedIdentity
Tożsamość przypisana przez użytkownika.
Nazwa | Typ | Opis |
---|---|---|
clientId |
string |
Identyfikator klienta tożsamości przypisanej przez użytkownika |
principalId |
string |
Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika |