Dela via


Static Sites - Create Or Update Static Site

Beskrivning för Skapar en ny statisk plats i en befintlig resursgrupp eller uppdaterar en befintlig statisk webbplats.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}?api-version=2023-12-01

URI-parametrar

Name I Obligatorisk Typ Description
name
path True

string

Namnet på den statiska webbplats som ska skapas eller uppdateras.

resourceGroupName
path True

string

Namnet på resursgruppen som resursen tillhör.

Reguljärt uttrycksmönster: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

ditt prenumerations-ID för Azure Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-0000-000000000).

api-version
query True

string

API-version

Begärandetext

Name Obligatorisk Typ Description
location True

string

Resursplats.

identity

ManagedServiceIdentity

Hanterad tjänstidentitet.

kind

string

Typ av resurs.

properties.allowConfigFileUpdates

boolean

falseom konfigurationsfilen är låst för den här statiska webbappen; annars . true

properties.branch

string

Målgrenen i lagringsplatsen.

properties.buildProperties

StaticSiteBuildProperties

Skapa egenskaper som ska konfigureras på lagringsplatsen.

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

Tillstånd som anger status för cdn i företagsklass som betjänar trafik till den statiska webbappen.

properties.provider

string

Providern som skickade den senaste distributionen till den statiska platsens primära miljö.

properties.publicNetworkAccess

string

Tillstånd som anger om offentlig trafik tillåts eller inte för en statisk webbapp. Tillåtna värden: "Aktiverad", "Inaktiverad" eller en tom sträng.

properties.repositoryToken

string

En användares github-lagringsplatstoken. Detta används för att konfigurera Github Actions-arbetsflödesfilen och API-hemligheterna.

properties.repositoryUrl

string

URL för lagringsplatsen för den statiska platsen.

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

Tillstånd som anger om mellanlagringsmiljöer tillåts eller inte tillåts för en statisk webbapp.

properties.templateProperties

StaticSiteTemplateOptions

Mallalternativ för att generera en ny lagringsplats.

sku

SkuDescription

Beskrivning av en SKU för en skalbar resurs.

tags

object

Resurstaggar.

Svar

Name Typ Description
200 OK

StaticSiteARMResource

OK.

202 Accepted

StaticSiteARMResource

Asynkron åtgärd pågår.

Other Status Codes

DefaultErrorResponse

App Service felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Create or update a static site

Exempelbegäran

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

{
  "location": "West US 2",
  "properties": {
    "repositoryUrl": "https://github.com/username/RepoName",
    "branch": "master",
    "repositoryToken": "repoToken123",
    "buildProperties": {
      "appLocation": "app",
      "apiLocation": "api",
      "appArtifactLocation": "build"
    }
  },
  "sku": {
    "name": "Basic",
    "tier": "Basic"
  }
}

Exempelsvar

{
  "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/RepoName",
    "branch": "demo",
    "customDomains": [],
    "privateEndpointConnections": [],
    "contentDistributionEndpoint": "",
    "keyVaultReferenceIdentity": "SystemAssigned",
    "userProvidedFunctionApps": null,
    "linkedBackends": [],
    "stagingEnvironmentPolicy": "Enabled",
    "allowConfigFileUpdates": true
  },
  "sku": {
    "name": "Basic",
    "tier": "Basic"
  }
}
azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01
{
  "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/RepoName",
    "branch": "demo",
    "customDomains": [],
    "privateEndpointConnections": [],
    "contentDistributionEndpoint": "",
    "keyVaultReferenceIdentity": "SystemAssigned",
    "userProvidedFunctionApps": null,
    "linkedBackends": [],
    "stagingEnvironmentPolicy": "Enabled",
    "allowConfigFileUpdates": true
  },
  "sku": {
    "name": "Basic",
    "tier": "Basic"
  }
}

Definitioner

Name Description
ArmIdWrapper

En adapter för ett ARM-resurs-ID

ArmPlan

Planobjektet i Azure Resource Manager representerar en Marketplace-plan.

Capability

Beskriver de funktioner/funktioner som tillåts för en specifik SKU.

DatabaseConnectionOverview

Översikt över anslutning till statisk platsdatabas.

DefaultErrorResponse

App Service felsvar.

Details
EnterpriseGradeCdnStatus

Tillstånd som anger status för cdn i företagsklass som betjänar trafik till den statiska webbappen.

Error

Felmodell.

ErrorEntity

Brödtexten i felsvaret som returneras från API:et.

ManagedServiceIdentity

Hanterad tjänstidentitet.

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet.

PrivateLinkConnectionState

Status för en privat länkanslutning

RemotePrivateEndpointConnection

En fjärransluten privat slutpunktsanslutning

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Meddelandekuvert som innehåller vanliga Azure Resource Manager-egenskaper och resursproviderns specifika innehåll.

SkuCapacity

Beskrivning av skalningsalternativen för App Service plan.

SkuDescription

Beskrivning av en SKU för en skalbar resurs.

StagingEnvironmentPolicy

Tillstånd som anger om mellanlagringsmiljöer tillåts eller inte tillåts för en statisk webbapp.

StaticSiteARMResource

ARM-resurs för statisk webbplats.

StaticSiteBuildProperties

Skapa egenskaper för den statiska webbplatsen.

StaticSiteDatabaseConnectionConfigurationFileOverview

En konfigurationsfil för databasanslutning

StaticSiteLinkedBackend

Arm-resurs för länkad statisk webbplats.

StaticSiteTemplateOptions

Mallalternativ för den statiska webbplatsen.

StaticSiteUserProvidedFunctionApp

En funktion som tillhandahålls av en statisk webbplatsanvändare.

userAssignedIdentity

Användartilldelad identitet.

ArmIdWrapper

En adapter för ett ARM-resurs-ID

Name Typ Description
id

string

ArmPlan

Planobjektet i Azure Resource Manager representerar en Marketplace-plan.

Name Typ Description
name

string

Namnet.

product

string

Produkten.

promotionCode

string

Upphöjningskoden.

publisher

string

Utgivaren.

version

string

Produktversion.

Capability

Beskriver de funktioner/funktioner som tillåts för en specifik SKU.

Name Typ Description
name

string

Namnet på SKU-funktionen.

reason

string

Orsak till SKU-funktionen.

value

string

Värdet för SKU-funktionen.

DatabaseConnectionOverview

Översikt över anslutning till statisk platsdatabas.

Name Typ Description
configurationFiles

StaticSiteDatabaseConnectionConfigurationFileOverview[]

En lista över konfigurationsfiler som är associerade med den här databasanslutningen.

connectionIdentity

string

Om det finns används identiteten tillsammans med anslutningssträng för att ansluta till databasen. Användning av den systemtilldelade hanterade identiteten anges med strängen "SystemAssigned", medan användning av en användartilldelad hanterad identitet anges med resurs-ID:t för den hanterade identitetsresursen.

name

string

Om det finns namnet på den här databasanslutningsresursen.

region

string

Databasresursens region.

resourceId

string

Databasens resurs-ID.

DefaultErrorResponse

App Service felsvar.

Name Typ Description
error

Error

Felmodell.

Details

Name Typ Description
code

string

Standardiserad sträng för att programmässigt identifiera felet.

message

string

Detaljerad felbeskrivning och felsökningsinformation.

target

string

Detaljerad felbeskrivning och felsökningsinformation.

EnterpriseGradeCdnStatus

Tillstånd som anger status för cdn i företagsklass som betjänar trafik till den statiska webbappen.

Name Typ Description
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Error

Felmodell.

Name Typ Description
code

string

Standardiserad sträng för att programmässigt identifiera felet.

details

Details[]

Detaljerade fel.

innererror

string

Mer information om felsökningsfel.

message

string

Detaljerad felbeskrivning och felsökningsinformation.

target

string

Detaljerad felbeskrivning och felsökningsinformation.

ErrorEntity

Brödtexten i felsvaret som returneras från API:et.

Name Typ Description
code

string

Grundläggande felkod.

details

ErrorEntity[]

Felinformation.

extendedCode

string

Typ av fel.

innerErrors

ErrorEntity[]

Inre fel.

message

string

All information om felet.

messageTemplate

string

Meddelandemall.

parameters

string[]

Parametrar för mallen.

target

string

Felmålet.

ManagedServiceIdentity

Hanterad tjänstidentitet.

Name Typ Description
principalId

string

Huvud-ID för hanterad tjänstidentitet.

tenantId

string

Klientorganisation för hanterad tjänstidentitet.

type

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet.

userAssignedIdentities

<string,  userAssignedIdentity>

Listan över användartilldelade identiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Typ av hanterad tjänstidentitet.

Name Typ Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateLinkConnectionState

Status för en privat länkanslutning

Name Typ Description
actionsRequired

string

ActionsRequired för en privat länkanslutning

description

string

Beskrivning av en privat länkanslutning

status

string

Status för en privat länkanslutning

RemotePrivateEndpointConnection

En fjärransluten privat slutpunktsanslutning

Name Typ Description
id

string

Resurs-ID.

kind

string

Typ av resurs.

name

string

Resursnamn.

properties.ipAddresses

string[]

Privata IPAddresses mappade till den privata fjärrslutpunkten

properties.privateEndpoint

ArmIdWrapper

PrivateEndpoint för en fjärransluten privat slutpunktsanslutning

properties.privateLinkServiceConnectionState

PrivateLinkConnectionState

Status för en privat länkanslutning

properties.provisioningState

string

type

string

Resurstyp.

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Meddelandekuvert som innehåller vanliga Azure Resource Manager-egenskaper och resursproviderns specifika innehåll.

Name Typ Description
error

ErrorEntity

Azure-AsyncOperation Felinformation.

id

string

Resurs-ID. Vanligtvis fylls ID bara i för svar på GET-begäranden. Anroparen ansvarar endast för att skicka det här värdet för GET-begäranden. Exempel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}

identity

ManagedServiceIdentity

MSI-resurs

location

string

Den geografiska regionresursen tillhör t.ex. SouthCentralUS, SouthEastAsia.

name

string

Namnet på resursen.

plan

ArmPlan

Azure Resource Manager-plan.

properties

RemotePrivateEndpointConnection

Resursspecifika egenskaper.

sku

SkuDescription

SKU-beskrivning av resursen.

status

string

Azure-AsyncOperation statusinformation.

tags

object

Taggar som är associerade med resursen.

type

string

Typ av resurs, t.ex. "Microsoft.Web/sites".

zones

string[]

Logiska Tillgänglighetszoner tjänsten finns i

SkuCapacity

Beskrivning av skalningsalternativen för App Service plan.

Name Typ Description
default

integer

Standardantalet arbetare för den här App Service plan-SKU:n.

elasticMaximum

integer

Maximalt antal elastiska arbetare för den här App Service planera SKU:n.

maximum

integer

Maximalt antal arbetare för den här App Service planera SKU:n.

minimum

integer

Minsta antal arbetare för den här App Service planera SKU:n.

scaleType

string

Tillgängliga skalningskonfigurationer för en App Service plan.

SkuDescription

Beskrivning av en SKU för en skalbar resurs.

Name Typ Description
capabilities

Capability[]

Funktioner i SKU:n, t.ex. är Traffic Manager aktiverat?

capacity

integer

Aktuellt antal instanser som tilldelats resursen.

family

string

Familjekod för resurs-SKU:n.

locations

string[]

Platser för SKU:n.

name

string

Namnet på resurs-SKU:n.

size

string

Storleksspecificerare för resurs-SKU:n.

skuCapacity

SkuCapacity

Min-, max- och standardskalningsvärden för SKU:n.

tier

string

Tjänstnivå för resurs-SKU:n.

StagingEnvironmentPolicy

Tillstånd som anger om mellanlagringsmiljöer tillåts eller inte tillåts för en statisk webbapp.

Name Typ Description
Disabled

string

Enabled

string

StaticSiteARMResource

ARM-resurs för statisk webbplats.

Name Typ Description
id

string

Resurs-ID.

identity

ManagedServiceIdentity

Hanterad tjänstidentitet.

kind

string

Typ av resurs.

location

string

Resursplats.

name

string

Resursnamn.

properties.allowConfigFileUpdates

boolean

falseom konfigurationsfilen är låst för den här statiska webbappen; annars . true

properties.branch

string

Målgrenen i lagringsplatsen.

properties.buildProperties

StaticSiteBuildProperties

Skapa egenskaper som ska konfigureras på lagringsplatsen.

properties.contentDistributionEndpoint

string

Innehållsdistributionsslutpunkten för den statiska webbplatsen.

properties.customDomains

string[]

De anpassade domäner som är associerade med den här statiska webbplatsen.

properties.databaseConnections

DatabaseConnectionOverview[]

Databasanslutningar för den statiska platsen

properties.defaultHostname

string

Standardvärdet för automatiskt genererade värdnamn för den statiska platsen.

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

Tillstånd som anger status för cdn i företagsklass som betjänar trafik till den statiska webbappen.

properties.keyVaultReferenceIdentity

string

Identitet som ska användas för Key Vault referensautentisering.

properties.linkedBackends

StaticSiteLinkedBackend[]

Serverdelar som är länkade till den statiska sidan

properties.privateEndpointConnections

ResponseMessageEnvelope[RemotePrivateEndpointConnection][]

Anslutningar med privat slutpunkt

properties.provider

string

Providern som skickade den senaste distributionen till den statiska platsens primära miljö.

properties.publicNetworkAccess

string

Tillstånd som anger om offentlig trafik tillåts eller inte för en statisk webbapp. Tillåtna värden: "Aktiverad", "Inaktiverad" eller en tom sträng.

properties.repositoryToken

string

En användares github-lagringsplatstoken. Detta används för att konfigurera Github Actions-arbetsflödesfilen och API-hemligheterna.

properties.repositoryUrl

string

URL för lagringsplatsen för den statiska platsen.

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

Tillstånd som anger om mellanlagringsmiljöer tillåts eller inte tillåts för en statisk webbapp.

properties.templateProperties

StaticSiteTemplateOptions

Mallalternativ för att generera en ny lagringsplats.

properties.userProvidedFunctionApps

StaticSiteUserProvidedFunctionApp[]

Användardefinierade funktionsappar som registrerats med den statiska webbplatsen

sku

SkuDescription

Beskrivning av en SKU för en skalbar resurs.

tags

object

Resurstaggar.

type

string

Resurstyp.

StaticSiteBuildProperties

Skapa egenskaper för den statiska webbplatsen.

Name Typ Description
apiBuildCommand

string

Ett anpassat kommando som ska köras under distributionen av Azure Functions API-programmet.

apiLocation

string

Sökvägen till API-koden på lagringsplatsen.

appArtifactLocation

string

Inaktuell: Sökvägen till appartefakterna efter skapande (inaktuell till förmån för OutputLocation)

appBuildCommand

string

Ett anpassat kommando som ska köras under distributionen av det statiska innehållsprogrammet.

appLocation

string

Sökvägen till appkoden på lagringsplatsen.

githubActionSecretNameOverride

string

Åsidosättning av hemlighetsnamn för Github-åtgärd.

outputLocation

string

Utdatasökvägen för appen efter skapandet.

skipGithubActionWorkflowGeneration

boolean

Hoppa över generering av Github-åtgärdsarbetsflöde.

StaticSiteDatabaseConnectionConfigurationFileOverview

En konfigurationsfil för databasanslutning

Name Typ Description
contents

string

Base64-kodningen av filinnehållet.

fileName

string

Namnet på konfigurationsfilen.

type

string

Typ av konfigurationsfil.

StaticSiteLinkedBackend

Arm-resurs för länkad statisk webbplats.

Name Typ Description
backendResourceId

string

Resurs-ID för serverdelen som är länkad till den statiska platsen

createdOn

string

Datum och tid då serverdelen länkades till den statiska webbplatsen.

provisioningState

string

Etableringstillståndet för länkningsprocessen.

region

string

Regionen för serverdelen som är länkad till den statiska platsen

StaticSiteTemplateOptions

Mallalternativ för den statiska webbplatsen.

Name Typ Description
description

string

Beskrivning av den nyligen genererade lagringsplatsen.

isPrivate

boolean

Om den nyligen genererade lagringsplatsen är en privat lagringsplats eller inte. Standardvärdet är falskt (dvs. offentligt).

owner

string

Ägare till den nyligen genererade lagringsplatsen.

repositoryName

string

Namnet på den nyligen genererade lagringsplatsen.

templateRepositoryUrl

string

URL för malllagringsplatsen. Den nyligen genererade lagringsplatsen baseras på den här.

StaticSiteUserProvidedFunctionApp

En funktion som tillhandahålls av en statisk webbplatsanvändare.

Name Typ Description
id

string

Resurs-ID.

kind

string

Typ av resurs.

name

string

Resursnamn.

properties.createdOn

string

Datum och tid då funktionsappen registrerades på den statiska webbplatsen.

properties.functionAppRegion

string

Regionen för funktionsappen som är registrerad på den statiska platsen

properties.functionAppResourceId

string

Resurs-ID för funktionsappen som registrerats med den statiska webbplatsen

type

string

Resurstyp.

userAssignedIdentity

Användartilldelad identitet.

Name Typ Description
clientId

string

Klient-ID för användartilldelad identitet

principalId

string

Huvudkonto-ID för användartilldelad identitet