Microsoft.Web staticSites 2022-09-01

Bicep リソース定義

staticSites リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Web/staticSites リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Web/staticSites@2022-09-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
    }
    enterpriseGradeCdnStatus: 'string'
    provider: 'string'
    publicNetworkAccess: 'string'
    repositoryToken: 'string'
    repositoryUrl: 'string'
    stagingEnvironmentPolicy: 'string'
    templateProperties: {
      description: 'string'
      isPrivate: bool
      owner: 'string'
      repositoryName: 'string'
      templateRepositoryUrl: 'string'
    }
  }
}

プロパティ値

staticSites

名前 説明
name リソース名 string (必須)
location リソースの場所。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku スケーラブルなリソースの SKU の説明。 SkuDescription
kind リソースの種類。 string
identity マネージド サービス ID。 ManagedServiceIdentity
properties コア リソースのプロパティ StaticSite

ManagedServiceIdentity

名前 説明
type マネージド サービス ID の種類。 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 object

StaticSite

名前 説明
allowConfigFileUpdates false この静的 Web アプリに対して構成ファイルがロックされている場合。それ以外の場合は true [bool]
分岐 リポジトリ内のターゲット ブランチ。 string
buildProperties リポジトリで構成するプロパティをビルドします。 StaticSiteBuildProperties
enterpriseGradeCdnStatus 静的 Web アプリへのトラフィックを提供するエンタープライズ グレードの CDN の状態を示す状態。 'Disabled'
'無効化'
'Enabled'
'有効化中'
provider 静的サイトのプライマリ環境に最後の展開を送信したプロバイダー。 string
publicNetworkAccess 静的 Web アプリに対してパブリック トラフィックが許可されているかどうかを示す状態。 使用できる値: 'Enabled'、'Disabled'、または空の文字列。 string
repositoryToken ユーザーの github リポジトリ トークン。 これは、Github Actions ワークフロー ファイルと API シークレットを設定するために使用されます。 string
repositoryUrl 静的サイトのリポジトリの URL。 string
stagingEnvironmentPolicy ステージング環境が静的 Web アプリに対して許可されているかどうかを示す状態。 'Disabled'
'Enabled'
templateProperties 新しいリポジトリを生成するためのテンプレート オプション。 StaticSiteTemplateOptions

StaticSiteBuildProperties

名前 説明
apiBuildCommand Azure Functions API アプリケーションのデプロイ中に実行するカスタム コマンド。 string
apiLocation リポジトリ内の API コードへのパス。 string
appArtifactLocation 非推奨: ビルド後のアプリ成果物のパス (OutputLocation を優先して非推奨) string
appBuildCommand 静的コンテンツ アプリケーションのデプロイ中に実行するカスタム コマンド。 string
appLocation リポジトリ内のアプリ コードへのパス。 string
githubActionSecretNameOverride Github Action シークレット名のオーバーライド。 string
outputLocation ビルド後のアプリの出力パス。 string
skipGithubActionWorkflowGeneration Github Action ワークフローの生成をスキップします。 [bool]

StaticSiteTemplateOptions

名前 説明
description 新しく生成されたリポジトリの説明。 string
isPrivate 新しく生成されたリポジトリがプライベート リポジトリであるかどうか。 既定値は false (つまり public) です。 [bool]
owner 新しく生成されたリポジトリの所有者。 string
repositoryName 新しく生成されたリポジトリの名前。 string
templateRepositoryUrl テンプレート リポジトリの URL。 新しく生成されたリポジトリは、このリポジトリに基づいています。 string

SkuDescription

名前 説明
capabilities SKU の機能 (たとえば、トラフィック マネージャーは有効ですか? Capability[]
capacity リソースに割り当てられているインスタンスの現在の数。 INT
family リソース SKU のファミリ コード。 string
locations SKU の場所。 string[]
name リソース SKU の名前。 string
size リソース SKU のサイズ指定子。 string
skuCapacity SKU の最小、最大、および既定のスケール値。 SkuCapacity
レベル リソース SKU のサービス レベル。 string

機能

名前 説明
name SKU 機能の名前。 string
reason SKU 機能の理由。 string
value SKU 機能の値。 string

SkuCapacity

名前 説明
default このApp Serviceプラン SKU の既定のワーカー数。 INT
elasticMaximum このApp Serviceプラン SKU の Elastic worker の最大数。 INT
maximum このApp Serviceプラン SKU のワーカーの最大数。 INT
minimum このApp Serviceプラン SKU の最小ワーカー数。 INT
scaleType App Service プランで使用できるスケール構成。 string

ARM テンプレート リソース定義

staticSites リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Web/staticSites リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Web/staticSites",
  "apiVersion": "2022-09-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"
    },
    "enterpriseGradeCdnStatus": "string",
    "provider": "string",
    "publicNetworkAccess": "string",
    "repositoryToken": "string",
    "repositoryUrl": "string",
    "stagingEnvironmentPolicy": "string",
    "templateProperties": {
      "description": "string",
      "isPrivate": "bool",
      "owner": "string",
      "repositoryName": "string",
      "templateRepositoryUrl": "string"
    }
  }
}

プロパティ値

staticSites

名前 説明
type リソースの種類 'Microsoft.Web/staticSites'
apiVersion リソース API のバージョン '2022-09-01'
name リソース名 string (必須)
location リソースの場所。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku スケーラブルなリソースの SKU の説明。 SkuDescription
kind リソースの種類。 string
identity マネージド サービス ID。 ManagedServiceIdentity
properties コア リソースのプロパティ StaticSite

ManagedServiceIdentity

名前 説明
type マネージド サービス ID の種類。 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 object

StaticSite

名前 説明
allowConfigFileUpdates false この静的 Web アプリに対して構成ファイルがロックされている場合。それ以外の場合は true [bool]
分岐 リポジトリ内のターゲット ブランチ。 string
buildProperties リポジトリで構成するプロパティをビルドします。 StaticSiteBuildProperties
enterpriseGradeCdnStatus 静的 Web アプリへのトラフィックを提供するエンタープライズ グレードの CDN の状態を示す状態。 'Disabled'
'無効化'
'Enabled'
'有効化中'
provider 静的サイトのプライマリ環境に最後の展開を送信したプロバイダー。 string
publicNetworkAccess 静的 Web アプリに対してパブリック トラフィックが許可されているかどうかを示す状態。 使用できる値: 'Enabled'、'Disabled'、または空の文字列。 string
repositoryToken ユーザーの github リポジトリ トークン。 これは、Github Actions ワークフロー ファイルと API シークレットを設定するために使用されます。 string
repositoryUrl 静的サイトのリポジトリの URL。 string
stagingEnvironmentPolicy ステージング環境が静的 Web アプリに対して許可されているかどうかを示す状態。 'Disabled'
'Enabled'
templateProperties 新しいリポジトリを生成するためのテンプレート オプション。 StaticSiteTemplateOptions

StaticSiteBuildProperties

名前 説明
apiBuildCommand Azure Functions API アプリケーションのデプロイ中に実行するカスタム コマンド。 string
apiLocation リポジトリ内の API コードへのパス。 string
appArtifactLocation 非推奨: ビルド後のアプリ成果物のパス (OutputLocation を優先して非推奨) string
appBuildCommand 静的コンテンツ アプリケーションのデプロイ中に実行するカスタム コマンド。 string
appLocation リポジトリ内のアプリ コードへのパス。 string
githubActionSecretNameOverride Github Action シークレット名のオーバーライド。 string
outputLocation ビルド後のアプリの出力パス。 string
skipGithubActionWorkflowGeneration Github Action ワークフローの生成をスキップします。 [bool]

StaticSiteTemplateOptions

名前 説明
description 新しく生成されたリポジトリの説明。 string
isPrivate 新しく生成されたリポジトリがプライベート リポジトリであるかどうか。 既定値は false (つまりパブリック) です。 [bool]
owner 新しく生成されたリポジトリの所有者。 string
repositoryName 新しく生成されたリポジトリの名前。 string
templateRepositoryUrl テンプレート リポジトリの URL。 新しく生成されたリポジトリは、このリポジトリに基づいています。 string

SkuDescription

名前 説明
capabilities SKU の機能 (たとえば、トラフィック マネージャーは有効ですか? Capability[]
capacity リソースに割り当てられているインスタンスの現在の数。 INT
family リソース SKU のファミリ コード。 string
locations SKU の場所。 string[]
name リソース SKU の名前。 string
size リソース SKU のサイズ指定子。 string
skuCapacity SKU の最小、最大、および既定のスケール値。 SkuCapacity
レベル リソース SKU のサービス レベル。 string

機能

名前 説明
name SKU 機能の名前。 string
reason SKU 機能の理由。 string
value SKU 機能の値。 string

SkuCapacity

名前 説明
default このApp Serviceプラン SKU の既定のワーカー数。 INT
elasticMaximum このApp Serviceプラン SKU の Elastic worker の最大数。 INT
maximum このApp Serviceプラン SKU のワーカーの最大数。 INT
minimum このApp Serviceプラン SKU の最小ワーカー数。 INT
scaleType App Service プランで使用できるスケール構成。 string

Terraform (AzAPI プロバイダー) リソース定義

staticSites リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Web/staticSites リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/staticSites@2022-09-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
      }
      enterpriseGradeCdnStatus = "string"
      provider = "string"
      publicNetworkAccess = "string"
      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

名前 説明
type リソースの種類 "Microsoft.Web/staticSites@2022-09-01"
name リソース名 string (必須)
location リソースの場所。 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。
sku スケーラブルなリソースの SKU の説明。 SkuDescription
kind リソースの種類。 string
identity マネージド サービス ID。 ManagedServiceIdentity
properties コア リソースのプロパティ StaticSite

ManagedServiceIdentity

名前 説明
type マネージド サービス ID の種類。 "SystemAssigned"
"SystemAssigned、UserAssigned"
"UserAssigned"
identity_ids リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ユーザー ID ID の配列。

StaticSite

名前 説明
allowConfigFileUpdates false この静的 Web アプリに対して構成ファイルがロックされている場合。それ以外の場合は true [bool]
分岐 リポジトリ内のターゲット ブランチ。 string
buildProperties リポジトリで構成するプロパティをビルドします。 StaticSiteBuildProperties
enterpriseGradeCdnStatus 静的 Web アプリへのトラフィックを提供するエンタープライズ グレードの CDN の状態を示す状態。 "無効"
"無効化"
"有効"
"有効化中"
provider 静的サイトのプライマリ環境に最後の展開を送信したプロバイダー。 string
publicNetworkAccess 静的 Web アプリに対してパブリック トラフィックが許可されているかどうかを示す状態。 使用できる値: 'Enabled'、'Disabled'、または空の文字列。 string
repositoryToken ユーザーの github リポジトリ トークン。 これは、Github Actions ワークフロー ファイルと API シークレットを設定するために使用されます。 string
repositoryUrl 静的サイトのリポジトリの URL。 string
stagingEnvironmentPolicy ステージング環境が静的 Web アプリに対して許可されているかどうかを示す状態。 "無効"
"有効"
templateProperties 新しいリポジトリを生成するためのテンプレート オプション。 StaticSiteTemplateOptions

StaticSiteBuildProperties

名前 説明
apiBuildCommand Azure Functions API アプリケーションのデプロイ中に実行するカスタム コマンド。 string
apiLocation リポジトリ内の API コードへのパス。 string
appArtifactLocation 非推奨: ビルド後のアプリ成果物のパス (OutputLocation を優先して非推奨) string
appBuildCommand 静的コンテンツ アプリケーションのデプロイ中に実行するカスタム コマンド。 string
appLocation リポジトリ内のアプリ コードへのパス。 string
githubActionSecretNameOverride Github Action シークレット名のオーバーライド。 string
outputLocation ビルド後のアプリの出力パス。 string
skipGithubActionWorkflowGeneration Github Action ワークフローの生成をスキップします。 [bool]

StaticSiteTemplateOptions

名前 説明
description 新しく生成されたリポジトリの説明。 string
isPrivate 新しく生成されたリポジトリがプライベート リポジトリであるかどうか。 既定値は false (つまり public) です。 [bool]
owner 新しく生成されたリポジトリの所有者。 string
repositoryName 新しく生成されたリポジトリの名前。 string
templateRepositoryUrl テンプレート リポジトリの URL。 新しく生成されたリポジトリは、このリポジトリに基づいています。 string

SkuDescription

名前 説明
capabilities SKU の機能 (たとえば、トラフィック マネージャーは有効ですか? Capability[]
capacity リソースに割り当てられているインスタンスの現在の数。 INT
family リソース SKU のファミリ コード。 string
locations SKU の場所。 string[]
name リソース SKU の名前。 string
size リソース SKU のサイズ指定子。 string
skuCapacity SKU の最小、最大、および既定のスケール値。 SkuCapacity
レベル リソース SKU のサービス レベル。 string

機能

名前 説明
name SKU 機能の名前。 string
reason SKU 機能の理由。 string
value SKU 機能の値。 string

SkuCapacity

名前 説明
default このApp Serviceプラン SKU の既定のワーカー数。 INT
elasticMaximum このApp Serviceプラン SKU のエラスティック ワーカーの最大数。 INT
maximum このApp Serviceプラン SKU のワーカーの最大数。 INT
minimum このApp Serviceプラン SKU のワーカーの最小数。 INT
scaleType App Service プランで使用可能なスケール構成。 string