Azure App Services

Get Web App

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Get a description of a Web App in Azure App Service.

Inputs

フィールド

種類

説明

resourceGroupName [required]

string

subscriptionId [required]

string

siteName [required]

string

Outputs

Expand All

フィールド

種類

説明

id

string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

name

string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

kind

string

Kind of resource.

location [required]

string

Resource Location.

type

string

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

tags

object

Resource tags.

identity

object

Managed service identity.

type

enum

Type of managed service identity. Allowed enum values: SystemAssigned,UserAssigned,SystemAssigned, UserAssigned,None

tenantId

string

Tenant of managed service identity. NOTE: This property will not be serialized. It can only be populated by the server.

principalId

string

Principal Id of managed service identity. NOTE: This property will not be serialized. It can only be populated by the server.

userAssignedIdentities

object

The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

extendedLocation

object

Extended Location.

name

string

Name of extended location.

type

string

Type of extended location. NOTE: This property will not be serialized. It can only be populated by the server.

state

string

Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.

hostNames

[string]

Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.

repositorySiteName

string

Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.

usageState

enum

State indicating whether the app has exceeded its quota usage. Read-only. NOTE: This property will not be serialized. It can only be populated by the server. Allowed enum values: Normal,Exceeded

enabled

boolean

true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

enabledHostNames

[string]

Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. NOTE: This property will not be serialized. It can only be populated by the server.

availabilityState

enum

Management information availability state for the app. NOTE: This property will not be serialized. It can only be populated by the server. Allowed enum values: Normal,Limited,DisasterRecoveryMode

hostNameSslStates

[object]

Hostname SSL states are used to manage the SSL bindings for app's hostnames.

name

string

Hostname.

sslState

enum

SSL type. Allowed enum values: Disabled,SniEnabled,IpBasedEnabled

virtualIP

string

Virtual IP address assigned to the hostname if IP based SSL is enabled.

thumbprint

string

SSL certificate thumbprint.

toUpdate

boolean

Set to true to update existing hostname.

hostType

enum

Indicates whether the hostname is a standard or repository hostname. Allowed enum values: Standard,Repository

serverFarmId

string

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

reserved

boolean

true if reserved; otherwise, false.

isXenon

boolean

Obsolete: Hyper-V sandbox.

hyperV

boolean

Hyper-V sandbox.

lastModifiedTimeUtc

date-time

Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

vnetRouteAllEnabled

boolean

Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

vnetImagePullEnabled

boolean

To enable pulling image over Virtual Network

vnetContentShareEnabled

boolean

To enable accessing content over virtual network

siteConfig

object

Configuration of the app.

numberOfWorkers

number

Number of workers.

defaultDocuments

[string]

Default documents.

netFrameworkVersion

string

.NET Framework version.

phpVersion

string

Version of PHP.

pythonVersion

string

Version of Python.

nodeVersion

string

Version of Node.js.

powerShellVersion

string

Version of PowerShell.

linuxFxVersion

string

Linux App Framework and version

windowsFxVersion

string

Xenon App Framework and version

requestTracingEnabled

boolean

true if request tracing is enabled; otherwise, false.

requestTracingExpirationTime

date-time

Request tracing expiration time.

remoteDebuggingEnabled

boolean

true if remote debugging is enabled; otherwise, false.

remoteDebuggingVersion

string

Remote debugging version.

httpLoggingEnabled

boolean

true if HTTP logging is enabled; otherwise, false.

acrUseManagedIdentityCreds

boolean

Flag to use Managed Identity Creds for ACR pull

acrUserManagedIdentityID

string

If using user managed identity, the user managed identity ClientId

logsDirectorySizeLimit

number

HTTP logs directory size limit.

detailedErrorLoggingEnabled

boolean

true if detailed error logging is enabled; otherwise, false.

publishingUsername

string

Publishing user name.

appSettings

[object]

Application settings.

name

string

Pair name.

value

string

Pair value.

metadata

[object]

Application metadata. This property cannot be retrieved, since it may contain secrets.

name

string

Pair name.

value

string

Pair value.

connectionStrings

[object]

Connection strings.

name

string

Name of connection string.

connectionString

string

Connection string value.

type

enum

Type of database. Allowed enum values: MySql,SQLServer,SQLAzure,Custom,NotificationHub,ServiceBus,EventHub,ApiHub,DocDb,RedisCache,PostgreSQL

machineKey

object

Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server.

validation

string

MachineKey validation.

validationKey

string

Validation key.

decryption

string

Algorithm used for decryption.

decryptionKey

string

Decryption key.

handlerMappings

[object]

Handler mappings.

extension

string

Requests with this extension will be handled using the specified FastCGI application.

scriptProcessor

string

The absolute path to the FastCGI application.

arguments

string

Command-line arguments to be passed to the script processor.

documentRoot

string

Document root.

scmType

string

SCM type.

use32BitWorkerProcess

boolean

true to use 32-bit worker process; otherwise, false.

webSocketsEnabled

boolean

true if WebSocket is enabled; otherwise, false.

alwaysOn

boolean

true if Always On is enabled; otherwise, false.

javaVersion

string

Java version.

javaContainer

string

Java container.

javaContainerVersion

string

Java container version.

appCommandLine

string

App command line to launch.

managedPipelineMode

enum

Managed pipeline mode. Allowed enum values: Integrated,Classic

virtualApplications

[object]

Virtual applications.

virtualPath

string

Virtual path.

physicalPath

string

Physical path.

preloadEnabled

boolean

true if preloading is enabled; otherwise, false.

virtualDirectories

[object]

Virtual directories for virtual application.

virtualPath

string

Path to virtual application.

physicalPath

string

Physical path.

loadBalancing

enum

Site load balancing. Allowed enum values: WeightedRoundRobin,LeastRequests,LeastResponseTime,WeightedTotalTraffic,RequestHash,PerSiteRoundRobin

experiments

object

This is work around for polymorphic types.

rampUpRules

[object]

List of ramp-up rules.

actionHostName

string

Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

reroutePercentage

number

Percentage of the traffic which will be redirected to ActionHostName.

changeStep

number

In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.

changeIntervalInMinutes

number

Specifies interval in minutes to reevaluate ReroutePercentage.

minReroutePercentage

number

Specifies lower boundary above which ReroutePercentage will stay.

maxReroutePercentage

number

Specifies upper boundary below which ReroutePercentage will stay.

changeDecisionCallbackUrl

string

Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/

name

string

Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

limits

object

Site limits.

maxPercentageCpu

number

Maximum allowed CPU usage percentage.

maxMemoryInMb

number

Maximum allowed memory usage in MB.

maxDiskSizeInMb

number

Maximum allowed disk size usage in MB.

autoHealEnabled

boolean

true if Auto Heal is enabled; otherwise, false.

autoHealRules

object

Auto Heal rules.

triggers

object

Conditions that describe when to execute the auto-heal actions.

requests

object

A rule based on total requests.

count

number

Request Count.

timeInterval

string

Time interval.

privateBytesInKB

number

A rule based on private bytes.

statusCodes

[object]

A rule based on status codes.

status

number

HTTP status code.

subStatus

number

Request Sub Status.

win32Status

number

Win32 error code.

count

number

Request Count.

timeInterval

string

Time interval.

path

string

Request Path

slowRequests

object

A rule based on request execution time.

timeTaken

string

Time taken.

path

string

Request Path.

count

number

Request Count.

timeInterval

string

Time interval.

slowRequestsWithPath

[object]

A rule based on multiple Slow Requests Rule with path

timeTaken

string

Time taken.

path

string

Request Path.

count

number

Request Count.

timeInterval

string

Time interval.

statusCodesRange

[object]

A rule based on status codes ranges.

statusCodes

string

HTTP status code.

path

string

count

number

Request Count.

timeInterval

string

Time interval.

actions

object

Actions to be executed when a rule is triggered.

actionType

enum

Predefined action to be taken. Allowed enum values: Recycle,LogEvent,CustomAction

customAction

object

Custom action to be taken.

exe

string

Executable to be run.

parameters

string

Parameters for the executable.

minProcessExecutionTime

string

Minimum time the process must execute before taking the action

tracingOptions

string

Tracing options.

vnetName

string

Virtual Network name.

vnetRouteAllEnabled

boolean

Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

vnetPrivatePortsCount

number

The number of private ports assigned to this app. These will be assigned dynamically on runtime.

cors

object

Cross-Origin Resource Sharing (CORS) settings.

allowedOrigins

[string]

Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.

supportCredentials

boolean

Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details.

push

object

Push endpoint settings.

id

string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

name

string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

kind

string

Kind of resource.

type

string

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

isPushEnabled

boolean

Gets or sets a flag indicating whether the Push endpoint is enabled.

tagWhitelistJson

string

Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.

tagsRequiringAuth

string

Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.

dynamicTagsJson

string

Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.

apiDefinition

object

Information about the formal API definition for the app.

url

string

The URL of the API definition.

apiManagementConfig

object

Azure API management settings linked to the app.

id

string

APIM-Api Identifier.

autoSwapSlotName

string

Auto-swap slot name.

localMySqlEnabled

boolean

true to enable local MySQL; otherwise, false.

managedServiceIdentityId

number

Managed Service Identity Id

xManagedServiceIdentityId

number

Explicit Managed Service Identity Id

keyVaultReferenceIdentity

string

Identity to use for Key Vault Reference authentication.

ipSecurityRestrictions

[object]

IP security restrictions for main.

ipAddress

string

IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.

subnetMask

string

Subnet mask for the range of IP addresses the restriction is valid for.

vnetSubnetResourceId

string

Virtual network resource id

vnetTrafficTag

number

(internal) Vnet traffic tag

subnetTrafficTag

number

(internal) Subnet traffic tag

action

string

Allow or Deny access for this IP range.

tag

string

Defines what this IP filter will be used for. This is to support IP filtering on proxies.

priority

number

Priority of IP restriction rule.

name

string

IP restriction rule name.

description

string

IP restriction rule description.

headers

object

IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is ..

  • If the property is null or empty (default), all hosts(or lack of) are allowed.
  • A value is compared using ordinal-ignore-case (excluding port number).
  • Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com
  • Unicode host names are allowed but are converted to Punycode for matching.

X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is ..

  • If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.
  • If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.

X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match.

ipSecurityRestrictionsDefaultAction

string

Default action for main access restriction if no rules are matched.

scmIpSecurityRestrictions

[object]

IP security restrictions for scm.

ipAddress

string

IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.

subnetMask

string

Subnet mask for the range of IP addresses the restriction is valid for.

vnetSubnetResourceId

string

Virtual network resource id

vnetTrafficTag

number

(internal) Vnet traffic tag

subnetTrafficTag

number

(internal) Subnet traffic tag

action

string

Allow or Deny access for this IP range.

tag

string

Defines what this IP filter will be used for. This is to support IP filtering on proxies.

priority

number

Priority of IP restriction rule.

name

string

IP restriction rule name.

description

string

IP restriction rule description.

headers

object

IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is ..

  • If the property is null or empty (default), all hosts(or lack of) are allowed.
  • A value is compared using ordinal-ignore-case (excluding port number).
  • Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com
  • Unicode host names are allowed but are converted to Punycode for matching.

X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is ..

  • If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.
  • If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.

X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match.

scmIpSecurityRestrictionsDefaultAction

string

Default action for scm access restriction if no rules are matched.

scmIpSecurityRestrictionsUseMain

boolean

IP security restrictions for scm to use main.

http20Enabled

boolean

Http20Enabled: configures a web site to allow clients to connect over http2.0

minTlsVersion

string

MinTlsVersion: configures the minimum version of TLS required for SSL requests

scmMinTlsVersion

string

ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site

ftpsState

string

State of FTP / FTPS service

preWarmedInstanceCount

number

Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans

functionAppScaleLimit

number

Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans

elasticWebAppScaleLimit

number

Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true

healthCheckPath

string

Health check path

functionsRuntimeScaleMonitoringEnabled

boolean

Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status.

websiteTimeZone

string

Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones

minimumElasticInstanceCount

number

Number of minimum instance count for a site This setting only applies to the Elastic Plans

azureStorageAccounts

object

List of Azure Storage Accounts.

publicNetworkAccess

string

Property to allow or block all public traffic.

trafficManagerHostNames

[string]

Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

scmSiteAlsoStopped

boolean

true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

targetSwapSlot

string

Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

hostingEnvironmentProfile

object

App Service Environment to use for the app.

id

string

Resource ID of the App Service Environment.

name

string

Name of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

type

string

Resource type of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

clientAffinityEnabled

boolean

true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

clientCertEnabled

boolean

true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

clientCertMode

enum

This composes with ClientCertEnabled setting.

  • ClientCertEnabled: false means ClientCert is ignored.
  • ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
  • ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. Allowed enum values: Required,Optional,OptionalInteractiveUser

clientCertExclusionPaths

string

client certificate authentication comma-separated exclusion paths

hostNamesDisabled

boolean

true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

customDomainVerificationId

string

Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

outboundIpAddresses

string

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

possibleOutboundIpAddresses

string

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

containerSize

number

Size of the function container.

dailyMemoryTimeQuota

number

Maximum allowed daily memory-time quota (applicable on dynamic apps only).

suspendedTill

date-time

App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server.

maxNumberOfWorkers

number

Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server.

cloningInfo

object

If specified during app creation, the app is cloned from a source app.

correlationId

string

Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

overwrite

boolean

true to overwrite destination app; otherwise, false.

cloneCustomHostNames

boolean

true to clone custom hostnames from source app; otherwise, false.

cloneSourceControl

boolean

true to clone source control from source app; otherwise, false.

sourceWebAppId [required]

string

ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

sourceWebAppLocation

string

Location of source app ex: West US or North Europe

hostingEnvironment

string

App Service Environment.

appSettingsOverrides

object

Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.

configureLoadBalancing

boolean

true to configure load balancing for source and destination app.

trafficManagerProfileId

string

ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.

trafficManagerProfileName

string

Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

resourceGroup

string

Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

isDefaultContainer

boolean

true if the app is a default container; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

defaultHostName

string

Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

slotSwapStatus

object

Status of the last deployment slot swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

timestampUtc

date-time

The time the last successful slot swap completed. NOTE: This property will not be serialized. It can only be populated by the server.

sourceSlotName

string

The source slot of the last swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

destinationSlotName

string

The destination slot of the last swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

httpsOnly

boolean

HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

redundancyMode

enum

Site redundancy mode Allowed enum values: None,Manual,Failover,ActiveActive,GeoRedundant

inProgressOperationId

string

Specifies an operation id if this site has a pending operation. NOTE: This property will not be serialized. It can only be populated by the server.

publicNetworkAccess

string

Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.

storageAccountRequired

boolean

Checks if Customer provided storage account is required

keyVaultReferenceIdentity

string

Identity to use for Key Vault Reference authentication.

virtualNetworkSubnetId

string

Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

managedEnvironmentId

string

Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}