azure_app_service

availability_state

タイプ: STRING
プロバイダー名: properties.availabilityState
説明: アプリの管理情報の利用可能状態。

client_affinity_enabled

タイプ: BOOLEAN
プロバイダー名: properties.clientAffinityEnabled
説明: false を指定すると、セッションアフィニティクッキーの送信を停止し、 同じセッションのクライアントリクエストを同じインスタンスにルーティングします。デフォルトは true です。

client_cert_enabled

タイプ: BOOLEAN
プロバイダー名: properties.clientCertEnabled
説明: クライアント証明書認証 (TLS 相互認証) を有効にする場合は true、そうでない場合は false を指定します。デフォルトは false です。

client_cert_exclusion_paths

タイプ: STRING
プロバイダー名: properties.clientCertExclusionPaths
説明: クライアント証明書認証のカンマ区切りの除外パス

client_cert_mode

タイプ: STRING
プロバイダー名: properties.clientCertMode
説明: ClientCertEnabled の設定と組み合わせて使用します。ClientCertEnabled: false は、ClientCert を無視することを意味します。ClientCertEnabled: true および ClientCertMode: Required は、ClientCert が必要であることを意味します。ClientCertEnabled: true および ClientCertMode: Optional は、ClientCert がオプションまたは受け入れ可能であることを意味します。

container_size

タイプ: INT64
プロバイダー名: properties.containerSize
説明: 関数コンテナのサイズ。

custom_domain_verification_id

タイプ: STRING
プロバイダー名: properties.customDomainVerificationId
説明: アプリに割り当てられたカスタムドメインを検証するための一意の識別子。顧客はこの ID を検証のために txt レコードに追加します。

daily_memory_time_quota

タイプ: INT64
プロバイダー名: properties.dailyMemoryTimeQuota
説明: 1 日のメモリ時間割り当ての最大許容量 (ダイナミックアプリにのみ適用)。

default_host_name

タイプ: STRING
プロバイダー名: properties.defaultHostName
説明: アプリのデフォルトのホスト名。読み取り専用です。

enabled

タイプ: BOOLEAN
プロバイダー名: properties.enabled
説明: アプリが有効な場合は true、そうでない場合は false です。この値を false に設定すると、アプリが無効になります (アプリがオフラインになります)。

enabled_host_names

タイプ: UNORDERED_LIST_STRING
プロバイダー名: properties.enabledHostNames
説明: アプリのホスト名を有効にします。ホスト名は割り当てられ (HostNames を参照)、かつ有効になっている必要があります。そうでない場合は、アプリはこれらのホスト名で提供されません。

extended_location

タイプ: STRUCT
プロバイダー名: extendedLocation

  • name
    タイプ: STRING
    プロバイダー名: name
    説明: 拡張ロケーションの名前。
  • type
    タイプ: STRING
    プロバイダー名: type
    説明: 拡張ロケーションのタイプ。

host_names

タイプ: UNORDERED_LIST_STRING
プロバイダー名: properties.hostNames
説明: アプリに関連付けられたホスト名。

host_names_disabled

タイプ: BOOLEAN
プロバイダー名: properties.hostNamesDisabled
説明: アプリの公開ホスト名を無効にする場合は true、それ以外の場合は false を指定します。true の場合、アプリは API 管理プロセスからのみアクセス可能となります。

https_only

タイプ: BOOLEAN
プロバイダー名: properties.httpsOnly
説明: HttpsOnly: Web サイトが https リクエストのみを受け付けるように構成します。HTTP リクエストのリダイレクトを発行します

hyper_v

タイプ: BOOLEAN
プロバイダー名: properties.hyperV
説明: Hyper-V のサンドボックス。

id

タイプ: STRING
プロバイダー名: id
説明: リソース ID。

identity

タイプ: STRUCT
プロバイダー名: identity

  • principal_id
    タイプ: STRING
    プロバイダー名: principalId
    説明: マネージドサービスアイデンティティのプリンシパル ID。
  • tenant_id
    タイプ: STRING
    プロバイダー名: tenantId
    説明: マネージドサービスアイデンティティのテナント。
  • type
    タイプ: STRING
    プロバイダー名: type
    説明: マネージドサービスアイデンティティの種類。

in_progress_operation_id

タイプ: STRING
プロバイダー名: properties.inProgressOperationId
説明: このサイトに保留中の操作がある場合、操作 ID を指定します。

is_default_container

タイプ: BOOLEAN
プロバイダー名: properties.isDefaultContainer
説明: アプリがデフォルトコンテナである場合は true、そうでない場合は false を指定します。

is_xenon

タイプ: BOOLEAN
プロバイダー名: properties.isXenon
説明: 廃止: Hyper-V のサンドボックス。

key_vault_reference_identity

タイプ: STRING
プロバイダー名: properties.keyVaultReferenceIdentity
説明: Key Vault Reference の認証に使用するアイデンティティ。

kind

タイプ: STRING
プロバイダー名: kind
説明: リソースの種類。

last_modified_time_utc

タイプ: STRING
プロバイダー名: properties.lastModifiedTimeUtc
説明: アプリが最後に変更された時刻 (UTC 単位)。読み取り専用です。

location

タイプ: STRING
プロバイダー名: location
説明: リソースロケーション。

max_number_of_workers

タイプ: INT32
プロバイダー名: properties.maxNumberOfWorkers
説明: 最大ワーカー数。Functions コンテナにのみ適用されます。

name

タイプ: STRING
プロバイダー名: name
説明: リソース名。

outbound_ip_addresses

タイプ: STRING
プロバイダー名: properties.outboundIpAddresses
説明: アプリが送信接続 (データベースへのアクセスなど) に使用する IP アドレスのリスト。現在の設定でサイトをホストできるテナントからの VIP が含まれます。読み取り専用です。

possible_outbound_ip_addresses

タイプ: STRING
プロバイダー名: properties.possibleOutboundIpAddresses
説明: アプリが送信接続 (データベースへのアクセスなど) に使用する IP アドレスのリスト。dataComponent 以外のすべてのテナントからの VIP を含みます。読み取り専用です。

redundancy_mode

タイプ: STRING
プロバイダー名: properties.redundancyMode
説明: サイト冗長化モード

repository_site_name

タイプ: STRING
プロバイダー名: properties.repositorySiteName
説明: リポジトリサイトの名前。

reserved

タイプ: BOOLEAN
プロバイダー名: properties.reserved
説明: 予約されている場合は true、そうでない場合は false

resource_group

タイプ: STRING

scm_site_also_stopped

タイプ: BOOLEAN
プロバイダー名: properties.scmSiteAlsoStopped
説明: アプリ停止時に SCM (KUDU) サイトを停止する場合は true、それ以外の場合は false。デフォルトは false です。

server_farm_id

タイプ: STRING
プロバイダー名: properties.serverFarmId
説明: 関連付けられたアプリサービスプランのリソース ID。形式: “/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}"

site_config

タイプ: STRUCT
プロバイダー名: properties.siteConfig
説明: アプリの構成。

  • acr_use_managed_identity_creds
    タイプ: BOOLEAN
    プロバイダー名: acrUseManagedIdentityCreds
    説明: ACR プルに Managed Identity Creds を使用するフラグ
  • acr_user_managed_identity_id
    タイプ: STRING
    プロバイダー名: acrUserManagedIdentityID
    説明: ユーザー管理アイデンティティを使用する場合、ユーザー管理アイデンティティの ClientId
  • always_on
    タイプ: BOOLEAN
    プロバイダー名: alwaysOn
    説明: Always On が有効な場合は true、そうでない場合は false
  • app_command_line
    タイプ: STRING
    プロバイダー名: appCommandLine
    説明: 起動するアプリのコマンドライン。
  • auto_heal_enabled
    タイプ: BOOLEAN
    プロバイダー名: autoHealEnabled
    説明: Auto Heal が有効な場合は true、そうでない場合は false
  • ftps_state
    タイプ: STRING
    プロバイダー名: ftpsState
    説明: FTP / FTPS サービスの状態
  • function_app_scale_limit
    タイプ: INT64
    プロバイダー名: functionAppScaleLimit
    説明: サイトがスケールアウトできる最大ワーカー数。この設定は、 Consumption プランと Elastic Premium プランにのみ適用されます
  • functions_runtime_scale_monitoring_enabled
    タイプ: BOOLEAN
    プロバイダー名: functionsRuntimeScaleMonitoringEnabled
    説明: 関数ランタイムスケールモニタリングを有効にするかどうかを示す値を取得または設定します。有効にすると、ScaleController はイベントソースを直接監視しなくなり、代わりにランタイムを呼び出してスケールのステータスを取得します。
  • http20_enabled
    タイプ: BOOLEAN
    プロバイダー名: http20Enabled
    説明: Http20Enabled: クライアントが http2.0 で接続できるように Web サイトを構成します
  • http_logging_enabled
    タイプ: BOOLEAN
    プロバイダー名: httpLoggingEnabled
    説明: HTTP ロギングが有効な場合は true、そうでない場合は false
  • java_container
    タイプ: STRING
    プロバイダー名: javaContainer
    説明: Java コンテナ。
  • java_container_version
    タイプ: STRING
    プロバイダー名: javaContainerVersion
    説明: Java コンテナのバージョン。
  • java_version
    タイプ: STRING
    プロバイダー名: javaVersion
    説明: Java のバージョン。
  • limits
    タイプ: STRUCT
    プロバイダー名: limits
    説明: サイトの制限。
    • max_disk_size_in_mb
      タイプ: INT64
      プロバイダー名: maxDiskSizeInMb
      説明: ディスクサイズの最大許容使用量 (MB 単位)。
    • max_memory_in_mb
      タイプ: INT64
      プロバイダー名: maxMemoryInMb
      説明: メモリの最大許容使用量 (MB 単位)。
    • max_percentage_cpu
      タイプ: DOUBLE
      プロバイダー名: maxPercentageCpu
      説明: CPU の最大許容使用率。
  • linux_fx_version
    タイプ: STRING
    プロバイダー名: linuxFxVersion
    説明: Linux アプリのフレームワークとバージョン
  • load_balancing
    タイプ: STRING
    プロバイダー名: loadBalancing
    説明: サイトのロードバランシング。
  • local_my_sql_enabled
    タイプ: BOOLEAN
    プロバイダー名: localMySqlEnabled
    説明: ローカル MySQL を有効にする場合は true、それ以外の場合は false
  • logs_directory_size_limit
    タイプ: INT64
    プロバイダー名: logsDirectorySizeLimit
    説明: HTTP ログのディレクトリサイズ制限。
  • machine_key
    タイプ: STRUCT
    プロバイダー名: machineKey
    説明: サイト MachineKey。
    • decryption
      タイプ: STRING
      プロバイダー名: decryption
      説明: 復号に使用するアルゴリズム。
    • decryption_key
      タイプ: STRING
      プロバイダー名: decryptionKey
      説明: 復号化キー。
    • validation
      タイプ: STRING
      プロバイダー名: validation
      説明: MachineKey の検証。
    • validation_key
      タイプ: STRING
      プロバイダー名: validationKey
      説明: 検証キー。
  • managed_pipeline_mode
    タイプ: STRING
    プロバイダー名: managedPipelineMode
    説明: マネージドパイプラインモード。
  • managed_service_identity_id
    タイプ: INT64
    プロバイダー名: managedServiceIdentityId
    説明: マネージドサービスアイデンティティ ID
  • min_tls_version
    タイプ: STRING
    プロバイダー名: minTlsVersion
    説明: MinTlsVersion: SSL リクエストに必要な TLS の最小バージョンを構成します
  • minimum_elastic_instance_count
    タイプ: INT64
    プロバイダー名: minimumElasticInstanceCount
    説明: サイトの最小インスタンス数。この設定は、Elastic Plans にのみ適用されます
  • net_framework_version
    タイプ: STRING
    プロバイダー名: netFrameworkVersion
    説明: .NET Framework のバージョン。
  • node_version
    タイプ: STRING
    プロバイダー名: nodeVersion
    説明: Node.js のバージョン。
  • number_of_workers
    タイプ: INT64
    プロバイダー名: numberOfWorkers
    説明: ワーカーの数。
  • php_version
    タイプ: STRING
    プロバイダー名: phpVersion
    説明: PHP のバージョン。
  • power_shell_version
    タイプ: STRING
    プロバイダー名: powerShellVersion
    説明: PowerShell のバージョン。
  • pre_warmed_instance_count
    タイプ: INT64
    プロバイダー名: preWarmedInstanceCount
    説明: preWarmed インスタンスの数。この設定は、Consumption プランと Elastic プランにのみ適用されます。
  • public_network_access
    タイプ: STRING
    プロバイダー名: publicNetworkAccess
    説明: すべての公共トラフィックを許可またはブロックするプロパティ。
  • publishing_username
    タイプ: STRING
    プロバイダー名: publishingUsername
    説明: パブリッシングユーザー名。
  • python_version
    タイプ: STRING
    プロバイダー名: pythonVersion
    説明: Python のバージョン。
  • remote_debugging_enabled
    タイプ: BOOLEAN
    プロバイダー名: remoteDebuggingEnabled
    説明: リモートデバッグが有効な場合は true、そうでない場合は false
  • remote_debugging_version
    タイプ: STRING
    プロバイダー名: remoteDebuggingVersion
    説明: リモートデバッグのバージョン。
  • request_tracing_enabled
    タイプ: BOOLEAN
    プロバイダー名: requestTracingEnabled
    説明: リクエストトレースが有効な場合は true、そうでない場合は false
  • scm_ip_security_restrictions_use_main
    タイプ: BOOLEAN
    プロバイダー名: scmIpSecurityRestrictionsUseMain
    説明: scm が main を使用するための IP セキュリティの制限。
  • scm_min_tls_version
    タイプ: STRING
    プロバイダー名: scmMinTlsVersion
    説明: ScmMinTlsVersion: SCM サイトへの SSL リクエストに必要な TLS の最小バージョンを構成します
  • scm_type
    タイプ: STRING
    プロバイダー名: scmType
    説明: SCM タイプ。
  • tracing_options
    タイプ: STRING
    プロバイダー名: tracingOptions
    説明: トレースオプション。
  • use32_bit_worker_process
    タイプ: BOOLEAN
    プロバイダー名: use32BitWorkerProcess
    説明: 32 ビットワーカープロセスを使用する場合は true、それ以外の場合は false
  • vnet_name
    タイプ: STRING
    プロバイダー名: vnetName
    説明: 仮想ネットワーク名。
  • vnet_private_ports_count
    タイプ: INT32
    プロバイダー名: vnetPrivatePortsCount
    説明: このアプリに割り当てられているプライベートポートの数。これらはランタイム時に動的に割り当てられます。
  • vnet_route_all_enabled
    タイプ: BOOLEAN
    プロバイダー名: vnetRouteAllEnabled
    説明: Virtual Network Route All を有効にします。これにより、すべてのアウトバウンドトラフィックに Virtual Network Security Groups と User Defined Routs が適用されるようになります。
  • web_sockets_enabled
    タイプ: BOOLEAN
    プロバイダー名: webSocketsEnabled
    説明: WebSocket が有効な場合は true、そうでない場合は false
  • website_time_zone
    タイプ: STRING
    プロバイダー名: websiteTimeZone
    説明: サイトがタイムスタンプを生成する際に使用するタイムゾーンを設定します。Linux と Windows のアプリサービスと互換性があります。WEBSITE_TIME_ZONE アプリの設定は、この設定より優先されます。Linux の場合、tz データベースの値として https://www.iana.org/time-zones (クイックリファレンスは https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) を期待します。Windows の場合、HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones にあるタイムゾーンのいずれかを期待します
  • windows_fx_version
    タイプ: STRING
    プロバイダー名: windowsFxVersion
    説明: Xenon アプリのフレームワークとバージョン
  • x_managed_service_identity_id
    タイプ: INT64
    プロバイダー名: xManagedServiceIdentityId
    説明: 明示的なマネージドサービスアイデンティティ ID

state

タイプ: STRING
プロバイダー名: properties.state
説明: 現在のアプリの状態。

storage_account_required

タイプ: BOOLEAN
プロバイダー名: properties.storageAccountRequired
説明: 顧客から提供されたストレージアカウントが必要かどうか確認します

subscription_id

タイプ: STRING

subscription_name

タイプ: STRING

suspended_till

タイプ: STRING
プロバイダー名: properties.suspendedTill
説明: メモリ時間制限を超えた場合、アプリが一時停止します。

tags

タイプ: UNORDERED_LIST_STRING

target_swap_slot

タイプ: STRING
プロバイダー名: properties.targetSwapSlot
説明: このアプリがどのデプロイメントスロットにスワップされるかを指定します。読み取り専用です。

traffic_manager_host_names

タイプ: UNORDERED_LIST_STRING
プロバイダー名: properties.trafficManagerHostNames
説明: アプリに関連付けられた Azure Traffic Manager のホスト名。読み取り専用です。

type

タイプ: STRING
プロバイダー名: type
説明: リソースタイプ。

usage_state

タイプ: STRING
プロバイダー名: properties.usageState
説明: アプリが割り当て使用量を超過しているかどうかを示す状態。読み取り専用です。

virtual_network_subnet_id

タイプ: STRING
プロバイダー名: properties.virtualNetworkSubnetId
説明: Regional VNET Integration で参加する仮想ネットワークおよびサブネットの Azure Resource Manager ID。これは、次のような形式でなければなりません: /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

web_auth_settings

タイプ: STRUCT
プロバイダー名: SiteAuthSettings

  • aad_claims_authorization
    タイプ: STRING
    プロバイダー名: properties.aadClaimsAuthorization
    説明: Azure AD Acl 設定を含む JSON 文字列を取得します。
  • auth_file_path
    タイプ: STRING
    プロバイダー名: properties.authFilePath
    説明: 認証設定を含むコンフィギュレーションファイルのパス。相対パスの場合は、サイトのルートディレクトリがベースとなります。
  • client_id
    タイプ: STRING
    プロバイダー名: properties.clientId
    説明: client_id と呼ばれる、この依拠当事者アプリケーションのクライアント ID。この設定は、Azure Active Directory または他のサードパーティ OpenID Connect プロバイダーで OpenID Connection 認証を有効にするために必要です。OpenID Connect の詳細については、こちらをご覧ください: http://openid.net/specs/openid-connect-core-1_0.html
  • client_secret
    タイプ: STRING
    プロバイダー名: properties.clientSecret
    説明: この依拠当事者アプリケーションのクライアントシークレット (Azure Active Directory では、これはキーとも呼ばれます)。この設定はオプションです。クライアントシークレットが構成されていない場合、エンドユーザーの認証には OpenID Connect の暗黙認証フローが使用されます。それ以外の場合は、エンドユーザーの認証に OpenID Connect 認可コードフローが使用されます。OpenID Connect の詳細については、こちらをご覧ください: http://openid.net/specs/openid-connect-core-1_0.html
  • client_secret_certificate_thumbprint
    タイプ: STRING
    プロバイダー名: properties.clientSecretCertificateThumbprint
    説明: クライアントシークレットに代わるもので、署名のために使用される証明書のサムプリント。このプロパティは、クライアントシークレットの代わりとして動作します。また、オプションです。
  • client_secret_setting_name
    タイプ: STRING
    プロバイダー名: properties.clientSecretSettingName
    説明: 依拠当事者アプリケーションのクライアントシークレットを含むアプリ設定名。
  • config_version
    タイプ: STRING
    プロバイダー名: properties.configVersion
    説明: 現在のアプリで使用されている認証/認可機能の ConfigVersion。この値の設定は、認証/認可のためのコントロールプレーンの動作を制御することができます。
  • default_provider
    タイプ: STRING
    プロバイダー名: properties.defaultProvider
    説明: 複数のプロバイダーが構成されている場合に使用するデフォルトの認証プロバイダー。この設定は、複数のプロバイダーを構成し、かつ未認証のクライアントに対するアクションを “RedirectToLoginPage” に設定した場合のみ必要です。
  • enabled
    タイプ: BOOLEAN
    プロバイダー名: properties.enabled
    説明: 現在のアプリで認証/認可機能が有効な場合は true、そうでない場合は false
  • facebook_app_secret
    タイプ: STRING
    プロバイダー名: properties.facebookAppSecret
    説明: Facebook ログインに使用する Facebook アプリのアプリシークレット。この設定は、Facebook ログインを有効にするために必要です。Facebook ログインのドキュメントを参照してください: https://developers.facebook.com/docs/facebook-login
  • id
    タイプ: STRING
    プロバイダー名: id
    説明: リソース ID。
  • is_auth_from_file
    タイプ: STRING
    プロバイダー名: properties.isAuthFromFile
    説明: 認証構成設定をファイルから読み込む場合は “true”、そうでない場合は “false”。
  • issuer
    タイプ: STRING
    プロバイダー名: properties.issuer
    説明: このアプリケーションのアクセストークンを発行するエンティティを表す、OpenID Connect Issuer URI。Azure Active Directory を使用する場合、この値はディレクトリテナントの URI になります (例: https://sts.windows.net/{tenant-guid}/) 。この URI は、トークン発行者の大文字と小文字を区別する識別子です。OpenID Connect Discovery の詳細はこちら: http://openid.net/specs/openid-connect-discovery-1_0.html
  • kind
    タイプ: STRING
    プロバイダー名: kind
    説明: リソースの種類。
  • name
    タイプ: STRING
    プロバイダー名: name
    説明: リソース名。
  • runtime_version
    タイプ: STRING
    プロバイダー名: properties.runtimeVersion
    説明: 現在のアプリで使用されている認証/認可機能の RuntimeVersion。この値の設定は、認証/認可モジュールの特定の機能の動作を制御することができます。
  • token_refresh_extension_hours
    タイプ: DOUBLE
    プロバイダー名: properties.tokenRefreshExtensionHours
    説明: セッショントークンの有効期限が切れてから、トークンリフレッシュ API を呼び出すために使用できる時間数。デフォルトは 72 時間です。
  • token_store_enabled
    タイプ: BOOLEAN
    プロバイダー名: properties.tokenStoreEnabled
    説明: ログインフローで取得したプラットフォーム固有のセキュリティトークンを永続的に保存する場合は true、それ以外の場合は false。デフォルトは false です。
  • type
    タイプ: STRING
    プロバイダー名: type
    説明: リソースタイプ。
  • unauthenticated_client_action
    タイプ: STRING
    プロバイダー名: properties.unauthenticatedClientAction
    説明: 未認証のクライアントがアプリにアクセスしようとしたときに取るべきアクション。
  • validate_issuer
    タイプ: BOOLEAN
    プロバイダー名: properties.validateIssuer
    説明: 発行者が有効な HTTPS URL であり、そのように検証されるべきかどうかを示す値を取得します。