Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@datafire/azure_web_webapps

DataFire4MIT3.0.0

DataFire integration for WebApps API Client

readme

@datafire/azure_web_webapps

Client library for WebApps API Client

Installation and Usage

npm install --save @datafire/azure_web_webapps
let azure_web_webapps = require('@datafire/azure_web_webapps').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

WebApps_List

Get all apps for a subscription.

azure_web_webapps.WebApps_List({
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Collection of App Service apps.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: A web app, a mobile app backend, or an API app.
        • identity object: Managed service identity.
          • principalId string: Principal Id of managed service identity.
          • tenantId string: Tenant of managed service identity.
          • type string (values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None): Type of managed service identity.
          • 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}
        • properties object: Site resource specific properties
          • availabilityState string (values: Normal, Limited, DisasterRecoveryMode): Management information availability state for the app.
          • 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.
          • clientCertExclusionPaths string: client certificate authentication comma-separated exclusion paths
          • cloningInfo object: Information needed for cloning operation.
            • appSettingsOverrides object: Application setting overrides for cloned app. If specified, these settings override the settings cloned
            • cloneCustomHostNames boolean: true to clone custom hostnames from source app; otherwise, false.
            • cloneSourceControl boolean: true to clone source control from source app; otherwise, false.
            • configureLoadBalancing boolean: true to configure load balancing for source and destination app.
            • correlationId string: Correlation ID of cloning operation. This ID ties multiple cloning operations
            • hostingEnvironment string: App Service Environment.
            • overwrite boolean: true to overwrite destination app; otherwise, false.
            • sourceWebAppId required string: ARM resource ID of the source app. App resource ID is of the form
            • sourceWebAppLocation string: Location of source app ex: West US or North Europe
            • trafficManagerProfileId string: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
            • trafficManagerProfileName string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
          • containerSize integer: Size of the function container.
          • dailyMemoryTimeQuota integer: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
          • defaultHostName string: Default hostname of the app. Read-only.
          • enabled boolean: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
          • enabledHostNames array: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
            • items string
          • geoDistributions array: GeoDistributions for this site
            • items object: A global distribution definition.
          • hostNameSslStates array: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
            • items object: SSL-enabled hostname.
          • hostNames array: Hostnames associated with the app.
            • items string
          • hostNamesDisabled boolean: true to disable the public hostnames of the app; otherwise, false.
          • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
            • id string: Resource ID of the App Service Environment.
            • name string: Name of the App Service Environment.
            • type string: Resource type of the App Service Environment.
          • httpsOnly boolean: HttpsOnly: configures a web site to accept only https requests. Issues redirect for
          • hyperV boolean: Hyper-V sandbox.
          • inProgressOperationId string: Specifies an operation id if this site has a pending operation.
          • isDefaultContainer boolean: true if the app is a default container; otherwise, false.
          • isXenon boolean: Obsolete: Hyper-V sandbox.
          • lastModifiedTimeUtc string: Last time the app was modified, in UTC. Read-only.
          • maxNumberOfWorkers integer: Maximum number of workers.
          • 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.
          • possibleOutboundIpAddresses string: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.
          • redundancyMode string (values: None, Manual, Failover, ActiveActive, GeoRedundant): Site redundancy mode
          • repositorySiteName string: Name of the repository site.
          • reserved boolean: true if reserved; otherwise, false.
          • resourceGroup string: Name of the resource group the app belongs to. Read-only.
          • scmSiteAlsoStopped boolean: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
          • serverFarmId string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
          • siteConfig object: Configuration of an App Service app.
            • alwaysOn boolean: true if Always On is enabled; otherwise, false.
            • apiDefinition object: Information about the formal API definition for the app.
            • appCommandLine string: App command line to launch.
            • appSettings array: Application settings.
            • autoHealEnabled boolean: true if Auto Heal is enabled; otherwise, false.
            • autoHealRules object: Rules that can be defined for auto-heal.
            • autoSwapSlotName string: Auto-swap slot name.
            • azureStorageAccounts object: User-provided Azure storage accounts.
            • connectionStrings array: Connection strings.
            • cors object: Cross-Origin Resource Sharing (CORS) settings for the app.
            • defaultDocuments array: Default documents.
            • detailedErrorLoggingEnabled boolean: true if detailed error logging is enabled; otherwise, false.
            • documentRoot string: Document root.
            • experiments object: Routing rules in production experiments.
            • ftpsState string (values: AllAllowed, FtpsOnly, Disabled): State of FTP / FTPS service
            • handlerMappings array: Handler mappings.
            • http20Enabled boolean: Http20Enabled: configures a web site to allow clients to connect over http2.0
            • httpLoggingEnabled boolean: true if HTTP logging is enabled; otherwise, false.
            • ipSecurityRestrictions array: IP security restrictions for main.
            • javaContainer string: Java container.
            • javaContainerVersion string: Java container version.
            • javaVersion string: Java version.
            • limits object: Metric limits set on an app.
            • linuxFxVersion string: Linux App Framework and version
            • loadBalancing string (values: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash): Site load balancing.
            • localMySqlEnabled boolean: true to enable local MySQL; otherwise, false.
            • logsDirectorySizeLimit integer: HTTP logs directory size limit.
            • machineKey object: MachineKey of an app.
            • managedPipelineMode string (values: Integrated, Classic): Managed pipeline mode.
            • managedServiceIdentityId integer: Managed Service Identity Id
            • minTlsVersion string (values: 1.0, 1.1, 1.2): MinTlsVersion: configures the minimum version of TLS required for SSL requests
            • netFrameworkVersion string: .NET Framework version.
            • nodeVersion string: Version of Node.js.
            • numberOfWorkers integer: Number of workers.
            • phpVersion string: Version of PHP.
            • publishingUsername string: Publishing user name.
            • push object: Push settings for the App.
            • pythonVersion string: Version of Python.
            • remoteDebuggingEnabled boolean: true if remote debugging is enabled; otherwise, false.
            • remoteDebuggingVersion string: Remote debugging version.
            • requestTracingEnabled boolean: true if request tracing is enabled; otherwise, false.
            • requestTracingExpirationTime string: Request tracing expiration time.
            • reservedInstanceCount integer: Number of reserved instances.
            • scmIpSecurityRestrictions array: IP security restrictions for scm.
            • scmIpSecurityRestrictionsUseMain boolean: IP security restrictions for scm to use main.
            • scmType string (values: None, Dropbox, Tfs, LocalGit, GitHub, CodePlexGit, CodePlexHg, BitbucketGit, BitbucketHg, ExternalGit, ExternalHg, OneDrive, VSO): SCM type.
            • tracingOptions string: Tracing options.
            • use32BitWorkerProcess boolean: true to use 32-bit worker process; otherwise, false.
            • virtualApplications array: Virtual applications.
            • vnetName string: Virtual Network name.
            • webSocketsEnabled boolean: true if WebSocket is enabled; otherwise, false.
            • windowsFxVersion string: Xenon App Framework and version
            • xManagedServiceIdentityId integer: Explicit Managed Service Identity Id
          • slotSwapStatus object: The status of the last successful slot swap operation.
            • destinationSlotName string: The destination slot of the last swap operation.
            • sourceSlotName string: The source slot of the last swap operation.
            • timestampUtc string: The time the last successful slot swap completed.
          • state string: Current state of the app.
          • suspendedTill string: App suspended till in case memory-time quota is exceeded.
          • targetSwapSlot string: Specifies which deployment slot this app will swap into. Read-only.
          • trafficManagerHostNames array: Azure Traffic Manager hostnames associated with the app. Read-only.
            • items string
          • usageState string (values: Normal, Exceeded): State indicating whether the app has exceeded its quota usage. Read-only.
        • id string: Resource Id.
        • kind string: Kind of resource.
        • location required string: Resource Location.
        • name string: Resource Name.
        • tags object: Resource tags.
        • type string: Resource type.

WebApps_ListByResourceGroup

Gets all web, mobile, and API apps in the specified resource group.

azure_web_webapps.WebApps_ListByResourceGroup({
  "resourceGroupName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • includeSlots boolean: Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: Collection of App Service apps.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.
      • items object: A web app, a mobile app backend, or an API app.
        • identity object: Managed service identity.
          • principalId string: Principal Id of managed service identity.
          • tenantId string: Tenant of managed service identity.
          • type string (values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None): Type of managed service identity.
          • 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}
        • properties object: Site resource specific properties
          • availabilityState string (values: Normal, Limited, DisasterRecoveryMode): Management information availability state for the app.
          • 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.
          • clientCertExclusionPaths string: client certificate authentication comma-separated exclusion paths
          • cloningInfo object: Information needed for cloning operation.
            • appSettingsOverrides object: Application setting overrides for cloned app. If specified, these settings override the settings cloned
            • cloneCustomHostNames boolean: true to clone custom hostnames from source app; otherwise, false.
            • cloneSourceControl boolean: true to clone source control from source app; otherwise, false.
            • configureLoadBalancing boolean: true to configure load balancing for source and destination app.
            • correlationId string: Correlation ID of cloning operation. This ID ties multiple cloning operations
            • hostingEnvironment string: App Service Environment.
            • overwrite boolean: true to overwrite destination app; otherwise, false.
            • sourceWebAppId required string: ARM resource ID of the source app. App resource ID is of the form
            • sourceWebAppLocation string: Location of source app ex: West US or North Europe
            • trafficManagerProfileId string: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
            • trafficManagerProfileName string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
          • containerSize integer: Size of the function container.
          • dailyMemoryTimeQuota integer: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
          • defaultHostName string: Default hostname of the app. Read-only.
          • enabled boolean: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
          • enabledHostNames array: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
            • items string
          • geoDistributions array: GeoDistributions for this site
            • items object: A global distribution definition.
          • hostNameSslStates array: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
            • items object: SSL-enabled hostname.
          • hostNames array: Hostnames associated with the app.
            • items string
          • hostNamesDisabled boolean: true to disable the public hostnames of the app; otherwise, false.
          • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
            • id string: Resource ID of the App Service Environment.
            • name string: Name of the App Service Environment.
            • type string: Resource type of the App Service Environment.
          • httpsOnly boolean: HttpsOnly: configures a web site to accept only https requests. Issues redirect for
          • hyperV boolean: Hyper-V sandbox.
          • inProgressOperationId string: Specifies an operation id if this site has a pending operation.
          • isDefaultContainer boolean: true if the app is a default container; otherwise, false.
          • isXenon boolean: Obsolete: Hyper-V sandbox.
          • lastModifiedTimeUtc string: Last time the app was modified, in UTC. Read-only.
          • maxNumberOfWorkers integer: Maximum number of workers.
          • 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.
          • possibleOutboundIpAddresses string: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.
          • redundancyMode string (values: None, Manual, Failover, ActiveActive, GeoRedundant): Site redundancy mode
          • repositorySiteName string: Name of the repository site.
          • reserved boolean: true if reserved; otherwise, false.
          • resourceGroup string: Name of the resource group the app belongs to. Read-only.
          • scmSiteAlsoStopped boolean: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
          • serverFarmId string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
          • siteConfig object: Configuration of an App Service app.
            • alwaysOn boolean: true if Always On is enabled; otherwise, false.
            • apiDefinition object: Information about the formal API definition for the app.
            • appCommandLine string: App command line to launch.
            • appSettings array: Application settings.
            • autoHealEnabled boolean: true if Auto Heal is enabled; otherwise, false.
            • autoHealRules object: Rules that can be defined for auto-heal.
            • autoSwapSlotName string: Auto-swap slot name.
            • azureStorageAccounts object: User-provided Azure storage accounts.
            • connectionStrings array: Connection strings.
            • cors object: Cross-Origin Resource Sharing (CORS) settings for the app.
            • defaultDocuments array: Default documents.
            • detailedErrorLoggingEnabled boolean: true if detailed error logging is enabled; otherwise, false.
            • documentRoot string: Document root.
            • experiments object: Routing rules in production experiments.
            • ftpsState string (values: AllAllowed, FtpsOnly, Disabled): State of FTP / FTPS service
            • handlerMappings array: Handler mappings.
            • http20Enabled boolean: Http20Enabled: configures a web site to allow clients to connect over http2.0
            • httpLoggingEnabled boolean: true if HTTP logging is enabled; otherwise, false.
            • ipSecurityRestrictions array: IP security restrictions for main.
            • javaContainer string: Java container.
            • javaContainerVersion string: Java container version.
            • javaVersion string: Java version.
            • limits object: Metric limits set on an app.
            • linuxFxVersion string: Linux App Framework and version
            • loadBalancing string (values: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash): Site load balancing.
            • localMySqlEnabled boolean: true to enable local MySQL; otherwise, false.
            • logsDirectorySizeLimit integer: HTTP logs directory size limit.
            • machineKey object: MachineKey of an app.
            • managedPipelineMode string (values: Integrated, Classic): Managed pipeline mode.
            • managedServiceIdentityId integer: Managed Service Identity Id
            • minTlsVersion string (values: 1.0, 1.1, 1.2): MinTlsVersion: configures the minimum version of TLS required for SSL requests
            • netFrameworkVersion string: .NET Framework version.
            • nodeVersion string: Version of Node.js.
            • numberOfWorkers integer: Number of workers.
            • phpVersion string: Version of PHP.
            • publishingUsername string: Publishing user name.
            • push object: Push settings for the App.
            • pythonVersion string: Version of Python.
            • remoteDebuggingEnabled boolean: true if remote debugging is enabled; otherwise, false.
            • remoteDebuggingVersion string: Remote debugging version.
            • requestTracingEnabled boolean: true if request tracing is enabled; otherwise, false.
            • requestTracingExpirationTime string: Request tracing expiration time.
            • reservedInstanceCount integer: Number of reserved instances.
            • scmIpSecurityRestrictions array: IP security restrictions for scm.
            • scmIpSecurityRestrictionsUseMain boolean: IP security restrictions for scm to use main.
            • scmType string (values: None, Dropbox, Tfs, LocalGit, GitHub, CodePlexGit, CodePlexHg, BitbucketGit, BitbucketHg, ExternalGit, ExternalHg, OneDrive, VSO): SCM type.
            • tracingOptions string: Tracing options.
            • use32BitWorkerProcess boolean: true to use 32-bit worker process; otherwise, false.
            • virtualApplications array: Virtual applications.
            • vnetName string: Virtual Network name.
            • webSocketsEnabled boolean: true if WebSocket is enabled; otherwise, false.
            • windowsFxVersion string: Xenon App Framework and version
            • xManagedServiceIdentityId integer: Explicit Managed Service Identity Id
          • slotSwapStatus object: The status of the last successful slot swap operation.
            • destinationSlotName string: The destination slot of the last swap operation.
            • sourceSlotName string: The source slot of the last swap operation.
            • timestampUtc string: The time the last successful slot swap completed.
          • state string: Current state of the app.
          • suspendedTill string: App suspended till in case memory-time quota is exceeded.
          • targetSwapSlot string: Specifies which deployment slot this app will swap into. Read-only.
          • trafficManagerHostNames array: Azure Traffic Manager hostnames associated with the app. Read-only.
            • items string
          • usageState string (values: Normal, Exceeded): State indicating whether the app has exceeded its quota usage. Read-only.
        • id string: Resource Id.
        • kind string: Kind of resource.
        • location required string: Resource Location.
        • name string: Resource Name.
        • tags object: Resource tags.
        • type string: Resource type.

WebApps_Delete

Deletes a web, mobile, or API app, or one of the deployment slots.

azure_web_webapps.WebApps_Delete({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the app to delete.
    • deleteMetrics boolean: If true, web app metrics are also deleted.
    • deleteEmptyServerFarm boolean: Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

WebApps_Get

Gets the details of a web, mobile, or API app.

azure_web_webapps.WebApps_Get({
  "resourceGroupName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Name of the app.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: A web app, a mobile app backend, or an API app.
    • identity object: Managed service identity.
      • principalId string: Principal Id of managed service identity.
      • tenantId string: Tenant of managed service identity.
      • type string (values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None): Type of managed service identity.
      • 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}
    • properties object: Site resource specific properties
      • availabilityState string (values: Normal, Limited, DisasterRecoveryMode): Management information availability state for the app.
      • 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.
      • clientCertExclusionPaths string: client certificate authentication comma-separated exclusion paths
      • cloningInfo object: Information needed for cloning operation.
        • appSettingsOverrides object: Application setting overrides for cloned app. If specified, these settings override the settings cloned
        • cloneCustomHostNames boolean: true to clone custom hostnames from source app; otherwise, false.
        • cloneSourceControl boolean: true to clone source control from source app; otherwise, false.
        • configureLoadBalancing boolean: true to configure load balancing for source and destination app.
        • correlationId string: Correlation ID of cloning operation. This ID ties multiple cloning operations
        • hostingEnvironment string: App Service Environment.
        • overwrite boolean: true to overwrite destination app; otherwise, false.
        • sourceWebAppId required string: ARM resource ID of the source app. App resource ID is of the form
        • sourceWebAppLocation string: Location of source app ex: West US or North Europe
        • trafficManagerProfileId string: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
        • trafficManagerProfileName string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
      • containerSize integer: Size of the function container.
      • dailyMemoryTimeQuota integer: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
      • defaultHostName string: Default hostname of the app. Read-only.
      • enabled boolean: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
      • enabledHostNames array: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
        • items string
      • geoDistributions array: GeoDistributions for this site
        • items object: A global distribution definition.
          • location string: Location.
          • numberOfWorkers integer: NumberOfWorkers.
      • hostNameSslStates array: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
        • items object: SSL-enabled hostname.
          • hostType string (values: Standard, Repository): Indicates whether the hostname is a standard or repository hostname.
          • name string: Hostname.
          • sslState string (values: Disabled, SniEnabled, IpBasedEnabled): SSL type.
          • thumbprint string: SSL certificate thumbprint.
          • toUpdate boolean: Set to true to update existing hostname.
          • virtualIP string: Virtual IP address assigned to the hostname if IP based SSL is enabled.
      • hostNames array: Hostnames associated with the app.
        • items string
      • hostNamesDisabled boolean: true to disable the public hostnames of the app; otherwise, false.
      • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
        • id string: Resource ID of the App Service Environment.
        • name string: Name of the App Service Environment.
        • type string: Resource type of the App Service Environment.
      • httpsOnly boolean: HttpsOnly: configures a web site to accept only https requests. Issues redirect for
      • hyperV boolean: Hyper-V sandbox.
      • inProgressOperationId string: Specifies an operation id if this site has a pending operation.
      • isDefaultContainer boolean: true if the app is a default container; otherwise, false.
      • isXenon boolean: Obsolete: Hyper-V sandbox.
      • lastModifiedTimeUtc string: Last time the app was modified, in UTC. Read-only.
      • maxNumberOfWorkers integer: Maximum number of workers.
      • 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.
      • possibleOutboundIpAddresses string: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.
      • redundancyMode string (values: None, Manual, Failover, ActiveActive, GeoRedundant): Site redundancy mode
      • repositorySiteName string: Name of the repository site.
      • reserved boolean: true if reserved; otherwise, false.
      • resourceGroup string: Name of the resource group the app belongs to. Read-only.
      • scmSiteAlsoStopped boolean: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
      • serverFarmId string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
      • siteConfig object: Configuration of an App Service app.
        • alwaysOn boolean: true if Always On is enabled; otherwise, false.
        • apiDefinition object: Information about the formal API definition for the app.
          • url string: The URL of the API definition.
        • appCommandLine string: App command line to launch.
        • appSettings array: Application settings.
          • items object: Name value pair.
            • name string: Pair name.
            • value string: Pair value.
        • autoHealEnabled boolean: true if Auto Heal is enabled; otherwise, false.
        • autoHealRules object: Rules that can be defined for auto-heal.
          • actions object: Actions which to take by the auto-heal module when a rule is triggered.
            • actionType string (values: Recycle, LogEvent, CustomAction): Predefined action to be taken.
            • customAction object: Custom action to be executed
            • minProcessExecutionTime string: Minimum time the process must execute
          • triggers object: Triggers for auto-heal.
            • privateBytesInKB integer: A rule based on private bytes.
            • requests object: Trigger based on total requests.
            • slowRequests object: Trigger based on request execution time.
            • statusCodes array: A rule based on status codes.
        • autoSwapSlotName string: Auto-swap slot name.
        • azureStorageAccounts object: User-provided Azure storage accounts.
        • connectionStrings array: Connection strings.
          • items object: Database connection string information.
            • connectionString string: Connection string value.
            • name string: Name of connection string.
            • type string (values: MySql, SQLServer, SQLAzure, Custom, NotificationHub, ServiceBus, EventHub, ApiHub, DocDb, RedisCache, PostgreSQL): Type of database.
        • cors object: Cross-Origin Resource Sharing (CORS) settings for the app.
          • allowedOrigins array: Gets or sets the list of origins that should be allowed to make cross-origin
            • items string
          • supportCredentials boolean: Gets or sets whether CORS requests with credentials are allowed. See
        • defaultDocuments array: Default documents.
          • items string
        • detailedErrorLoggingEnabled boolean: true if detailed error logging is enabled; otherwise, false.
        • documentRoot string: Document root.
        • experiments object: Routing rules in production experiments.
          • rampUpRules array: List of ramp-up rules.
            • items object: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.
        • ftpsState string (values: AllAllowed, FtpsOnly, Disabled): State of FTP / FTPS service
        • handlerMappings array: Handler mappings.
          • items object: The IIS handler mappings used to define which handler processes HTTP requests with certain extension.
            • arguments string: Command-line arguments to be passed to the script processor.
            • extension string: Requests with this extension will be handled using the specified FastCGI application.
            • scriptProcessor string: The absolute path to the FastCGI application.
        • http20Enabled boolean: Http20Enabled: configures a web site to allow clients to connect over http2.0
        • httpLoggingEnabled boolean: true if HTTP logging is enabled; otherwise, false.
        • ipSecurityRestrictions array: IP security restrictions for main.
          • items object: IP security restriction on an app.
            • action string: Allow or Deny access for this IP range.
            • description string: IP restriction rule description.
            • ipAddress string: IP address the security restriction is valid for.
            • name string: IP restriction rule name.
            • priority integer: Priority of IP restriction rule.
            • subnetMask string: Subnet mask for the range of IP addresses the restriction is valid for.
            • subnetTrafficTag integer: (internal) Subnet traffic tag
            • tag string (values: Default, XffProxy): Defines what this IP filter will be used for. This is to support IP filtering on proxies.
            • vnetSubnetResourceId string: Virtual network resource id
            • vnetTrafficTag integer: (internal) Vnet traffic tag
        • javaContainer string: Java container.
        • javaContainerVersion string: Java container version.
        • javaVersion string: Java version.
        • limits object: Metric limits set on an app.
          • maxDiskSizeInMb integer: Maximum allowed disk size usage in MB.
          • maxMemoryInMb integer: Maximum allowed memory usage in MB.
          • maxPercentageCpu number: Maximum allowed CPU usage percentage.
        • linuxFxVersion string: Linux App Framework and version
        • loadBalancing string (values: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash): Site load balancing.
        • localMySqlEnabled boolean: true to enable local MySQL; otherwise, false.
        • logsDirectorySizeLimit integer: HTTP logs directory size limit.
        • machineKey object: MachineKey of an app.
          • decryption string: Algorithm used for decryption.
          • decryptionKey string: Decryption key.
          • validation string: MachineKey validation.
          • validationKey string: Validation key.
        • managedPipelineMode string (values: Integrated, Classic): Managed pipeline mode.
        • managedServiceIdentityId integer: Managed Service Identity Id
        • minTlsVersion string (values: 1.0, 1.1, 1.2): MinTlsVersion: configures the minimum version of TLS required for SSL requests
        • netFrameworkVersion string: .NET Framework version.
        • nodeVersion string: Version of Node.js.
        • numberOfWorkers integer: Number of workers.
        • phpVersion string: Version of PHP.
        • publishingUsername string: Publishing user name.
        • push object: Push settings for the App.
          • properties object: PushSettings resource specific properties
            • 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.
            • isPushEnabled required 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.
          • id string: Resource Id.
          • kind string: Kind of resource.
          • name string: Resource Name.
          • type string: Resource type.
        • pythonVersion string: Version of Python.
        • remoteDebuggingEnabled boolean: true if remote debugging is enabled; otherwise, false.
        • remoteDebuggingVersion string: Remote debugging version.
        • requestTracingEnabled boolean: true if request tracing is enabled; otherwise, false.
        • requestTracingExpirationTime string: Request tracing expiration time.
        • reservedInstanceCount integer: Number of reserved instances.
        • scmIpSecurityRestrictions array: IP security restrictions for scm.
          • items object: IP security restriction on an app.
            • action string: Allow or Deny access for this IP range.
            • description string: IP restriction rule description.
            • ipAddress string: IP address the security restriction is valid for.
            • name string: IP restriction rule name.
            • priority integer: Priority of IP restriction rule.
            • subnetMask string: Subnet mask for the range of IP addresses the restriction is valid for.
            • subnetTrafficTag integer: (internal) Subnet traffic tag
            • tag string (values: Default, XffProxy): Defines what this IP filter will be used for. This is to support IP filtering on proxies.
            • vnetSubnetResourceId string: Virtual network resource id
            • vnetTrafficTag integer: (internal) Vnet traffic tag
        • scmIpSecurityRestrictionsUseMain boolean: IP security restrictions for scm to use main.
        • scmType string (values: None, Dropbox, Tfs, LocalGit, GitHub, CodePlexGit, CodePlexHg, BitbucketGit, BitbucketHg, ExternalGit, ExternalHg, OneDrive, VSO): SCM type.
        • tracingOptions string: Tracing options.
        • use32BitWorkerProcess boolean: true to use 32-bit worker process; otherwise, false.
        • virtualApplications array: Virtual applications.
          • items object: Virtual application in an app.
            • physicalPath string: Physical path.
            • preloadEnabled boolean: true if preloading is enabled; otherwise, false.
            • virtualDirectories array: Virtual directories for virtual application.
            • virtualPath string: Virtual path.
        • vnetName string: Virtual Network name.
        • webSocketsEnabled boolean: true if WebSocket is enabled; otherwise, false.
        • windowsFxVersion string: Xenon App Framework and version
        • xManagedServiceIdentityId integer: Explicit Managed Service Identity Id
      • slotSwapStatus object: The status of the last successful slot swap operation.
        • destinationSlotName string: The destination slot of the last swap operation.
        • sourceSlotName string: The source slot of the last swap operation.
        • timestampUtc string: The time the last successful slot swap completed.
      • state string: Current state of the app.
      • suspendedTill string: App suspended till in case memory-time quota is exceeded.
      • targetSwapSlot string: Specifies which deployment slot this app will swap into. Read-only.
      • trafficManagerHostNames array: Azure Traffic Manager hostnames associated with the app. Read-only.
        • items string
      • usageState string (values: Normal, Exceeded): State indicating whether the app has exceeded its quota usage. Read-only.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • location required string: Resource Location.
    • name string: Resource Name.
    • tags object: Resource tags.
    • type string: Resource type.

WebApps_Update

Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.

azure_web_webapps.WebApps_Update({
  "resourceGroupName": "",
  "name": "",
  "siteEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.
    • siteEnvelope required SitePatchResource
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

  • output object: A web app, a mobile app backend, or an API app.
    • identity object: Managed service identity.
      • principalId string: Principal Id of managed service identity.
      • tenantId string: Tenant of managed service identity.
      • type string (values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None): Type of managed service identity.
      • 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}
    • properties object: Site resource specific properties
      • availabilityState string (values: Normal, Limited, DisasterRecoveryMode): Management information availability state for the app.
      • 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.
      • clientCertExclusionPaths string: client certificate authentication comma-separated exclusion paths
      • cloningInfo object: Information needed for cloning operation.
        • appSettingsOverrides object: Application setting overrides for cloned app. If specified, these settings override the settings cloned
        • cloneCustomHostNames boolean: true to clone custom hostnames from source app; otherwise, false.
        • cloneSourceControl boolean: true to clone source control from source app; otherwise, false.
        • configureLoadBalancing boolean: true to configure load balancing for source and destination app.
        • correlationId string: Correlation ID of cloning operation. This ID ties multiple cloning operations
        • hostingEnvironment string: App Service Environment.
        • overwrite boolean: true to overwrite destination app; otherwise, false.
        • sourceWebAppId required string: ARM resource ID of the source app. App resource ID is of the form
        • sourceWebAppLocation string: Location of source app ex: West US or North Europe
        • trafficManagerProfileId string: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
        • trafficManagerProfileName string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
      • containerSize integer: Size of the function container.
      • dailyMemoryTimeQuota integer: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
      • defaultHostName string: Default hostname of the app. Read-only.
      • enabled boolean: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
      • enabledHostNames array: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
        • items string
      • geoDistributions array: GeoDistributions for this site
        • items object: A global distribution definition.
          • location string: Location.
          • numberOfWorkers integer: NumberOfWorkers.
      • hostNameSslStates array: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
        • items object: SSL-enabled hostname.
          • hostType string (values: Standard, Repository): Indicates whether the hostname is a standard or repository hostname.
          • name string: Hostname.
          • sslState string (values: Disabled, SniEnabled, IpBasedEnabled): SSL type.
          • thumbprint string: SSL certificate thumbprint.
          • toUpdate boolean: Set to true to update existing hostname.
          • virtualIP string: Virtual IP address assigned to the hostname if IP based SSL is enabled.
      • hostNames array: Hostnames associated with the app.
        • items string
      • hostNamesDisabled boolean: true to disable the public hostnames of the app; otherwise, false.
      • hostingEnvironmentProfile object: Specification for an App Service Environment to use for this resource.
        • id string: Resource ID of the App Service Environment.
        • name string: Name of the App Service Environment.
        • type string: Resource type of the App Service Environment.
      • httpsOnly boolean: HttpsOnly: configures a web site to accept only https requests. Issues redirect for
      • hyperV boolean: Hyper-V sandbox.
      • inProgressOperationId string: Specifies an operation id if this site has a pending operation.
      • isDefaultContainer boolean: true if the app is a default container; otherwise, false.
      • isXenon boolean: Obsolete: Hyper-V sandbox.
      • lastModifiedTimeUtc string: Last time the app was modified, in UTC. Read-only.
      • maxNumberOfWorkers integer: Maximum number of workers.
      • 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.
      • possibleOutboundIpAddresses string: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.
      • redundancyMode string (values: None, Manual, Failover, ActiveActive, GeoRedundant): Site redundancy mode
      • repositorySiteName string: Name of the repository site.
      • reserved boolean: true if reserved; otherwise, false.
      • resourceGroup string: Name of the resource group the app belongs to. Read-only.
      • scmSiteAlsoStopped boolean: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
      • serverFarmId string: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
      • siteConfig object: Configuration of an App Service app.
        • alwaysOn boolean: true if Always On is enabled; otherwise, false.
        • apiDefinition object: Information about the formal API definition for the app.
          • url string: The URL of the API definition.
        • appCommandLine string: App command line to launch.
        • appSettings array: Application settings.
          • items object: Name value pair.
            • name string: Pair name.
            • value string: Pair value.
        • autoHealEnabled boolean: true if Auto Heal is enabled; otherwise, false.
        • autoHealRules object: Rules that can be defined for auto-heal.
          • actions object: Actions which to take by the auto-heal module when a rule is triggered.
            • actionType string (values: Recycle, LogEvent, CustomAction): Predefined action to be taken.
            • customAction object: Custom action to be executed
            • minProcessExecutionTime string: Minimum time the process must execute
          • triggers object: Triggers for auto-heal.
            • privateBytesInKB integer: A rule based on private bytes.
            • requests object: Trigger based on total requests.
            • slowRequests object: Trigger based on request execution time.
            • statusCodes array: A rule based on status codes.
        • autoSwapSlotName string: Auto-swap slot name.
        • azureStorageAccounts object: User-provided Azure storage accounts.
        • connectionStrings array: Connection strings.
          • items object: Database connection string information.
            • connectionString string: Connection string value.
            • name string: Name of connection string.
            • type string (values: MySql, SQLServer, SQLAzure, Custom, NotificationHub, ServiceBus, EventHub, ApiHub, DocDb, RedisCache, PostgreSQL): Type of database.
        • cors object: Cross-Origin Resource Sharing (CORS) settings for the app.
          • allowedOrigins array: Gets or sets the list of origins that should be allowed to make cross-origin
            • items string
          • supportCredentials boolean: Gets or sets whether CORS requests with credentials are allowed. See
        • defaultDocuments array: Default documents.
          • items string
        • detailedErrorLoggingEnabled boolean: true if detailed error logging is enabled; otherwise, false.
        • documentRoot string: Document root.
        • experiments object: Routing rules in production experiments.
          • rampUpRules array: List of ramp-up rules.
            • items object: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.
        • ftpsState string (values: AllAllowed, FtpsOnly, Disabled): State of FTP / FTPS service
        • handlerMappings array: Handler mappings.
          • items object: The IIS handler mappings used to define which handler processes HTTP requests with certain extension.
            • arguments string: Command-line arguments to be passed to the script processor.
            • extension string: Requests with this extension will be handled using the specified FastCGI application.
            • scriptProcessor string: The absolute path to the FastCGI application.
        • http20Enabled boolean: Http20Enabled: configures a web site to allow clients to connect over http2.0
        • httpLoggingEnabled boolean: true if HTTP logging is enabled; otherwise, false.
        • ipSecurityRestrictions array: IP security restrictions for main.
          • items object: IP security restriction on an app.
            • action string: Allow or Deny access for this IP range.
            • description string: IP restriction rule description.
            • ipAddress string: IP address the security restriction is valid for.
            • name string: IP restriction rule name.
            • priority integer: Priority of IP restriction rule.
            • subnetMask string: Subnet mask for the range of IP addresses the restriction is valid for.
            • subnetTrafficTag integer: (internal) Subnet traffic tag
            • tag string (values: Default, XffProxy): Defines what this IP filter will be used for. This is to support IP filtering on proxies.
            • vnetSubnetResourceId string: Virtual network resource id
            • vnetTrafficTag integer: (internal) Vnet traffic tag
        • javaContainer string: Java container.
        • javaContainerVersion string: Java container version.
        • javaVersion string: Java version.
        • limits object: Metric limits set on an app.
          • maxDiskSizeInMb integer: Maximum allowed disk size usage in MB.
          • maxMemoryInMb integer: Maximum allowed memory usage in MB.
          • maxPercentageCpu number: Maximum allowed CPU usage percentage.
        • linuxFxVersion string: Linux App Framework and version
        • loadBalancing string (values: WeightedRoundRobin, LeastRequests, LeastResponseTime, WeightedTotalTraffic, RequestHash): Site load balancing.
        • localMySqlEnabled boolean: true to enable local MySQL; otherwise, false.
        • logsDirectorySizeLimit integer: HTTP logs directory size limit.
        • machineKey object: MachineKey of an app.
          • decryption string: Algorithm used for decryption.
          • decryptionKey string: Decryption key.
          • validation string: MachineKey validation.
          • validationKey string: Validation key.
        • managedPipelineMode string (values: Integrated, Classic): Managed pipeline mode.
        • managedServiceIdentityId integer: Managed Service Identity Id
        • minTlsVersion string (values: 1.0, 1.1, 1.2): MinTlsVersion: configures the minimum version of TLS required for SSL requests
        • netFrameworkVersion string: .NET Framework version.
        • nodeVersion string: Version of Node.js.
        • numberOfWorkers integer: Number of workers.
        • phpVersion string: Version of PHP.
        • publishingUsername string: Publishing user name.
        • push object: Push settings for the App.
          • properties object: PushSettings resource specific properties
            • 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.
            • isPushEnabled required 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.
          • id string: Resource Id.
          • kind string: Kind of resource.
          • name string: Resource Name.
          • type string: Resource type.
        • pythonVersion string: Version of Python.
        • remoteDebuggingEnabled boolean: true if remote debugging is enabled; otherwise, false.
        • remoteDebuggingVersion string: Remote debugging version.
        • requestTracingEnabled boolean: true if request tracing is enabled; otherwise, false.
        • requestTracingExpirationTime string: Request tracing expiration time.
        • reservedInstanceCount integer: Number of reserved instances.
        • scmIpSecurityRestrictions array: IP security restrictions for scm.
          • items object: IP security restriction on an app.
            • action string: Allow or Deny access for this IP range.
            • description string: IP restriction rule description.
            • ipAddress string: IP address the security restriction is valid for.
            • name string: IP restriction rule name.
            • priority integer: Priority of IP restriction rule.
            • subnetMask string: Subnet mask for the range of IP addresses the restriction is valid for.
            • subnetTrafficTag integer: (internal) Subnet traffic tag
            • tag string (values: Default, XffProxy): Defines what this IP filter will be used for. This is to support IP filtering on proxies.
            • vnetSubnetResourceId string: Virtual network resource id
            • vnetTrafficTag integer: (internal) Vnet traffic tag
        • scmIpSecurityRestrictionsUseMain boolean: IP security restrictions for scm to use main.
        • scmType string (values: None, Dropbox, Tfs, LocalGit, GitHub, CodePlexGit, CodePlexHg, BitbucketGit, BitbucketHg, ExternalGit, ExternalHg, OneDrive, VSO): SCM type.
        • tracingOptions string: Tracing options.
        • use32BitWorkerProcess boolean: true to use 32-bit worker process; otherwise, false.
        • virtualApplications array: Virtual applications.
          • items object: Virtual application in an app.
            • physicalPath string: Physical path.
            • preloadEnabled boolean: true if preloading is enabled; otherwise, false.
            • virtualDirectories array: Virtual directories for virtual application.
            • virtualPath string: Virtual path.
        • vnetName string: Virtual Network name.
        • webSocketsEnabled boolean: true if WebSocket is enabled; otherwise, false.
        • windowsFxVersion string: Xenon App Framework and version
        • xManagedServiceIdentityId integer: Explicit Managed Service Identity Id
      • slotSwapStatus object: The status of the last successful slot swap operation.
        • destinationSlotName string: The destination slot of the last swap operation.
        • sourceSlotName string: The source slot of the last swap operation.
        • timestampUtc string: The time the last successful slot swap completed.
      • state string: Current state of the app.
      • suspendedTill string: App suspended till in case memory-time quota is exceeded.
      • targetSwapSlot string: Specifies which deployment slot this app will swap into. Read-only.
      • trafficManagerHostNames array: Azure Traffic Manager hostnames associated with the app. Read-only.
        • items string
      • usageState string (values: Normal, Exceeded): State indicating whether the app has exceeded its quota usage. Read-only.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • location required string: Resource Location.
    • name string: Resource Name.
    • tags object: Resource tags.
    • type string: Resource type.

WebApps_CreateOrUpdate

Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.

azure_web_webapps.WebApps_CreateOrUpdate({
  "resourceGroupName": "",
  "name": "",
  "siteEnvelope": {},
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • name required string: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.
    • siteEnvelope required object: A web app, a mobile app backend, or an API app.
      • identity object: Managed service identity.
        • principalId string: Principal Id of managed service identity.
        • tenantId string: Tenant of managed service identity.
        • type string (values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None): Type of managed service identity.
        • 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}
      • properties object: Site resource specific properties
        • availabilityState string (values: Normal, Limited, DisasterRecoveryMode): Management information availability state for the app.
        • 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.
        • clientCertExclusionPaths string: client certificate authentication comma-separated exclusion paths
        • cloningInfo object: Information needed for cloning operation.
          • appSettingsOverrides object: Application setting overrides for cloned app. If specified, these settings override the settings cloned
          • cloneCustomHostNames boolean: true to clone custom hostnames from source app; otherwise, false.
          • cloneSourceControl boolean: true to clone source control from source app; otherwise, false.
          • configureLoadBalancing boolean: true to configure load balancing for source and destination app.
          • correlationId string: Correlation ID of cloning operation. This ID ties multiple cloning operations
          • hostingEnvironment string: App Service Environment.
          • overwrite boolean: true to overwrite destination app; otherwise, false.
          • sourceWebAppId required string: ARM resource ID of the source app. App resource ID is of the form
          • sourceWebAppLocation string: Location of source app ex: West US or North Europe
          • trafficManagerProfileId string: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
          • trafficManagerProfileName string: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile d