Share via

Microsoft.Web staticSites 2021-02-01

  • Статья

Определение ресурса Bicep

Тип ресурса staticSites можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Web/staticSites, добавьте в шаблон следующий код Bicep.

resource symbolicname 'Microsoft.Web/staticSites@2021-02-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capabilities: [
      {
        name: 'string'
        reason: 'string'
        value: 'string'
      }
    ]
    capacity: int
    family: 'string'
    locations: [
      'string'
    ]
    name: 'string'
    size: 'string'
    skuCapacity: {
      default: int
      elasticMaximum: int
      maximum: int
      minimum: int
      scaleType: 'string'
    }
    tier: 'string'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    allowConfigFileUpdates: bool
    branch: 'string'
    buildProperties: {
      apiBuildCommand: 'string'
      apiLocation: 'string'
      appArtifactLocation: 'string'
      appBuildCommand: 'string'
      appLocation: 'string'
      githubActionSecretNameOverride: 'string'
      outputLocation: 'string'
      skipGithubActionWorkflowGeneration: bool
    }
    repositoryToken: 'string'
    repositoryUrl: 'string'
    stagingEnvironmentPolicy: 'string'
    templateProperties: {
      description: 'string'
      isPrivate: bool
      owner: 'string'
      repositoryName: 'string'
      templateRepositoryUrl: 'string'
    }
  }
}

Значения свойств

staticSites

Имя Описание Значение
name имя ресурса. строка (обязательно)
location Расположение ресурса. строка (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Описание номера SKU для масштабируемого ресурса. SkuDescription
kind Тип ресурса. строка
удостоверение Управляемое удостоверение службы. Управляемое удостоверение службы
properties Основные свойства ресурса StaticSite

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

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

StaticSite

Имя Описание Значение
allowConfigFileUpdates false Значение , если файл конфигурации заблокирован для этого статического веб-приложения; в противном случае — true. bool
ветвь Целевая ветвь в репозитории. строка
Свойства сборки Свойства сборки для настройки в репозитории. StaticSiteBuildProperties
repositoryToken Маркер репозитория GitHub пользователя. Используется для настройки файла рабочего процесса Github Actions и секретов API. строка
repositoryUrl URL-адрес репозитория статического сайта. строка
stagingEnvironmentPolicy Состояние, указывающее, разрешены ли промежуточные среды для статического веб-приложения. "Отключено"
"Включено"
TemplateProperties Параметры шаблона для создания нового репозитория. StaticSiteTemplateOptions

StaticSiteBuildProperties

Имя Описание Значение
apiBuildCommand Пользовательская команда, выполняемая во время развертывания приложения API Функции Azure. строка
apiLocation Путь к коду API в репозитории. строка
appArtifactLocation Не рекомендуется: путь к артефактам приложения после сборки (не рекомендуется использовать OutputLocation) строка
appBuildCommand Пользовательская команда, выполняемая во время развертывания приложения статического содержимого. строка
appLocation Путь к коду приложения в репозитории. строка
githubActionSecretNameOverride Переопределение имени секрета действия GitHub. строка
outputLocation Выходной путь приложения после сборки. строка
skipGithubActionWorkflowGeneration Пропустите создание рабочего процесса Github Action. bool

StaticSiteTemplateOptions

Имя Описание Значение
description Описание созданного репозитория. строка
isPrivate Указывает, является ли созданный репозиторий частным. Значение по умолчанию — false (т. е. public). bool
владелец Владелец созданного репозитория. строка
repositoryName Имя созданного репозитория. строка
templateRepositoryUrl URL-адрес репозитория шаблонов. Созданный репозиторий будет основан на этом. строка

SkuDescription

Имя Описание Значение
capabilities Возможности номера SKU, например включен ли диспетчер трафика? Возможность[]
Емкость Текущее число экземпляров, назначенных ресурсу. INT
family Семейный код SKU ресурса. строка
Расположения Расположения номера SKU. string[]
name Имя SKU ресурса. строка
размер; Описатель размера SKU ресурса. строка
skuCapacity Минимальное, максимальное и стандартное значения масштабирования номера SKU. SkuCapacity
Уровень Уровень служб SKU ресурса. строка

Функция

Имя Описание Значение
name Имя возможности SKU. строка
reason Причина возможности SKU. строка
value Значение возможности SKU. строка

SkuCapacity

Имя Описание Значение
default Число рабочих ролей по умолчанию для этого Служба приложений SKU плана. INT
elasticMaximum Максимальное количество эластичных рабочих ролей для этого номера SKU плана Служба приложений. INT
maximum Максимальное число рабочих ролей для этого Служба приложений SKU плана. INT
minimum Минимальное количество рабочих ролей для этого Служба приложений SKU плана. INT
scaleType Доступные конфигурации масштабирования для плана Служба приложений. строка

Определение ресурса шаблона ARM

Тип ресурса staticSites можно развернуть с помощью операций, предназначенных для:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Web/staticSites, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Web/staticSites",
  "apiVersion": "2021-02-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capabilities": [
      {
        "name": "string",
        "reason": "string",
        "value": "string"
      }
    ],
    "capacity": "int",
    "family": "string",
    "locations": [ "string" ],
    "name": "string",
    "size": "string",
    "skuCapacity": {
      "default": "int",
      "elasticMaximum": "int",
      "maximum": "int",
      "minimum": "int",
      "scaleType": "string"
    },
    "tier": "string"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "allowConfigFileUpdates": "bool",
    "branch": "string",
    "buildProperties": {
      "apiBuildCommand": "string",
      "apiLocation": "string",
      "appArtifactLocation": "string",
      "appBuildCommand": "string",
      "appLocation": "string",
      "githubActionSecretNameOverride": "string",
      "outputLocation": "string",
      "skipGithubActionWorkflowGeneration": "bool"
    },
    "repositoryToken": "string",
    "repositoryUrl": "string",
    "stagingEnvironmentPolicy": "string",
    "templateProperties": {
      "description": "string",
      "isPrivate": "bool",
      "owner": "string",
      "repositoryName": "string",
      "templateRepositoryUrl": "string"
    }
  }
}

Значения свойств

staticSites

Имя Описание Значение
тип Тип ресурса Microsoft.Web/staticSites
версия_API Версия API ресурсов '2021-02-01'
name имя ресурса. string (обязательно)
location Расположение ресурса. string (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов. См . раздел Теги в шаблонах
sku Описание номера SKU для масштабируемого ресурса. SkuDescription
kind Тип ресурса. строка
удостоверение Управляемое удостоверение службы. Управляемое удостоверение службы
properties Основные свойства ресурса StaticSite

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

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

StaticSite

Имя Описание Значение
allowConfigFileUpdates false Значение , если файл конфигурации заблокирован для этого статического веб-приложения; в противном случае — true. bool
ветвь Целевая ветвь в репозитории. строка
Свойства сборки Создайте свойства для настройки в репозитории. StaticSiteBuildProperties
repositoryToken Маркер репозитория GitHub пользователя. Он используется для настройки файла рабочего процесса Github Actions и секретов API. строка
repositoryUrl URL-адрес репозитория статического сайта. строка
stagingEnvironmentPolicy Состояние, указывающее, разрешены ли промежуточные среды для статического веб-приложения. "Отключено"
"Включено"
свойства templateProperties Параметры шаблона для создания нового репозитория. StaticSiteTemplateOptions

StaticSiteBuildProperties

Имя Описание Значение
apiBuildCommand Пользовательская команда, выполняемая во время развертывания приложения API Функции Azure. строка
apiLocation Путь к коду API в репозитории. строка
appArtifactLocation Не рекомендуется: путь к артефактам приложения после сборки (не рекомендуется использовать OutputLocation). строка
appBuildCommand Пользовательская команда, выполняемая во время развертывания приложения статического содержимого. строка
appLocation Путь к коду приложения в репозитории. строка
githubActionSecretNameOverride Переопределение имени секрета действия GitHub. строка
outputLocation Выходной путь приложения после сборки. строка
skipGithubActionWorkflowGeneration Пропустите создание рабочего процесса Github Action. bool

StaticSiteTemplateOptions

Имя Описание Значение
description Описание созданного репозитория. строка
isPrivate Является ли созданный репозиторий частным. По умолчанию имеет значение false (т. е. public). bool
владелец Владелец созданного репозитория. строка
repositoryName Имя созданного репозитория. строка
templateRepositoryUrl URL-адрес репозитория шаблонов. Созданный репозиторий будет основан на этом. строка

SkuDescription

Имя Описание Значение
capabilities Возможности номера SKU, например включен ли диспетчер трафика? Возможность[]
Емкость Текущее число экземпляров, назначенных ресурсу. INT
family Семейный код SKU ресурса. строка
Расположения Расположения номера SKU. string[]
name Имя SKU ресурса. строка
размер; Описатель размера номера SKU ресурса. строка
skuCapacity Минимальное, максимальное и стандартное значения масштабирования номера SKU. SkuCapacity
Уровень Уровень служб SKU ресурса. строка

Функция

Имя Описание Значение
name Имя возможности SKU. строка
reason Причина возможности SKU. строка
value Значение возможности номера SKU. строка

SkuCapacity

Имя Описание Значение
default Число рабочих ролей по умолчанию для этого номера SKU плана Служба приложений. INT
elasticMaximum Максимальное число рабочих ролей Elastic для этого номера SKU плана Служба приложений. INT
maximum Максимальное число рабочих ролей для этого номера SKU плана Служба приложений. INT
minimum Минимальное количество рабочих ролей для этого номера SKU плана Служба приложений. INT
scaleType Доступные конфигурации масштабирования для плана Служба приложений. строка

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса staticSites можно развернуть с помощью операций, предназначенных для:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.Web/staticSites, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/staticSites@2021-02-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      allowConfigFileUpdates = bool
      branch = "string"
      buildProperties = {
        apiBuildCommand = "string"
        apiLocation = "string"
        appArtifactLocation = "string"
        appBuildCommand = "string"
        appLocation = "string"
        githubActionSecretNameOverride = "string"
        outputLocation = "string"
        skipGithubActionWorkflowGeneration = bool
      }
      repositoryToken = "string"
      repositoryUrl = "string"
      stagingEnvironmentPolicy = "string"
      templateProperties = {
        description = "string"
        isPrivate = bool
        owner = "string"
        repositoryName = "string"
        templateRepositoryUrl = "string"
      }
    }
    sku = {
      capabilities = [
        {
          name = "string"
          reason = "string"
          value = "string"
        }
      ]
      capacity = int
      family = "string"
      locations = [
        "string"
      ]
      name = "string"
      size = "string"
      skuCapacity = {
        default = int
        elasticMaximum = int
        maximum = int
        minimum = int
        scaleType = "string"
      }
      tier = "string"
    }
    kind = "string"
  })
}

Значения свойств

staticSites

Имя Описание Значение
тип Тип ресурса "Microsoft.Web/staticSites@2021-02-01"
name имя ресурса. строка (обязательно)
location Расположение ресурса. строка (обязательно)
parent_id Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
tags Теги ресурсов. Словарь имен и значений тегов.
sku Описание номера SKU для масштабируемого ресурса. SkuDescription
kind Тип ресурса. строка
удостоверение Управляемое удостоверение службы. Управляемое удостоверение службы
properties Основные свойства ресурса StaticSite

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

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

StaticSite

Имя Описание Значение
allowConfigFileUpdates false Значение , если файл конфигурации заблокирован для этого статического веб-приложения; в противном случае — true. bool
ветвь Целевая ветвь в репозитории. строка
Свойства сборки Свойства сборки для настройки в репозитории. StaticSiteBuildProperties
repositoryToken Маркер репозитория GitHub пользователя. Используется для настройки файла рабочего процесса Github Actions и секретов API. строка
repositoryUrl URL-адрес репозитория статического сайта. строка
stagingEnvironmentPolicy Состояние, указывающее, разрешены ли промежуточные среды для статического веб-приложения. "Отключено"
"Включено"
TemplateProperties Параметры шаблона для создания нового репозитория. StaticSiteTemplateOptions

StaticSiteBuildProperties

Имя Описание Значение
apiBuildCommand Пользовательская команда, выполняемая во время развертывания приложения API Функции Azure. строка
apiLocation Путь к коду API в репозитории. строка
appArtifactLocation Не рекомендуется: путь к артефактам приложения после сборки (не рекомендуется использовать OutputLocation) строка
appBuildCommand Пользовательская команда, выполняемая во время развертывания приложения статического содержимого. строка
appLocation Путь к коду приложения в репозитории. строка
githubActionSecretNameOverride Переопределение имени секрета Github Action. строка
outputLocation Выходной путь приложения после сборки. строка
skipGithubActionWorkflowGeneration Пропустите создание рабочего процесса Github Action. bool

StaticSiteTemplateOptions

Имя Описание Значение
description Описание созданного репозитория. строка
isPrivate Является ли созданный репозиторий частным. По умолчанию имеет значение false (т. е. public). bool
владелец Владелец созданного репозитория. строка
repositoryName Имя созданного репозитория. строка
templateRepositoryUrl URL-адрес репозитория шаблонов. Созданный репозиторий будет основан на этом. строка

SkuDescription

Имя Описание Значение
capabilities Возможности номера SKU, например включен ли диспетчер трафика? Возможность[]
Емкость Текущее число экземпляров, назначенных ресурсу. INT
family Семейный код SKU ресурса. строка
Расположения Расположения номера SKU. string[]
name Имя SKU ресурса. строка
размер; Описатель размера номера SKU ресурса. строка
skuCapacity Минимальное, максимальное и стандартное значения масштабирования номера SKU. SkuCapacity
Уровень Уровень служб SKU ресурса. строка

Функция

Имя Описание Значение
name Имя возможности SKU. строка
reason Причина возможности SKU. строка
value Значение возможности номера SKU. строка

SkuCapacity

Имя Описание Значение
default Число рабочих ролей по умолчанию для этого номера SKU плана Служба приложений. INT
elasticMaximum Максимальное число рабочих ролей Elastic для этого номера SKU плана Служба приложений. INT
maximum Максимальное число рабочих ролей для этого номера SKU плана Служба приложений. INT
minimum Минимальное количество рабочих ролей для этого номера SKU плана Служба приложений. INT
scaleType Доступные конфигурации масштабирования для плана Служба приложений. строка