次の方法で共有


Static Sites - Update Static Site

[説明] 既存のリソース グループに新しい静的サイトを作成するか、既存の静的サイトを更新します。

PATCH 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 のサブスクリプション ID。 これは GUID 形式の文字列です (たとえば、000000000-0000-0000-0000-000000000000000000000000000000000000000000000000000000000000、

api-version
query True

string

API バージョン

要求本文

名前 説明
kind

string

リソースの種類。

properties.allowConfigFileUpdates

boolean

false この静的 Web アプリに対して構成ファイルがロックされている場合。それ以外の場合は true

properties.branch

string

リポジトリ内のターゲット ブランチ。

properties.buildProperties

StaticSiteBuildProperties

リポジトリで構成するプロパティをビルドします。

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

静的 Web アプリへのトラフィックを提供するエンタープライズ グレードの CDN の状態を示す状態。

properties.provider

string

静的サイトのプライマリ環境に最後の展開を送信したプロバイダー。

properties.publicNetworkAccess

string

静的 Web アプリに対してパブリック トラフィックが許可されているかどうかを示す状態。 使用できる値: 'Enabled'、'Disabled'、または空の文字列。

properties.repositoryToken

string

ユーザーの github リポジトリ トークン。 これは、Github Actions ワークフロー ファイルと API シークレットを設定するために使用されます。

properties.repositoryUrl

string

静的サイトのリポジトリの URL。

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

ステージング環境が静的 Web アプリに対して許可されているかどうかを示す状態。

properties.templateProperties

StaticSiteTemplateOptions

新しいリポジトリを生成するためのテンプレート オプション。

応答

名前 説明
200 OK

StaticSiteARMResource

OK です。

202 Accepted

StaticSiteARMResource

非同期操作が進行中です。

Other Status Codes

DefaultErrorResponse

エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Patch a static site

要求のサンプル

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

{
  "properties": {}
}

応答のサンプル

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

定義

名前 説明
ArmIdWrapper

ARM リソース ID のラッパー

ArmPlan

Azure Resource Manager の plan オブジェクトは、マーケットプレースプランを表します。

Capability

特定の SKU で許可される機能について説明します。

DatabaseConnectionOverview

静的サイト データベース接続の概要。

DefaultErrorResponse

エラー応答をApp Serviceします。

Details
EnterpriseGradeCdnStatus

静的 Web アプリへのトラフィックを提供するエンタープライズ グレードの CDN の状態を示す状態。

Error

エラー モデル。

ErrorEntity

API から返されるエラー応答の本文。

ManagedServiceIdentity

マネージド サービス ID。

ManagedServiceIdentityType

マネージド サービス ID の種類。

PrivateLinkConnectionState

プライベート リンク接続の状態

RemotePrivateEndpointConnection

リモート プライベート エンドポイント接続

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

共通の Azure Resource Manager プロパティとリソース プロバイダー固有のコンテンツを含むメッセージ エンベロープ。

SkuCapacity

App Serviceプランのスケール オプションの説明。

SkuDescription

スケーラブルなリソースの SKU の説明。

StagingEnvironmentPolicy

ステージング環境が静的 Web アプリに対して許可されているかどうかを示す状態。

StaticSiteARMResource

静的サイト ARM リソース。

StaticSiteBuildProperties

静的サイトのビルド プロパティ。

StaticSiteDatabaseConnectionConfigurationFileOverview

データベース接続構成ファイル

StaticSiteLinkedBackend

静的サイトのリンクされたバックエンド ARM リソース。

StaticSitePatchResource

パッチ適用時の静的サイトの ARM リソース

StaticSiteTemplateOptions

静的サイトのテンプレート オプション。

StaticSiteUserProvidedFunctionApp

静的サイト ユーザーが提供する関数。

userAssignedIdentity

ユーザー割り当て ID。

ArmIdWrapper

ARM リソース ID のラッパー

名前 説明
id

string

ArmPlan

Azure Resource Manager の plan オブジェクトは、マーケットプレースプランを表します。

名前 説明
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

存在する場合、ID はデータベースに接続するために接続文字列と組み合わせて使用されます。 システム割り当てマネージド ID の使用は文字列 'SystemAssigned' で示され、ユーザー割り当てマネージド ID の使用はマネージド ID リソースのリソース ID で示されます。

name

string

存在する場合は、このデータベース接続リソースの名前。

region

string

データベース リソースのリージョン。

resourceId

string

データベースのリソース ID。

DefaultErrorResponse

エラー応答をApp Serviceします。

名前 説明
error

Error

エラー モデル。

Details

名前 説明
code

string

プログラムによってエラーを識別するための標準化された文字列。

message

string

エラーの詳細な説明とデバッグ情報。

target

string

エラーの詳細な説明とデバッグ情報。

EnterpriseGradeCdnStatus

静的 Web アプリへのトラフィックを提供するエンタープライズ グレードの 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

マネージド サービス ID。

名前 説明
principalId

string

マネージド サービス ID のプリンシパル ID。

tenantId

string

マネージド サービス ID のテナント。

type

ManagedServiceIdentityType

マネージド サービス ID の種類。

userAssignedIdentities

<string,  userAssignedIdentity>

リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。

ManagedServiceIdentityType

マネージド サービス ID の種類。

名前 説明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateLinkConnectionState

プライベート リンク接続の状態

名前 説明
actionsRequired

string

プライベート リンク接続の ActionsRequired

description

string

プライベート リンク接続の説明

status

string

プライベート リンク接続の状態

RemotePrivateEndpointConnection

リモート プライベート エンドポイント接続

名前 説明
id

string

リソース ID。

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

リソース ID。通常、ID は 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[]

サービスがホストされている論理Availability Zones

SkuCapacity

App Serviceプランのスケール オプションの説明。

名前 説明
default

integer

このApp Serviceプラン SKU の既定のワーカー数。

elasticMaximum

integer

このApp Serviceプラン SKU の Elastic worker の最大数。

maximum

integer

このApp Serviceプラン SKU のワーカーの最大数。

minimum

integer

このApp Serviceプラン SKU の最小ワーカー数。

scaleType

string

App Service プランで使用できるスケール構成。

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

ステージング環境が静的 Web アプリに対して許可されているかどうかを示す状態。

名前 説明
Disabled

string

Enabled

string

StaticSiteARMResource

静的サイト ARM リソース。

名前 説明
id

string

リソース ID。

identity

ManagedServiceIdentity

マネージド サービス ID。

kind

string

リソースの種類。

location

string

リソースの場所。

name

string

リソース名。

properties.allowConfigFileUpdates

boolean

false この静的 Web アプリに対して構成ファイルがロックされている場合。それ以外の場合は true

properties.branch

string

リポジトリ内のターゲット ブランチ。

properties.buildProperties

StaticSiteBuildProperties

リポジトリで構成するプロパティをビルドします。

properties.contentDistributionEndpoint

string

静的サイトのコンテンツ配布エンドポイント。

properties.customDomains

string[]

この静的サイトに関連付けられているカスタム ドメイン。

properties.databaseConnections

DatabaseConnectionOverview[]

静的サイトのデータベース接続

properties.defaultHostname

string

静的サイトの既定の自動生成されたホスト名。

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

静的 Web アプリへのトラフィックを提供するエンタープライズ グレードの CDN の状態を示す状態。

properties.keyVaultReferenceIdentity

string

Key Vault参照認証に使用する ID。

properties.linkedBackends

StaticSiteLinkedBackend[]

静的側にリンクされているバックエンド

properties.privateEndpointConnections

ResponseMessageEnvelope[RemotePrivateEndpointConnection][]

プライベート エンドポイント接続

properties.provider

string

静的サイトのプライマリ環境に最後の展開を送信したプロバイダー。

properties.publicNetworkAccess

string

静的 Web アプリに対してパブリック トラフィックが許可されているかどうかを示す状態。 使用できる値: 'Enabled'、'Disabled'、または空の文字列。

properties.repositoryToken

string

ユーザーの github リポジトリ トークン。 これは、Github Actions ワークフロー ファイルと API シークレットを設定するために使用されます。

properties.repositoryUrl

string

静的サイトのリポジトリの URL。

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

ステージング環境が静的 Web アプリに対して許可されているかどうかを示す状態。

properties.templateProperties

StaticSiteTemplateOptions

新しいリポジトリを生成するためのテンプレート オプション。

properties.userProvidedFunctionApps

StaticSiteUserProvidedFunctionApp[]

静的サイトに登録されているユーザー指定の関数アプリ

sku

SkuDescription

スケーラブルなリソースの SKU の説明。

tags

object

リソース タグ。

type

string

リソースの種類。

StaticSiteBuildProperties

静的サイトのビルド プロパティ。

名前 説明
apiBuildCommand

string

Azure Functions API アプリケーションのデプロイ中に実行するカスタム コマンド。

apiLocation

string

リポジトリ内の API コードへのパス。

appArtifactLocation

string

非推奨: ビルド後のアプリ成果物のパス (OutputLocation を優先して非推奨)

appBuildCommand

string

静的コンテンツ アプリケーションのデプロイ中に実行するカスタム コマンド。

appLocation

string

リポジトリ内のアプリ コードへのパス。

githubActionSecretNameOverride

string

Github Action シークレット名のオーバーライド。

outputLocation

string

ビルド後のアプリの出力パス。

skipGithubActionWorkflowGeneration

boolean

Github Action ワークフローの生成をスキップします。

StaticSiteDatabaseConnectionConfigurationFileOverview

データベース接続構成ファイル

名前 説明
contents

string

ファイルの内容の Base64 エンコード。

fileName

string

構成ファイルの名前。

type

string

構成ファイルの種類。

StaticSiteLinkedBackend

静的サイトのリンクされたバックエンド ARM リソース。

名前 説明
backendResourceId

string

静的サイトにリンクされているバックエンドのリソース ID

createdOn

string

バックエンドが静的サイトにリンクされた日時。

provisioningState

string

リンク 処理のプロビジョニング状態。

region

string

静的サイトにリンクされているバックエンドのリージョン

StaticSitePatchResource

パッチ適用時の静的サイトの ARM リソース

名前 説明
id

string

リソース ID。

kind

string

リソースの種類。

name

string

リソース名。

properties.allowConfigFileUpdates

boolean

false この静的 Web アプリに対して構成ファイルがロックされている場合。それ以外の場合は true

properties.branch

string

リポジトリ内のターゲット ブランチ。

properties.buildProperties

StaticSiteBuildProperties

リポジトリで構成するプロパティをビルドします。

properties.contentDistributionEndpoint

string

静的サイトのコンテンツ配布エンドポイント。

properties.customDomains

string[]

この静的サイトに関連付けられているカスタム ドメイン。

properties.databaseConnections

DatabaseConnectionOverview[]

静的サイトのデータベース接続

properties.defaultHostname

string

静的サイトの既定の自動生成されたホスト名。

properties.enterpriseGradeCdnStatus

EnterpriseGradeCdnStatus

静的 Web アプリへのトラフィックを提供するエンタープライズ グレードの CDN の状態を示す状態。

properties.keyVaultReferenceIdentity

string

Key Vault参照認証に使用する ID。

properties.linkedBackends

StaticSiteLinkedBackend[]

静的側にリンクされているバックエンド

properties.privateEndpointConnections

ResponseMessageEnvelope[RemotePrivateEndpointConnection][]

プライベート エンドポイント接続

properties.provider

string

静的サイトのプライマリ環境に最後の展開を送信したプロバイダー。

properties.publicNetworkAccess

string

静的 Web アプリに対してパブリック トラフィックが許可されているかどうかを示す状態。 使用できる値: 'Enabled'、'Disabled'、または空の文字列。

properties.repositoryToken

string

ユーザーの github リポジトリ トークン。 これは、Github Actions ワークフロー ファイルと API シークレットを設定するために使用されます。

properties.repositoryUrl

string

静的サイトのリポジトリの URL。

properties.stagingEnvironmentPolicy

StagingEnvironmentPolicy

ステージング環境が静的 Web アプリに対して許可されているかどうかを示す状態。

properties.templateProperties

StaticSiteTemplateOptions

新しいリポジトリを生成するためのテンプレート オプション。

properties.userProvidedFunctionApps

StaticSiteUserProvidedFunctionApp[]

静的サイトに登録されているユーザー指定の関数アプリ

type

string

リソースの種類。

StaticSiteTemplateOptions

静的サイトのテンプレート オプション。

名前 説明
description

string

新しく生成されたリポジトリの説明。

isPrivate

boolean

新しく生成されたリポジトリがプライベート リポジトリであるかどうか。 既定値は false (つまり public) です。

owner

string

新しく生成されたリポジトリの所有者。

repositoryName

string

新しく生成されたリポジトリの名前。

templateRepositoryUrl

string

テンプレート リポジトリの URL。 新しく生成されたリポジトリは、このリポジトリに基づいています。

StaticSiteUserProvidedFunctionApp

静的サイト ユーザーが提供する関数。

名前 説明
id

string

リソース ID。

kind

string

リソースの種類。

name

string

リソース名。

properties.createdOn

string

関数アプリが静的サイトに登録された日時。

properties.functionAppRegion

string

静的サイトに登録されている関数アプリの領域

properties.functionAppResourceId

string

静的サイトに登録されている関数アプリのリソース ID

type

string

リソースの種類。

userAssignedIdentity

ユーザー割り当て ID。

名前 説明
clientId

string

ユーザー割り当て ID のクライアント ID

principalId

string

ユーザー割り当て ID のプリンシパル ID