Site interface

パッケージ:

@azure/arm-appservice

Web アプリ、モバイル アプリ バックエンド、または API アプリ。

Extends

Resource

プロパティ

autoGeneratedDomainNameLabelScope	リソースの作成時に既定のホスト名の一意性のスコープを指定します
availabilityState	アプリの管理情報の可用性の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
clientAffinityEnabled	クライアント アフィニティを有効にする true。セッション アフィニティ Cookie の送信を停止する false、同じセッション内のクライアント要求を同じインスタンスにルーティングします。 既定値は trueです。
clientAffinityPartitioningEnabled	true CHIPS Cookie を使用したクライアント アフィニティ パーティショニングを有効にするには、アフィニティ Cookie に partitioned プロパティを追加します。 false 、パーティショニングされたアフィニティ Cookie の送信を停止します。 既定値は falseです。
clientAffinityProxyEnabled	true クライアントアフィニティ Cookie ドメインを X-Forwarded-Host 要求ヘッダーで上書きします。 false デフォルトのドメインを使用します。 既定値は falseです。
clientCertEnabled	クライアント証明書認証 (TLS 相互認証) を有効にする true。それ以外の場合は、falseします。 既定値は falseです。
clientCertExclusionPaths	クライアント証明書認証のコンマ区切り除外パス
clientCertMode	これは ClientCertEnabled 設定で構成されます。 ClientCertEnabled: false は、ClientCert が無視されていることを意味します。 ClientCertEnabled: true と ClientCertMode: Required は ClientCert が必要であることを意味します。 ClientCertEnabled: true と ClientCertMode: 省略可能は、ClientCert が省略可能または受け入れ可能であることを意味します。
cloningInfo	アプリの作成時に指定した場合、アプリはソース アプリから複製されます。
containerSize	関数コンテナーのサイズ。
customDomainVerificationId	アプリに割り当てられているカスタム ドメインを検証する一意の識別子。 お客様は、確認のためにこの ID を txt レコードに追加します。
dailyMemoryTimeQuota	1 日に許可される最大メモリ時間クォータ (動的アプリにのみ適用されます)。
daprConfig	アプリの Dapr 構成。
defaultHostName	アプリの既定のホスト名。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
dnsConfiguration	サイトのさまざまな DNS 関連設定を構成するプロパティ。
enabled	アプリが有効になっているかどうかを true します。それ以外の場合は、falseします。 この値を false に設定すると、アプリが無効になります (アプリはオフラインになります)。
enabledHostNames	アプリのホスト名を有効にしました。ホスト名を割り当てる必要があります (HostNames を参照) AND を有効にします。 それ以外の場合、アプリはそれらのホスト名では提供されません。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
endToEndEncryptionEnabled	フロントエンドと Worker の間でエンド ツー エンド暗号化を使用するかどうか
extendedLocation	拡張された場所。
functionAppConfig	Azure 関数アプリに固有の構成。
hostingEnvironmentProfile	アプリに使用する App Service Environment。
hostNames	アプリに関連付けられているホスト名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
hostNamesDisabled	アプリのパブリック ホスト名を無効にする true。それ以外の場合は、falseします。 true場合、アプリは API 管理プロセス経由でのみアクセスできます。
hostNameSslStates	ホスト名の SSL 状態は、アプリのホスト名の SSL バインドを管理するために使用されます。
httpsOnly	HttpsOnly: https 要求のみを受け入れるように Web サイトを構成します。 http 要求のリダイレクトに関する問題
hyperV	サンドボックス Hyper-V。
identity	マネージド サービス ID。
inProgressOperationId	このサイトに保留中の操作がある場合は、操作 ID を指定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
ipMode	アプリの IP モードを指定します。
isDefaultContainer	アプリが既定のコンテナーであるかどうかを true します。それ以外の場合は、falseします。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
isXenon	現在は使用されていません:サンドボックス Hyper-V。
keyVaultReferenceIdentity	Key Vault 参照認証に使用する ID。
lastModifiedTimeUtc	アプリが最後に変更された時刻 (UTC)。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
managedEnvironmentId	このアプリをホストする、顧客が選択したマネージド環境の Azure Resource Manager ID。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} の形式である必要があります。
maxNumberOfWorkers	ワーカーの最大数。 これは Functions コンテナーにのみ適用されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
outboundIpAddresses	アプリが送信接続に使用する IP アドレスの一覧 (データベース アクセスなど)。 現在の設定でサイトをホストできるテナントの VIP が含まれます。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
outboundVnetRouting	サイトの仮想ネットワーク経由のさまざまな送信トラフィック ルーティング オプションを構成するプロパティ
possibleOutboundIpAddresses	アプリが送信接続に使用する IP アドレスの一覧 (データベース アクセスなど)。 dataComponent を除くすべてのテナントの VIP が含まれます。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
publicNetworkAccess	すべてのパブリック トラフィックを許可またはブロックするプロパティ。 使用できる値: 'Enabled'、'Disabled'、または空の文字列。
redundancyMode	サイト冗長モード
repositorySiteName	リポジトリ サイトの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
reserved	予約されている場合は true。それ以外の場合は、falseします。
resourceConfig	関数アプリのリソース要件。
resourceGroup	アプリが属するリソース グループの名前。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
scmSiteAlsoStopped	アプリが停止したときに SCM (KUDU) サイトを停止する true。それ以外の場合は、falseします。 既定値は falseです。
serverFarmId	関連付けられた App Service プランのリソース ID。"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}" という形式です。
siteConfig	App Service アプリの構成。 このプロパティは、機密情報が含まれている可能性があるため、通常の作成要求と読み取り要求に応答して返されません。
sku	関連付けられている App Service プランに基づくアプリケーションの現在の SKU。 有効な SKU 値には、Free、Shared、Basic、Dynamic、FlexConsumption、Standard、Premium、PremiumV2、PremiumV3、Isolated、IsolatedV2 があります。このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
slotSwapStatus	最後のデプロイ スロットスワップ操作の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
sshEnabled	ssh アクセスを有効にするかどうか。
state	アプリの現在の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
storageAccountRequired	お客様が指定したストレージ アカウントが必要かどうかを確認します
suspendedTill	メモリ時間クォータを超えた場合に備え、アプリは中断されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
targetSwapSlot	このアプリがスワップするデプロイ スロットを指定します。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
trafficManagerHostNames	アプリに関連付けられている Azure Traffic Manager のホスト名。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
usageState	アプリがクォータ使用量を超えたかどうかを示す状態。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
virtualNetworkSubnetId	リージョン VNET 統合によって参加する仮想ネットワークとサブネットの Azure Resource Manager ID。 これは、/subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} の形式である必要があります。
workloadProfileName	実行する関数アプリのワークロード プロファイル名。

継承されたプロパティ

id	リソース ID。注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
kind	リソースの種類。 リソースがアプリの場合は、サポートされている種類の値の詳細については、https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference を参照してください。
location	リソースの場所。
name	リソース名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
tags	リソース タグ。
type	リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

autoGeneratedDomainNameLabelScope

リソースの作成時に既定のホスト名の一意性のスコープを指定します

autoGeneratedDomainNameLabelScope?: AutoGeneratedDomainNameLabelScope

プロパティ値

AutoGeneratedDomainNameLabelScope

availabilityState

アプリの管理情報の可用性の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

availabilityState?: SiteAvailabilityState

プロパティ値

SiteAvailabilityState

clientAffinityEnabled

クライアント アフィニティを有効にする true。セッション アフィニティ Cookie の送信を停止する false、同じセッション内のクライアント要求を同じインスタンスにルーティングします。 既定値は trueです。

clientAffinityEnabled?: boolean

プロパティ値

boolean

clientAffinityPartitioningEnabled

true CHIPS Cookie を使用したクライアント アフィニティ パーティショニングを有効にするには、アフィニティ Cookie に partitioned プロパティを追加します。 false 、パーティショニングされたアフィニティ Cookie の送信を停止します。 既定値は falseです。

clientAffinityPartitioningEnabled?: boolean

プロパティ値

boolean

clientAffinityProxyEnabled

true クライアントアフィニティ Cookie ドメインを X-Forwarded-Host 要求ヘッダーで上書きします。 false デフォルトのドメインを使用します。 既定値は falseです。

clientAffinityProxyEnabled?: boolean

プロパティ値

boolean

clientCertEnabled

クライアント証明書認証 (TLS 相互認証) を有効にする true。それ以外の場合は、falseします。 既定値は falseです。

clientCertEnabled?: boolean

プロパティ値

boolean

clientCertExclusionPaths

クライアント証明書認証のコンマ区切り除外パス

clientCertExclusionPaths?: string

プロパティ値

string

clientCertMode

これは ClientCertEnabled 設定で構成されます。

• ClientCertEnabled: false は、ClientCert が無視されていることを意味します。
• ClientCertEnabled: true と ClientCertMode: Required は ClientCert が必要であることを意味します。
• ClientCertEnabled: true と ClientCertMode: 省略可能は、ClientCert が省略可能または受け入れ可能であることを意味します。

clientCertMode?: ClientCertMode

プロパティ値

ClientCertMode

cloningInfo

アプリの作成時に指定した場合、アプリはソース アプリから複製されます。

cloningInfo?: CloningInfo

プロパティ値

CloningInfo

containerSize

関数コンテナーのサイズ。

containerSize?: number

プロパティ値

number

customDomainVerificationId

アプリに割り当てられているカスタム ドメインを検証する一意の識別子。 お客様は、確認のためにこの ID を txt レコードに追加します。

customDomainVerificationId?: string

プロパティ値

string

dailyMemoryTimeQuota

1 日に許可される最大メモリ時間クォータ (動的アプリにのみ適用されます)。

dailyMemoryTimeQuota?: number

プロパティ値

number

daprConfig

アプリの Dapr 構成。

daprConfig?: DaprConfig

プロパティ値

DaprConfig

defaultHostName

アプリの既定のホスト名。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

defaultHostName?: string

プロパティ値

string

dnsConfiguration

サイトのさまざまな DNS 関連設定を構成するプロパティ。

dnsConfiguration?: SiteDnsConfig

プロパティ値

SiteDnsConfig

enabled

アプリが有効になっているかどうかを true します。それ以外の場合は、falseします。 この値を false に設定すると、アプリが無効になります (アプリはオフラインになります)。

enabled?: boolean

プロパティ値

boolean

enabledHostNames

アプリのホスト名を有効にしました。ホスト名を割り当てる必要があります (HostNames を参照) AND を有効にします。 それ以外の場合、アプリはそれらのホスト名では提供されません。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

enabledHostNames?: string[]

プロパティ値

string[]

endToEndEncryptionEnabled

フロントエンドと Worker の間でエンド ツー エンド暗号化を使用するかどうか

endToEndEncryptionEnabled?: boolean

プロパティ値

boolean

extendedLocation

拡張された場所。

extendedLocation?: ExtendedLocation

プロパティ値

ExtendedLocation

functionAppConfig

Azure 関数アプリに固有の構成。

functionAppConfig?: FunctionAppConfig

プロパティ値

FunctionAppConfig

hostingEnvironmentProfile

アプリに使用する App Service Environment。

hostingEnvironmentProfile?: HostingEnvironmentProfile

プロパティ値

HostingEnvironmentProfile

hostNames

アプリに関連付けられているホスト名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

hostNames?: string[]

プロパティ値

string[]

hostNamesDisabled

アプリのパブリック ホスト名を無効にする true。それ以外の場合は、falseします。 true場合、アプリは API 管理プロセス経由でのみアクセスできます。

hostNamesDisabled?: boolean

プロパティ値

boolean

hostNameSslStates

ホスト名の SSL 状態は、アプリのホスト名の SSL バインドを管理するために使用されます。

hostNameSslStates?: HostNameSslState[]

プロパティ値

HostNameSslState[]

httpsOnly

HttpsOnly: https 要求のみを受け入れるように Web サイトを構成します。 http 要求のリダイレクトに関する問題

httpsOnly?: boolean

プロパティ値

boolean

hyperV

サンドボックス Hyper-V。

hyperV?: boolean

プロパティ値

boolean

identity

マネージド サービス ID。

identity?: ManagedServiceIdentity

プロパティ値

ManagedServiceIdentity

inProgressOperationId

このサイトに保留中の操作がある場合は、操作 ID を指定します。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

inProgressOperationId?: string

プロパティ値

string

ipMode

アプリの IP モードを指定します。

ipMode?: IPMode

プロパティ値

IPMode

isDefaultContainer

アプリが既定のコンテナーであるかどうかを true します。それ以外の場合は、falseします。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

isDefaultContainer?: boolean

プロパティ値

boolean

isXenon

現在は使用されていません:サンドボックス Hyper-V。

isXenon?: boolean

プロパティ値

boolean

keyVaultReferenceIdentity

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

keyVaultReferenceIdentity?: string

プロパティ値

string

lastModifiedTimeUtc

アプリが最後に変更された時刻 (UTC)。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

lastModifiedTimeUtc?: Date

プロパティ値

Date

managedEnvironmentId

このアプリをホストする、顧客が選択したマネージド環境の Azure Resource Manager ID。 これは、/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} の形式である必要があります。

managedEnvironmentId?: string

プロパティ値

string

maxNumberOfWorkers

ワーカーの最大数。 これは Functions コンテナーにのみ適用されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

maxNumberOfWorkers?: number

プロパティ値

number

outboundIpAddresses

アプリが送信接続に使用する IP アドレスの一覧 (データベース アクセスなど)。 現在の設定でサイトをホストできるテナントの VIP が含まれます。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

outboundIpAddresses?: string

プロパティ値

string

outboundVnetRouting

サイトの仮想ネットワーク経由のさまざまな送信トラフィック ルーティング オプションを構成するプロパティ

outboundVnetRouting?: OutboundVnetRouting

プロパティ値

OutboundVnetRouting

possibleOutboundIpAddresses

アプリが送信接続に使用する IP アドレスの一覧 (データベース アクセスなど)。 dataComponent を除くすべてのテナントの VIP が含まれます。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

possibleOutboundIpAddresses?: string

プロパティ値

string

publicNetworkAccess

すべてのパブリック トラフィックを許可またはブロックするプロパティ。 使用できる値: 'Enabled'、'Disabled'、または空の文字列。

publicNetworkAccess?: string

プロパティ値

string

redundancyMode

サイト冗長モード

redundancyMode?: RedundancyMode

プロパティ値

RedundancyMode

repositorySiteName

リポジトリ サイトの名前。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

repositorySiteName?: string

プロパティ値

string

reserved

予約されている場合は true。それ以外の場合は、falseします。

reserved?: boolean

プロパティ値

boolean

resourceConfig

関数アプリのリソース要件。

resourceConfig?: ResourceConfig

プロパティ値

ResourceConfig

resourceGroup

アプリが属するリソース グループの名前。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

resourceGroup?: string

プロパティ値

string

scmSiteAlsoStopped

アプリが停止したときに SCM (KUDU) サイトを停止する true。それ以外の場合は、falseします。 既定値は falseです。

scmSiteAlsoStopped?: boolean

プロパティ値

boolean

serverFarmId

関連付けられた App Service プランのリソース ID。"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}" という形式です。

serverFarmId?: string

プロパティ値

string

siteConfig

App Service アプリの構成。 このプロパティは、機密情報が含まれている可能性があるため、通常の作成要求と読み取り要求に応答して返されません。

siteConfig?: SiteConfig

プロパティ値

SiteConfig

sku

関連付けられている App Service プランに基づくアプリケーションの現在の SKU。 有効な SKU 値には、Free、Shared、Basic、Dynamic、FlexConsumption、Standard、Premium、PremiumV2、PremiumV3、Isolated、IsolatedV2 があります。このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

sku?: string

プロパティ値

string

slotSwapStatus

最後のデプロイ スロットスワップ操作の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

slotSwapStatus?: SlotSwapStatus

プロパティ値

SlotSwapStatus

sshEnabled

ssh アクセスを有効にするかどうか。

sshEnabled?: boolean

プロパティ値

boolean

state

アプリの現在の状態。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

state?: string

プロパティ値

string

storageAccountRequired

お客様が指定したストレージ アカウントが必要かどうかを確認します

storageAccountRequired?: boolean

プロパティ値

boolean

suspendedTill

メモリ時間クォータを超えた場合に備え、アプリは中断されます。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

suspendedTill?: Date

プロパティ値

Date

targetSwapSlot

このアプリがスワップするデプロイ スロットを指定します。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

targetSwapSlot?: string

プロパティ値

string

trafficManagerHostNames

アプリに関連付けられている Azure Traffic Manager のホスト名。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

trafficManagerHostNames?: string[]

プロパティ値

string[]

usageState

アプリがクォータ使用量を超えたかどうかを示す状態。 読み取り専用。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

usageState?: UsageState

プロパティ値

UsageState

virtualNetworkSubnetId

リージョン VNET 統合によって参加する仮想ネットワークとサブネットの Azure Resource Manager ID。 これは、/subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} の形式である必要があります。

virtualNetworkSubnetId?: string

プロパティ値

string

workloadProfileName

実行する関数アプリのワークロード プロファイル名。

workloadProfileName?: string

プロパティ値

string

継承されたプロパティの詳細

id

リソース ID。注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

Resource.id から継承された

kind

リソースの種類。 リソースがアプリの場合は、サポートされている種類の値の詳細については、https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference を参照してください。

kind?: string

プロパティ値

string

Resource.kind から継承された

location

リソースの場所。

location: string

プロパティ値

string

resource.location から継承

name

リソース名。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

Resource.name から継承された

tags

リソース タグ。

tags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

Resource.tags から継承された

type

リソースの種類。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

Resource.type から継承された