Class AppService

Manages an App Service (within an App Service Plan).

Note: When using Slots - the app_settings, connection_string and site_config blocks on the azure.appservice.AppService resource will be overwritten when promoting a Slot using the azure.appservice.ActiveSlot resource.

Inheritance
System.Object
Resource
CustomResource
AppService
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Azure.AppService
Assembly: Pulumi.Azure.dll
Syntax
public class AppService : CustomResource

Constructors

View Source

AppService(String, AppServiceArgs, CustomResourceOptions)

Create a AppService resource with the given unique name, arguments, and options.

Declaration
public AppService(string name, AppServiceArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
AppServiceArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AppServicePlanId

The ID of the App Service Plan within which to create this App Service.

Declaration
public Output<string> AppServicePlanId { get; }
Property Value
Type Description
Output<System.String>
View Source

AppSettings

A key-value pair of App Settings.

Declaration
public Output<ImmutableDictionary<string, string>> AppSettings { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>
View Source

AuthSettings

A auth_settings block as defined below.

Declaration
public Output<AppServiceAuthSettings> AuthSettings { get; }
Property Value
Type Description
Output<AppServiceAuthSettings>
View Source

Backup

A backup block as defined below.

Declaration
public Output<AppServiceBackup> Backup { get; }
Property Value
Type Description
Output<AppServiceBackup>
View Source

ClientAffinityEnabled

Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

Declaration
public Output<bool> ClientAffinityEnabled { get; }
Property Value
Type Description
Output<System.Boolean>
View Source

ClientCertEnabled

Does the App Service require client certificates for incoming requests? Defaults to false.

Declaration
public Output<bool?> ClientCertEnabled { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

ConnectionStrings

One or more connection_string blocks as defined below.

Declaration
public Output<ImmutableArray<AppServiceConnectionString>> ConnectionStrings { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<AppServiceConnectionString>>
View Source

DefaultSiteHostname

The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

Declaration
public Output<string> DefaultSiteHostname { get; }
Property Value
Type Description
Output<System.String>
View Source

Enabled

Is the App Service Enabled?

Declaration
public Output<bool?> Enabled { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

HttpsOnly

Can the App Service only be accessed via HTTPS? Defaults to false.

Declaration
public Output<bool?> HttpsOnly { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Identity

A Managed Service Identity block as defined below.

Declaration
public Output<AppServiceIdentity> Identity { get; }
Property Value
Type Description
Output<AppServiceIdentity>
View Source

Location

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

Declaration
public Output<string> Location { get; }
Property Value
Type Description
Output<System.String>
View Source

Logs

A logs block as defined below.

Declaration
public Output<AppServiceLogs> Logs { get; }
Property Value
Type Description
Output<AppServiceLogs>
View Source

Name

Specifies the name of the App Service. Changing this forces a new resource to be created.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

OutboundIpAddresses

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12

Declaration
public Output<string> OutboundIpAddresses { get; }
Property Value
Type Description
Output<System.String>
View Source

PossibleOutboundIpAddresses

A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12,52.143.43.17 - not all of which are necessarily in use. Superset of outbound_ip_addresses.

Declaration
public Output<string> PossibleOutboundIpAddresses { get; }
Property Value
Type Description
Output<System.String>
View Source

ResourceGroupName

The name of the resource group in which to create the App Service.

Declaration
public Output<string> ResourceGroupName { get; }
Property Value
Type Description
Output<System.String>
View Source

SiteConfig

A site_config block as defined below.

Declaration
public Output<AppServiceSiteConfig> SiteConfig { get; }
Property Value
Type Description
Output<AppServiceSiteConfig>
View Source

SiteCredentials

A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

Declaration
public Output<ImmutableArray<AppServiceSiteCredential>> SiteCredentials { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<AppServiceSiteCredential>>
View Source

SourceControls

A source_control block as defined below, which contains the Source Control information when scm_type is set to LocalGit.

Declaration
public Output<ImmutableArray<AppServiceSourceControl>> SourceControls { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<AppServiceSourceControl>>
View Source

StorageAccounts

One or more storage_account blocks as defined below.

Declaration
public Output<ImmutableArray<AppServiceStorageAccount>> StorageAccounts { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<AppServiceStorageAccount>>
View Source

Tags

A mapping of tags to assign to the resource.

Declaration
public Output<ImmutableDictionary<string, string>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Methods

View Source

Get(String, Input<String>, AppServiceState, CustomResourceOptions)

Get an existing AppService resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static AppService Get(string name, Input<string> id, AppServiceState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
AppServiceState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
AppService