Поделиться через


Static Sites - Create Or Update Static Site

Описание для параметра Создание нового статического сайта в существующей группе ресурсов или обновление существующего статического сайта.

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

Параметры URI

Имя В Обязательно Тип Описание
name
path True

string

Имя создаваемого или обновляемого статического сайта.

resourceGroupName
path True

string

Имя группы ресурсов, к которой принадлежит ресурс.

Шаблон регулярного выражения: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Идентификатор вашей подписки Azure. Это строка в формате GUID (например, 000000000-0000-0000-0000-000000000000000000000).

api-version
query True

string

Версия API

Текст запроса

Имя Обязательно Тип Описание
location True

string

Расположение ресурса.

identity

ManagedServiceIdentity

Управляемое удостоверение службы.

kind

string

Тип ресурса.

properties.allowConfigFileUpdates

boolean

false Значение , если файл конфигурации заблокирован для этого статического веб-приложения; в противном случае — true.

properties.branch

string

Целевая ветвь в репозитории.

properties.buildProperties

StaticSiteBuildProperties

Свойства сборки для настройки в репозитории.

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

Состояние, указывающее состояние СЕТИ CDN корпоративного уровня, обслуживающей трафик в статическое веб-приложение.

properties.provider

string

Поставщик, отправив последнее развертывание в основную среду статического сайта.

properties.publicNetworkAccess

string

Состояние, указывающее, разрешен ли общедоступный трафик для статического веб-приложения. Допустимые значения: Enabled, Disabled или пустая строка.

properties.repositoryToken

string

Маркер репозитория GitHub пользователя. Используется для настройки файла рабочего процесса Github Actions и секретов API.

properties.repositoryUrl

string

URL-адрес репозитория статического сайта.

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

Состояние, указывающее, разрешены ли промежуточные среды для статического веб-приложения.

properties.templateProperties

StaticSiteTemplateOptions

Параметры шаблона для создания нового репозитория.

sku

SkuDescription

Описание номера SKU для масштабируемого ресурса.

tags

object

Теги ресурсов.

Ответы

Имя Тип Описание
200 OK

StaticSiteARMResource

Все в порядке.

202 Accepted

StaticSiteARMResource

Выполняется асинхронная операция.

Other Status Codes

DefaultErrorResponse

Служба приложений ответ об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Create or update a static site

Образец запроса

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"
  }
}

Пример ответа

{
  "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"
  }
}

Определения

Имя Описание
ArmIdWrapper

Оболочка для идентификатора ресурса ARM

ArmPlan

Объект plan в Azure Resource Manager представляет план Marketplace.

Capability

Описание возможностей и функций, разрешенных для определенного номера SKU.

DatabaseConnectionOverview

Общие сведения о подключении к базе данных статического сайта.

DefaultErrorResponse

Служба приложений ответ об ошибке.

Details
EnterpriseGradeCdnStatus

Состояние, указывающее состояние СЕТИ CDN корпоративного уровня, обслуживающей трафик в статическое веб-приложение.

Error

Модель ошибок.

ErrorEntity

Текст ответа об ошибке, возвращенного API.

ManagedServiceIdentity

Управляемое удостоверение службы.

ManagedServiceIdentityType

Тип удостоверения управляемой службы.

PrivateLinkConnectionState

Состояние подключения к приватному каналу

RemotePrivateEndpointConnection

Подключение к удаленной частной конечной точке

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Конверт сообщения, содержащий общие свойства Azure Resource Manager и содержимое конкретного поставщика ресурсов.

SkuCapacity

Описание параметров масштабирования плана Служба приложений.

SkuDescription

Описание номера SKU для масштабируемого ресурса.

StagingEnvironmentPolicy

Состояние, указывающее, разрешены ли промежуточные среды для статического веб-приложения.

StaticSiteARMResource

Ресурс ARM статического сайта.

StaticSiteBuildProperties

Свойства сборки для статического сайта.

StaticSiteDatabaseConnectionConfigurationFileOverview

Файл конфигурации подключения к базе данных

StaticSiteLinkedBackend

Ресурс ARM для связанной серверной части статического сайта.

StaticSiteTemplateOptions

Параметры шаблона для статического сайта.

StaticSiteUserProvidedFunctionApp

Функция, предоставленная пользователем статического сайта.

userAssignedIdentity

Удостоверение, назначаемое пользователем.

ArmIdWrapper

Оболочка для идентификатора ресурса ARM

Имя Тип Описание
id

string

ArmPlan

Объект plan в Azure Resource Manager представляет план Marketplace.

Имя Тип Описание
name

string

Имя.

product

string

Продукт.

promotionCode

string

Промокод.

publisher

string

Издатель.

version

string

Версия продукта.

Capability

Описание возможностей и функций, разрешенных для определенного номера SKU.

Имя Тип Описание
name

string

Имя возможности SKU.

reason

string

Причина возможности SKU.

value

string

Значение возможности номера SKU.

DatabaseConnectionOverview

Общие сведения о подключении к базе данных статического сайта.

Имя Тип Описание
configurationFiles

StaticSiteDatabaseConnectionConfigurationFileOverview[]

Список файлов конфигурации, связанных с этим подключением к базе данных.

connectionIdentity

string

При наличии удостоверение используется вместе с строка подключения для подключения к базе данных. Использование управляемого удостоверения, назначаемого системой, обозначается строкой SystemAssigned, а использование управляемого удостоверения, назначаемого пользователем, — идентификатором ресурса управляемого удостоверения.

name

string

При наличии — имя этого ресурса подключения к базе данных.

region

string

Регион ресурса базы данных.

resourceId

string

Идентификатор ресурса базы данных.

DefaultErrorResponse

Служба приложений ответ об ошибке.

Имя Тип Описание
error

Error

Модель ошибок.

Details

Имя Тип Описание
code

string

Стандартизированная строка для программного определения ошибки.

message

string

Подробное описание ошибки и сведения об отладке.

target

string

Подробное описание ошибки и сведения об отладке.

EnterpriseGradeCdnStatus

Состояние, указывающее состояние СЕТИ CDN корпоративного уровня, обслуживающей трафик в статическое веб-приложение.

Имя Тип Описание
Disabled

string

Disabling

string

Enabled

string

Enabling

string

Error

Модель ошибок.

Имя Тип Описание
code

string

Стандартизированная строка для программного определения ошибки.

details

Details[]

Подробные сведения об ошибках.

innererror

string

Дополнительные сведения об ошибке отладки.

message

string

Подробное описание ошибки и сведения об отладке.

target

string

Подробное описание ошибки и сведения об отладке.

ErrorEntity

Текст ответа об ошибке, возвращенного API.

Имя Тип Описание
code

string

Базовый код ошибки.

details

ErrorEntity[]

Сведения об ошибке.

extendedCode

string

Тип ошибки.

innerErrors

ErrorEntity[]

Внутренние ошибки.

message

string

Все сведения об ошибке.

messageTemplate

string

Шаблон сообщения.

parameters

string[]

Параметры шаблона.

target

string

Целевой объект ошибки.

ManagedServiceIdentity

Управляемое удостоверение службы.

Имя Тип Описание
principalId

string

Идентификатор субъекта управляемого удостоверения службы.

tenantId

string

Клиент управляемого удостоверения службы.

type

ManagedServiceIdentityType

Тип удостоверения управляемой службы.

userAssignedIdentities

<string,  userAssignedIdentity>

Список назначенных пользователем удостоверений, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Тип удостоверения управляемой службы.

Имя Тип Описание
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateLinkConnectionState

Состояние подключения к приватному каналу

Имя Тип Описание
actionsRequired

string

ActionsRequired for a private link connection (Запрос на подключение к приватному каналу)

description

string

Описание подключения по приватному каналу

status

string

Состояние подключения к приватному каналу

RemotePrivateEndpointConnection

Подключение к удаленной частной конечной точке

Имя Тип Описание
id

string

Идентификатор ресурса.

kind

string

Тип ресурса.

name

string

Имя ресурса.

properties.ipAddresses

string[]

Частные IPAddresses, сопоставленные с удаленной частной конечной точкой

properties.privateEndpoint

ArmIdWrapper

PrivateEndpoint подключения к удаленной частной конечной точке

properties.privateLinkServiceConnectionState

PrivateLinkConnectionState

Состояние подключения к приватному каналу

properties.provisioningState

string

type

string

Тип ресурса.

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Конверт сообщения, содержащий общие свойства Azure Resource Manager и содержимое конкретного поставщика ресурсов.

Имя Тип Описание
error

ErrorEntity

Azure-AsyncOperation сведения об ошибке.

id

string

Идентификатор ресурса. Обычно идентификатор заполняется только для ответов на запросы GET. Вызывающий объект отвечает за передачу этого значения только для запросов GET. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}

identity

ManagedServiceIdentity

Ресурс MSI

location

string

Ресурс географического региона принадлежит, например, SouthCentralUS, SouthEastAsia.

name

string

Имя ресурса.

plan

ArmPlan

План Azure Resource Manager.

properties

RemotePrivateEndpointConnection

Свойства, относящиеся к ресурсу.

sku

SkuDescription

Описание SKU ресурса.

status

string

Azure-AsyncOperation сведения о состоянии.

tags

object

Теги, связанные с ресурсом.

type

string

Тип ресурса, например Microsoft.Web/sites.

zones

string[]

Логическое Зоны доступности, в котором размещена служба

SkuCapacity

Описание параметров масштабирования плана Служба приложений.

Имя Тип Описание
default

integer

Число рабочих ролей по умолчанию для этого номера SKU плана Служба приложений.

elasticMaximum

integer

Максимальное число рабочих ролей Elastic для этого номера SKU плана Служба приложений.

maximum

integer

Максимальное число рабочих ролей для этого номера SKU плана Служба приложений.

minimum

integer

Минимальное количество рабочих ролей для этого номера SKU плана Служба приложений.

scaleType

string

Доступные конфигурации масштабирования для плана Служба приложений.

SkuDescription

Описание номера SKU для масштабируемого ресурса.

Имя Тип Описание
capabilities

Capability[]

Возможности номера SKU, например включен ли диспетчер трафика?

capacity

integer

Текущее число экземпляров, назначенных ресурсу.

family

string

Семейный код SKU ресурса.

locations

string[]

Расположения номера SKU.

name

string

Имя SKU ресурса.

size

string

Описатель размера SKU ресурса.

skuCapacity

SkuCapacity

Минимальное, максимальное и стандартное значения масштабирования номера SKU.

tier

string

Уровень служб SKU ресурса.

StagingEnvironmentPolicy

Состояние, указывающее, разрешены ли промежуточные среды для статического веб-приложения.

Имя Тип Описание
Disabled

string

Enabled

string

StaticSiteARMResource

Ресурс ARM статического сайта.

Имя Тип Описание
id

string

Идентификатор ресурса.

identity

ManagedServiceIdentity

Управляемое удостоверение службы.

kind

string

Тип ресурса.

location

string

Расположение ресурса.

name

string

Имя ресурса.

properties.allowConfigFileUpdates

boolean

false Значение , если файл конфигурации заблокирован для этого статического веб-приложения; в противном случае — true.

properties.branch

string

Целевая ветвь в репозитории.

properties.buildProperties

StaticSiteBuildProperties

Создайте свойства для настройки в репозитории.

properties.contentDistributionEndpoint

string

Конечная точка распространения содержимого для статического сайта.

properties.customDomains

string[]

Личные домены, связанные с этим статическим сайтом.

properties.databaseConnections

DatabaseConnectionOverview[]

Подключения к базе данных для статического сайта

properties.defaultHostname

string

Автоматически созданное имя узла по умолчанию для статического сайта.

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

Состояние, указывающее состояние сети CDN корпоративного класса, от которой передается трафик в статическое веб-приложение.

properties.keyVaultReferenceIdentity

string

Удостоверение, используемое для Key Vault эталонной проверки подлинности.

properties.linkedBackends

StaticSiteLinkedBackend[]

Серверные части, связанные со статической стороной

properties.privateEndpointConnections

ResponseMessageEnvelope[RemotePrivateEndpointConnection][]

Подключения частных конечных точек

properties.provider

string

Поставщик, отправив последнее развертывание в основную среду статического сайта.

properties.publicNetworkAccess

string

Состояние, указывающее, разрешен ли общедоступный трафик для статического веб-приложения. Допустимые значения: Enabled, Disabled или пустая строка.

properties.repositoryToken

string

Маркер репозитория GitHub пользователя. Он используется для настройки файла рабочего процесса Github Actions и секретов API.

properties.repositoryUrl

string

URL-адрес репозитория статического сайта.

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

Состояние, указывающее, разрешены ли промежуточные среды для статического веб-приложения.

properties.templateProperties

StaticSiteTemplateOptions

Параметры шаблона для создания нового репозитория.

properties.userProvidedFunctionApps

StaticSiteUserProvidedFunctionApp[]

Предоставленные пользователем приложения-функции, зарегистрированные на статическом сайте

sku

SkuDescription

Описание номера SKU для масштабируемого ресурса.

tags

object

Теги ресурсов.

type

string

Тип ресурса.

StaticSiteBuildProperties

Свойства сборки для статического сайта.

Имя Тип Описание
apiBuildCommand

string

Пользовательская команда, выполняемая во время развертывания приложения API Функции Azure.

apiLocation

string

Путь к коду API в репозитории.

appArtifactLocation

string

Не рекомендуется: путь к артефактам приложения после сборки (не рекомендуется использовать OutputLocation).

appBuildCommand

string

Пользовательская команда, выполняемая во время развертывания приложения статического содержимого.

appLocation

string

Путь к коду приложения в репозитории.

githubActionSecretNameOverride

string

Переопределение имени секрета действия GitHub.

outputLocation

string

Выходной путь приложения после сборки.

skipGithubActionWorkflowGeneration

boolean

Пропустите создание рабочего процесса Github Action.

StaticSiteDatabaseConnectionConfigurationFileOverview

Файл конфигурации подключения к базе данных

Имя Тип Описание
contents

string

Кодировка Base64 содержимого файла.

fileName

string

Имя файла конфигурации.

type

string

Тип файла конфигурации.

StaticSiteLinkedBackend

Ресурс ARM для связанной серверной части статического сайта.

Имя Тип Описание
backendResourceId

string

Идентификатор ресурса серверной части, связанной со статическим сайтом

createdOn

string

Дата и время связывания серверной части со статическим сайтом.

provisioningState

string

Состояние подготовки процесса связывания.

region

string

Область серверной части, связанной со статическим сайтом

StaticSiteTemplateOptions

Параметры шаблона для статического сайта.

Имя Тип Описание
description

string

Описание созданного репозитория.

isPrivate

boolean

Указывает, является ли созданный репозиторий частным. Значение по умолчанию — false (т. е. public).

owner

string

Владелец созданного репозитория.

repositoryName

string

Имя созданного репозитория.

templateRepositoryUrl

string

URL-адрес репозитория шаблонов. Созданный репозиторий будет основан на этом.

StaticSiteUserProvidedFunctionApp

Функция, предоставленная пользователем статического сайта.

Имя Тип Описание
id

string

Идентификатор ресурса.

kind

string

Тип ресурса.

name

string

Имя ресурса.

properties.createdOn

string

Дата и время регистрации приложения-функции на статичном сайте.

properties.functionAppRegion

string

Регион приложения-функции, зарегистрированного на статическом сайте

properties.functionAppResourceId

string

Идентификатор ресурса приложения-функции, зарегистрированного на статическом сайте

type

string

Тип ресурса.

userAssignedIdentity

Удостоверение, назначаемое пользователем.

Имя Тип Описание
clientId

string

Идентификатор клиента удостоверения, назначаемого пользователем

principalId

string

Идентификатор субъекта удостоверения, назначаемого пользователем