Compartilhar via


Static Sites - Update Static Site

Descrição para Cria um novo site estático em um grupo de recursos existente ou atualiza um site estático existente.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
name
path True

string

Nome do site estático a ser criado ou atualizado.

resourceGroupName
path True

string

Nome do grupo de recursos ao qual pertence o recurso.

Padrão Regex: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada em GUID (por exemplo, 00000000-0000-0000-0000-0000000000000000000000).

api-version
query True

string

Versão da API

Corpo da solicitação

Nome Tipo Description
kind

string

Tipo de recurso.

properties.allowConfigFileUpdates

boolean

false se o arquivo de configuração estiver bloqueado para este aplicativo Web estático; caso contrário, true.

properties.branch

string

O branch de destino no repositório.

properties.buildProperties

StaticSiteBuildProperties

Compile propriedades para configurar no repositório.

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

Estado que indica o status da CDN de nível empresarial que fornece tráfego para o aplicativo Web estático.

properties.provider

string

O provedor que enviou a última implantação para o ambiente primário do site estático.

properties.publicNetworkAccess

string

Estado que indica se o tráfego público é permitido ou não para um aplicativo Web estático. Valores permitidos: 'Habilitado', 'Desabilitado' ou uma cadeia de caracteres vazia.

properties.repositoryToken

string

Token do repositório github de um usuário. Isso é usado para configurar o arquivo de fluxo de trabalho do Github Actions e os segredos da API.

properties.repositoryUrl

string

URL para o repositório do site estático.

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

Estado que indica se os ambientes de preparo são permitidos ou não para um aplicativo Web estático.

properties.templateProperties

StaticSiteTemplateOptions

Opções de modelo para gerar um novo repositório.

Respostas

Nome Tipo Description
200 OK

StaticSiteARMResource

OK.

202 Accepted

StaticSiteARMResource

Operação assíncrona em andamento.

Other Status Codes

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Patch a static site

Solicitação de exemplo

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

{
  "properties": {}
}

Resposta de exemplo

{
  "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": [],
    "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": [],
    "stagingEnvironmentPolicy": "Enabled",
    "allowConfigFileUpdates": true
  },
  "sku": {
    "name": "Basic",
    "tier": "Basic"
  }
}

Definições

Nome Description
ArmIdWrapper

Um wrapper para uma ID de recurso do ARM

ArmPlan

O objeto de plano no Azure Resource Manager representa um plano do marketplace.

Capability

Descreve os recursos/funcionalidades permitidos para um SKU específico.

DatabaseConnectionOverview

Visão geral da Conexão de Banco de Dados do Site Estático.

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Details
EnterpriseGradeCdnStatus

Estado que indica o status da CDN de nível empresarial que fornece tráfego para o aplicativo Web estático.

Error

Modelo de erro.

ErrorEntity

Corpo da resposta de erro retornada da API.

ManagedServiceIdentity

Identidade de serviço gerenciada.

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada.

PrivateLinkConnectionState

O estado de uma conexão de link privado

RemotePrivateEndpointConnection

Uma conexão de ponto de extremidade privado remoto

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Envelope de mensagem que contém as propriedades comuns do gerenciador de recursos do Azure e o conteúdo específico do provedor de recursos.

SkuCapacity

Descrição das opções de escala do plano Serviço de Aplicativo.

SkuDescription

Descrição de um SKU para um recurso escalonável.

StagingEnvironmentPolicy

Estado que indica se os ambientes de preparo são permitidos ou não para um aplicativo Web estático.

StaticSiteARMResource

Recurso ARM do Site Estático.

StaticSiteBuildProperties

Propriedades de build para o site estático.

StaticSiteDatabaseConnectionConfigurationFileOverview

Um arquivo de configuração de conexão de banco de dados

StaticSiteLinkedBackend

Recurso arm de back-end vinculado do site estático.

StaticSitePatchResource

Recurso do ARM para um site estático ao aplicar patch

StaticSiteTemplateOptions

Opções de modelo para o site estático.

StaticSiteUserProvidedFunctionApp

Uma função fornecida pelo usuário do site estático.

userAssignedIdentity

Identidade atribuída pelo usuário.

ArmIdWrapper

Um wrapper para uma ID de recurso do ARM

Nome Tipo Description
id

string

ArmPlan

O objeto de plano no Azure Resource Manager representa um plano do marketplace.

Nome Tipo Description
name

string

O nome.

product

string

O produto.

promotionCode

string

O código da promoção.

publisher

string

O publicador.

version

string

Versão do produto.

Capability

Descreve os recursos/funcionalidades permitidos para um SKU específico.

Nome Tipo Description
name

string

Nome da funcionalidade de SKU.

reason

string

Motivo da funcionalidade de SKU.

value

string

Valor da funcionalidade de SKU.

DatabaseConnectionOverview

Visão geral da Conexão de Banco de Dados do Site Estático.

Nome Tipo Description
configurationFiles

StaticSiteDatabaseConnectionConfigurationFileOverview[]

Uma lista de arquivos de configuração associados a essa conexão de banco de dados.

connectionIdentity

string

Se presente, a identidade é usada em conjunto com cadeia de conexão para se conectar ao banco de dados. O uso da identidade gerenciada atribuída pelo sistema é indicado com a cadeia de caracteres 'SystemAssigned', enquanto o uso de uma identidade gerenciada atribuída pelo usuário é indicado com a ID do recurso de identidade gerenciada.

name

string

Se presente, o nome desse recurso de conexão de banco de dados.

region

string

A região do recurso de banco de dados.

resourceId

string

A ID do recurso do banco de dados.

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Nome Tipo Description
error

Error

Modelo de erro.

Details

Nome Tipo Description
code

string

Cadeia de caracteres padronizada para identificar programaticamente o erro.

message

string

Informações detalhadas de descrição e depuração de erro.

target

string

Informações detalhadas de descrição e depuração de erro.

EnterpriseGradeCdnStatus

Estado que indica o status da CDN de nível empresarial que fornece tráfego para o aplicativo Web estático.

Nome Tipo Description
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Error

Modelo de erro.

Nome Tipo Description
code

string

Cadeia de caracteres padronizada para identificar programaticamente o erro.

details

Details[]

Erros detalhados.

innererror

string

Mais informações para depurar o erro.

message

string

Informações detalhadas de descrição e depuração de erro.

target

string

Informações detalhadas de descrição e depuração de erro.

ErrorEntity

Corpo da resposta de erro retornada da API.

Nome Tipo Description
code

string

Código de erro básico.

details

ErrorEntity[]

Detalhes do erro.

extendedCode

string

Tipo de erro.

innerErrors

ErrorEntity[]

Erros internos.

message

string

Todos os detalhes do erro.

messageTemplate

string

Modelo de mensagem.

parameters

string[]

Parâmetros para o modelo.

target

string

O destino do erro.

ManagedServiceIdentity

Identidade de serviço gerenciada.

Nome Tipo Description
principalId

string

ID da entidade de segurança da identidade de serviço gerenciada.

tenantId

string

Locatário da identidade de serviço gerenciado.

type

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada.

userAssignedIdentities

<string,  userAssignedIdentity>

A lista de identidades atribuídas pelo usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada.

Nome Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateLinkConnectionState

O estado de uma conexão de link privado

Nome Tipo Description
actionsRequired

string

ActionsRequired para uma conexão de link privado

description

string

Descrição de uma conexão de link privado

status

string

Status de uma conexão de link privado

RemotePrivateEndpointConnection

Uma conexão de ponto de extremidade privado remoto

Nome Tipo Description
id

string

ID do recurso.

kind

string

Tipo de recurso.

name

string

Nome do recurso.

properties.ipAddresses

string[]

IP PrivadoAddresses mapeado para o ponto de extremidade privado remoto

properties.privateEndpoint

ArmIdWrapper

PrivateEndpoint de uma conexão de ponto de extremidade privado remoto

properties.privateLinkServiceConnectionState

PrivateLinkConnectionState

O estado de uma conexão de link privado

properties.provisioningState

string

type

string

Tipo de recurso.

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Envelope de mensagem que contém as propriedades comuns do gerenciador de recursos do Azure e o conteúdo específico do provedor de recursos.

Nome Tipo Description
error

ErrorEntity

Azure-AsyncOperation Informações de erro.

id

string

ID do recurso. Normalmente, a ID é preenchida somente para respostas a solicitações GET. O chamador é responsável por passar esse valor apenas para solicitações GET. Por exemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}

identity

ManagedServiceIdentity

Recurso MSI

location

string

O recurso de região geográfica pertence, por exemplo, SouthCentralUS, SouthEastAsia.

name

string

Nome do recurso.

plan

ArmPlan

Plano do Azure Resource Manager.

properties

RemotePrivateEndpointConnection

Propriedades específicas do recurso.

sku

SkuDescription

Descrição da SKU do recurso.

status

string

Azure-AsyncOperation Informações de status.

tags

object

Marcas associadas ao recurso.

type

string

Tipo de recurso, por exemplo, "Microsoft.Web/sites".

zones

string[]

Zonas de Disponibilidade lógica em que o serviço está hospedado

SkuCapacity

Descrição das opções de escala do plano Serviço de Aplicativo.

Nome Tipo Description
default

integer

Número padrão de trabalhos para esse SKU de plano de Serviço de Aplicativo.

elasticMaximum

integer

Número máximo de trabalhos elásticos para essa SKU de plano de Serviço de Aplicativo.

maximum

integer

Número máximo de trabalhos para essa SKU de plano de Serviço de Aplicativo.

minimum

integer

Número mínimo de trabalhadores para essa SKU de plano de Serviço de Aplicativo.

scaleType

string

Configurações de escala disponíveis para um plano de Serviço de Aplicativo.

SkuDescription

Descrição de um SKU para um recurso escalonável.

Nome Tipo Description
capabilities

Capability[]

Os recursos do SKU, por exemplo, estão habilitados para o gerenciador de tráfego?

capacity

integer

Número atual de instâncias atribuídas ao recurso.

family

string

Código da família do SKU do recurso.

locations

string[]

Locais do SKU.

name

string

Nome do SKU do recurso.

size

string

Especificador de tamanho do SKU do recurso.

skuCapacity

SkuCapacity

Valores de escala mínimos, máximos e padrão da SKU.

tier

string

Camada de serviço do SKU do recurso.

StagingEnvironmentPolicy

Estado que indica se os ambientes de preparo são permitidos ou não para um aplicativo Web estático.

Nome Tipo Description
Disabled

string

Enabled

string

StaticSiteARMResource

Recurso ARM do Site Estático.

Nome Tipo Description
id

string

ID do recurso.

identity

ManagedServiceIdentity

Identidade de serviço gerenciada.

kind

string

Tipo de recurso.

location

string

Local do recurso.

name

string

Nome do recurso.

properties.allowConfigFileUpdates

boolean

false se o arquivo de configuração estiver bloqueado para este aplicativo Web estático; caso contrário, true.

properties.branch

string

O branch de destino no repositório.

properties.buildProperties

StaticSiteBuildProperties

Compile propriedades para configurar no repositório.

properties.contentDistributionEndpoint

string

O ponto de extremidade de distribuição de conteúdo para o site estático.

properties.customDomains

string[]

Os domínios personalizados associados a este site estático.

properties.databaseConnections

DatabaseConnectionOverview[]

Conexões de banco de dados para o site estático

properties.defaultHostname

string

O nome do host gerado automaticamente padrão para o site estático.

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

Estado que indica o status da CDN de nível empresarial que fornece tráfego para o aplicativo Web estático.

properties.keyVaultReferenceIdentity

string

Identidade a ser usada para autenticação de referência Key Vault.

properties.linkedBackends

StaticSiteLinkedBackend[]

Back-ends vinculados ao lado estático

properties.privateEndpointConnections

ResponseMessageEnvelope[RemotePrivateEndpointConnection][]

Conexões de ponto de extremidade privado

properties.provider

string

O provedor que enviou a última implantação para o ambiente primário do site estático.

properties.publicNetworkAccess

string

Estado que indica se o tráfego público é permitido ou não para um aplicativo Web estático. Valores permitidos: 'Enabled', 'Disabled' ou uma cadeia de caracteres vazia.

properties.repositoryToken

string

Token do repositório github de um usuário. Isso é usado para configurar o arquivo de fluxo de trabalho do Github Actions e os segredos da API.

properties.repositoryUrl

string

URL para o repositório do site estático.

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

Estado que indica se os ambientes de preparo são permitidos ou não para um aplicativo Web estático.

properties.templateProperties

StaticSiteTemplateOptions

Opções de modelo para gerar um novo repositório.

properties.userProvidedFunctionApps

StaticSiteUserProvidedFunctionApp[]

Aplicativos de funções fornecidos pelo usuário registrados com o site estático

sku

SkuDescription

Descrição de um SKU para um recurso escalonável.

tags

object

Marcas de recurso.

type

string

Tipo de recurso.

StaticSiteBuildProperties

Propriedades de build para o site estático.

Nome Tipo Description
apiBuildCommand

string

Um comando personalizado a ser executado durante a implantação do aplicativo de API Azure Functions.

apiLocation

string

O caminho para o código de API dentro do repositório.

appArtifactLocation

string

Preterido: o caminho dos artefatos do aplicativo após a criação (preterido em favor de OutputLocation)

appBuildCommand

string

Um comando personalizado a ser executado durante a implantação do aplicativo de conteúdo estático.

appLocation

string

O caminho para o código do aplicativo dentro do repositório.

githubActionSecretNameOverride

string

Substituição do nome do segredo da Ação do Github.

outputLocation

string

O caminho de saída do aplicativo após a compilação.

skipGithubActionWorkflowGeneration

boolean

Ignore a geração de fluxo de trabalho do Github Action.

StaticSiteDatabaseConnectionConfigurationFileOverview

Um arquivo de configuração de conexão de banco de dados

Nome Tipo Description
contents

string

A codificação Base64 do conteúdo do arquivo.

fileName

string

O nome do arquivo de configuração.

type

string

O tipo de arquivo de configuração.

StaticSiteLinkedBackend

Recurso arm de back-end vinculado do site estático.

Nome Tipo Description
backendResourceId

string

A ID do recurso do back-end vinculado ao site estático

createdOn

string

A data e a hora em que o back-end foi vinculado ao site estático.

provisioningState

string

O estado de provisionamento do processo de vinculação.

region

string

A região do back-end vinculada ao site estático

StaticSitePatchResource

Recurso do ARM para um site estático ao aplicar patch

Nome Tipo Description
id

string

ID do recurso.

kind

string

Tipo de recurso.

name

string

Nome do recurso.

properties.allowConfigFileUpdates

boolean

false se o arquivo de configuração estiver bloqueado para este aplicativo Web estático; caso contrário, true.

properties.branch

string

O branch de destino no repositório.

properties.buildProperties

StaticSiteBuildProperties

Compile propriedades para configurar no repositório.

properties.contentDistributionEndpoint

string

O ponto de extremidade de distribuição de conteúdo para o site estático.

properties.customDomains

string[]

Os domínios personalizados associados a este site estático.

properties.databaseConnections

DatabaseConnectionOverview[]

Conexões de banco de dados para o site estático

properties.defaultHostname

string

O nome do host gerado automaticamente padrão para o site estático.

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

Estado que indica o status da CDN de nível empresarial que fornece tráfego para o aplicativo Web estático.

properties.keyVaultReferenceIdentity

string

Identidade a ser usada para autenticação de referência Key Vault.

properties.linkedBackends

StaticSiteLinkedBackend[]

Back-ends vinculados ao lado estático

properties.privateEndpointConnections

ResponseMessageEnvelope[RemotePrivateEndpointConnection][]

Conexões de ponto de extremidade privado

properties.provider

string

O provedor que enviou a última implantação para o ambiente primário do site estático.

properties.publicNetworkAccess

string

Estado que indica se o tráfego público é permitido ou não para um aplicativo Web estático. Valores permitidos: 'Habilitado', 'Desabilitado' ou uma cadeia de caracteres vazia.

properties.repositoryToken

string

Token do repositório github de um usuário. Isso é usado para configurar o arquivo de fluxo de trabalho do Github Actions e os segredos da API.

properties.repositoryUrl

string

URL para o repositório do site estático.

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

Estado que indica se os ambientes de preparo são permitidos ou não para um aplicativo Web estático.

properties.templateProperties

StaticSiteTemplateOptions

Opções de modelo para gerar um novo repositório.

properties.userProvidedFunctionApps

StaticSiteUserProvidedFunctionApp[]

Aplicativos de funções fornecidos pelo usuário registrados com o site estático

type

string

Tipo de recurso.

StaticSiteTemplateOptions

Opções de modelo para o site estático.

Nome Tipo Description
description

string

Descrição do repositório recém-gerado.

isPrivate

boolean

Se o repositório recém-gerado é ou não um repositório privado. O padrão é false (ou seja, público).

owner

string

Proprietário do repositório recém-gerado.

repositoryName

string

Nome do repositório recém-gerado.

templateRepositoryUrl

string

URL do repositório de modelos. O repositório recém-gerado será baseado neste.

StaticSiteUserProvidedFunctionApp

Uma função fornecida pelo usuário do site estático.

Nome Tipo Description
id

string

ID do recurso.

kind

string

Tipo de recurso.

name

string

Nome do recurso.

properties.createdOn

string

A data e a hora em que o aplicativo de funções foi registrado com o site estático.

properties.functionAppRegion

string

A região do aplicativo de funções registrada com o site estático

properties.functionAppResourceId

string

A ID do recurso do aplicativo de funções registrado com o site estático

type

string

Tipo de recurso.

userAssignedIdentity

Identidade atribuída pelo usuário.

Nome Tipo Description
clientId

string

ID do cliente da identidade atribuída pelo usuário

principalId

string

ID da entidade de segurança da identidade atribuída pelo usuário