appservice

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.appservice.ActiveSlot(resource_name, opts=None, app_service_name=None, app_service_slot_name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Promotes an App Service Slot to Production within an App Service.

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_name (pulumi.Input[str]) – The name of the App Service within which the Slot exists. Changing this forces a new resource to be created.

  • app_service_slot_name (pulumi.Input[str]) – The name of the App Service Slot which should be promoted to the Production Slot within the App Service.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.

app_service_name = None

The name of the App Service within which the Slot exists. Changing this forces a new resource to be created.

app_service_slot_name = None

The name of the App Service Slot which should be promoted to the Production Slot within the App Service.

resource_group_name = None

The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, app_service_name=None, app_service_slot_name=None, resource_group_name=None)

Get an existing ActiveSlot resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_name (pulumi.Input[str]) – The name of the App Service within which the Slot exists. Changing this forces a new resource to be created.

  • app_service_slot_name (pulumi.Input[str]) – The name of the App Service Slot which should be promoted to the Production Slot within the App Service.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.appservice.AppService(resource_name, opts=None, app_service_plan_id=None, app_settings=None, auth_settings=None, backup=None, client_affinity_enabled=None, client_cert_enabled=None, connection_strings=None, enabled=None, https_only=None, identity=None, location=None, logs=None, name=None, resource_group_name=None, site_config=None, storage_accounts=None, tags=None, __props__=None, __name__=None, __opts__=None)

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

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_plan_id (pulumi.Input[str]) – The ID of the App Service Plan within which to create this App Service.

  • app_settings (pulumi.Input[dict]) – A key-value pair of App Settings.

  • auth_settings (pulumi.Input[dict]) – A auth_settings block as defined below.

  • client_affinity_enabled (pulumi.Input[bool]) – Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

  • client_cert_enabled (pulumi.Input[bool]) – Does the App Service require client certificates for incoming requests? Defaults to false.

  • connection_strings (pulumi.Input[list]) – One or more connection_string blocks as defined below.

  • enabled (pulumi.Input[bool]) – Is the App Service Enabled?

  • https_only (pulumi.Input[bool]) – Can the App Service only be accessed via HTTPS? Defaults to false.

  • identity (pulumi.Input[dict]) – A Managed Service Identity block as defined below.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • logs (pulumi.Input[dict]) – A logs block as defined below.

  • name (pulumi.Input[str]) – Specifies the name of the App Service. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the App Service.

  • site_config (pulumi.Input[dict]) – A site_config block as defined below.

  • storage_accounts (pulumi.Input[list]) – One or more storage_account blocks as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The auth_settings object supports the following:

  • activeDirectory (pulumi.Input[dict])

    • allowedAudiences (pulumi.Input[list])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

  • additionalLoginParams (pulumi.Input[dict])

  • allowedExternalRedirectUrls (pulumi.Input[list])

  • defaultProvider (pulumi.Input[str])

  • enabled (pulumi.Input[bool]) - Is the App Service Enabled?

  • facebook (pulumi.Input[dict])

    • app_id (pulumi.Input[str])

    • appSecret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • google (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • issuer (pulumi.Input[str])

  • microsoft (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • runtimeVersion (pulumi.Input[str])

  • tokenRefreshExtensionHours (pulumi.Input[float])

  • tokenStoreEnabled (pulumi.Input[bool])

  • twitter (pulumi.Input[dict])

    • consumerKey (pulumi.Input[str])

    • consumerSecret (pulumi.Input[str])

  • unauthenticatedClientAction (pulumi.Input[str])

The backup object supports the following:

  • enabled (pulumi.Input[bool]) - Is the App Service Enabled?

  • name (pulumi.Input[str]) - Specifies the name of the App Service. Changing this forces a new resource to be created.

  • schedule (pulumi.Input[dict])

    • frequencyInterval (pulumi.Input[float])

    • frequencyUnit (pulumi.Input[str])

    • keepAtLeastOneBackup (pulumi.Input[bool])

    • retentionPeriodInDays (pulumi.Input[float])

    • startTime (pulumi.Input[str])

  • storageAccountUrl (pulumi.Input[str])

The connection_strings object supports the following:

  • name (pulumi.Input[str]) - Specifies the name of the App Service. Changing this forces a new resource to be created.

  • type (pulumi.Input[str])

  • value (pulumi.Input[str])

The identity object supports the following:

  • identityIds (pulumi.Input[list])

  • principalId (pulumi.Input[str]) - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • tenantId (pulumi.Input[str]) - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • type (pulumi.Input[str])

The logs object supports the following:

  • applicationLogs (pulumi.Input[dict])

    • azureBlobStorage (pulumi.Input[dict])

      • level (pulumi.Input[str])

      • retentionInDays (pulumi.Input[float])

      • sasUrl (pulumi.Input[str])

  • httpLogs (pulumi.Input[dict])

    • fileSystem (pulumi.Input[dict])

      • retentionInDays (pulumi.Input[float])

      • retentionInMb (pulumi.Input[float])

The site_config object supports the following:

  • alwaysOn (pulumi.Input[bool])

  • appCommandLine (pulumi.Input[str])

  • cors (pulumi.Input[dict])

    • allowedOrigins (pulumi.Input[list])

    • supportCredentials (pulumi.Input[bool])

  • defaultDocuments (pulumi.Input[list])

  • dotnetFrameworkVersion (pulumi.Input[str])

  • ftpsState (pulumi.Input[str])

  • http2Enabled (pulumi.Input[bool])

  • ipRestrictions (pulumi.Input[list])

    • ipAddress (pulumi.Input[str])

    • subnetMask (pulumi.Input[str])

  • javaContainer (pulumi.Input[str])

  • javaContainerVersion (pulumi.Input[str])

  • javaVersion (pulumi.Input[str])

  • linuxFxVersion (pulumi.Input[str])

  • localMysqlEnabled (pulumi.Input[bool])

  • managedPipelineMode (pulumi.Input[str])

  • minTlsVersion (pulumi.Input[str])

  • phpVersion (pulumi.Input[str])

  • pythonVersion (pulumi.Input[str])

  • remoteDebuggingEnabled (pulumi.Input[bool])

  • remoteDebuggingVersion (pulumi.Input[str])

  • scmType (pulumi.Input[str])

  • use32BitWorkerProcess (pulumi.Input[bool])

  • virtualNetworkName (pulumi.Input[str])

  • websocketsEnabled (pulumi.Input[bool])

  • windowsFxVersion (pulumi.Input[str])

The storage_accounts object supports the following:

  • accessKey (pulumi.Input[str])

  • accountName (pulumi.Input[str])

  • mountPath (pulumi.Input[str])

  • name (pulumi.Input[str]) - Specifies the name of the App Service. Changing this forces a new resource to be created.

  • shareName (pulumi.Input[str])

  • type (pulumi.Input[str])

app_service_plan_id = None

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

app_settings = None

A key-value pair of App Settings.

auth_settings = None

A auth_settings block as defined below.

  • activeDirectory (dict)

    • allowedAudiences (list)

    • client_id (str)

    • client_secret (str)

  • additionalLoginParams (dict)

  • allowedExternalRedirectUrls (list)

  • defaultProvider (str)

  • enabled (bool) - Is the App Service Enabled?

  • facebook (dict)

    • app_id (str)

    • appSecret (str)

    • oauthScopes (list)

  • google (dict)

    • client_id (str)

    • client_secret (str)

    • oauthScopes (list)

  • issuer (str)

  • microsoft (dict)

    • client_id (str)

    • client_secret (str)

    • oauthScopes (list)

  • runtimeVersion (str)

  • tokenRefreshExtensionHours (float)

  • tokenStoreEnabled (bool)

  • twitter (dict)

    • consumerKey (str)

    • consumerSecret (str)

  • unauthenticatedClientAction (str)

client_affinity_enabled = None

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

client_cert_enabled = None

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

connection_strings = None

One or more connection_string blocks as defined below.

  • name (str) - Specifies the name of the App Service. Changing this forces a new resource to be created.

  • type (str)

  • value (str)

default_site_hostname = None

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

enabled = None

Is the App Service Enabled?

https_only = None

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

identity = None

A Managed Service Identity block as defined below.

  • identityIds (list)

  • principalId (str) - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • tenantId (str) - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • type (str)

location = None

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

logs = None

A logs block as defined below.

  • applicationLogs (dict)

    • azureBlobStorage (dict)

      • level (str)

      • retentionInDays (float)

      • sasUrl (str)

  • httpLogs (dict)

    • fileSystem (dict)

      • retentionInDays (float)

      • retentionInMb (float)

name = None

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

outbound_ip_addresses = None

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

possible_outbound_ip_addresses = None

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.

resource_group_name = None

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

site_config = None

A site_config block as defined below.

  • alwaysOn (bool)

  • appCommandLine (str)

  • cors (dict)

    • allowedOrigins (list)

    • supportCredentials (bool)

  • defaultDocuments (list)

  • dotnetFrameworkVersion (str)

  • ftpsState (str)

  • http2Enabled (bool)

  • ipRestrictions (list)

    • ipAddress (str)

    • subnetMask (str)

  • javaContainer (str)

  • javaContainerVersion (str)

  • javaVersion (str)

  • linuxFxVersion (str)

  • localMysqlEnabled (bool)

  • managedPipelineMode (str)

  • minTlsVersion (str)

  • phpVersion (str)

  • pythonVersion (str)

  • remoteDebuggingEnabled (bool)

  • remoteDebuggingVersion (str)

  • scmType (str)

  • use32BitWorkerProcess (bool)

  • virtualNetworkName (str)

  • websocketsEnabled (bool)

  • windowsFxVersion (str)

site_credential = None

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

  • password (str) - The password associated with the username, which can be used to publish to this App Service.

  • username (str) - The username which can be used to publish to this App Service

source_control = None

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

  • branch (str) - Branch name of the Git repository for this App Service.

  • repoUrl (str) - URL of the Git repository for this App Service.

storage_accounts = None

One or more storage_account blocks as defined below.

  • accessKey (str)

  • accountName (str)

  • mountPath (str)

  • name (str) - Specifies the name of the App Service. Changing this forces a new resource to be created.

  • shareName (str)

  • type (str)

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, app_service_plan_id=None, app_settings=None, auth_settings=None, backup=None, client_affinity_enabled=None, client_cert_enabled=None, connection_strings=None, default_site_hostname=None, enabled=None, https_only=None, identity=None, location=None, logs=None, name=None, outbound_ip_addresses=None, possible_outbound_ip_addresses=None, resource_group_name=None, site_config=None, site_credential=None, source_control=None, storage_accounts=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_plan_id (pulumi.Input[str]) – The ID of the App Service Plan within which to create this App Service.

  • app_settings (pulumi.Input[dict]) – A key-value pair of App Settings.

  • auth_settings (pulumi.Input[dict]) – A auth_settings block as defined below.

  • client_affinity_enabled (pulumi.Input[bool]) – Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?

  • client_cert_enabled (pulumi.Input[bool]) – Does the App Service require client certificates for incoming requests? Defaults to false.

  • connection_strings (pulumi.Input[list]) – One or more connection_string blocks as defined below.

  • default_site_hostname (pulumi.Input[str]) – The Default Hostname associated with the App Service - such as mysite.azurewebsites.net

  • enabled (pulumi.Input[bool]) – Is the App Service Enabled?

  • https_only (pulumi.Input[bool]) – Can the App Service only be accessed via HTTPS? Defaults to false.

  • identity (pulumi.Input[dict]) – A Managed Service Identity block as defined below.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • logs (pulumi.Input[dict]) – A logs block as defined below.

  • name (pulumi.Input[str]) – Specifies the name of the App Service. Changing this forces a new resource to be created.

  • outbound_ip_addresses (pulumi.Input[str]) – A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12

  • possible_outbound_ip_addresses (pulumi.Input[str]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the App Service.

  • site_config (pulumi.Input[dict]) – A site_config block as defined below.

  • site_credential (pulumi.Input[dict]) – A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

  • source_control (pulumi.Input[dict]) – A source_control block as defined below, which contains the Source Control information when scm_type is set to LocalGit.

  • storage_accounts (pulumi.Input[list]) – One or more storage_account blocks as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The auth_settings object supports the following:

  • activeDirectory (pulumi.Input[dict])

    • allowedAudiences (pulumi.Input[list])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

  • additionalLoginParams (pulumi.Input[dict])

  • allowedExternalRedirectUrls (pulumi.Input[list])

  • defaultProvider (pulumi.Input[str])

  • enabled (pulumi.Input[bool]) - Is the App Service Enabled?

  • facebook (pulumi.Input[dict])

    • app_id (pulumi.Input[str])

    • appSecret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • google (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • issuer (pulumi.Input[str])

  • microsoft (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • runtimeVersion (pulumi.Input[str])

  • tokenRefreshExtensionHours (pulumi.Input[float])

  • tokenStoreEnabled (pulumi.Input[bool])

  • twitter (pulumi.Input[dict])

    • consumerKey (pulumi.Input[str])

    • consumerSecret (pulumi.Input[str])

  • unauthenticatedClientAction (pulumi.Input[str])

The backup object supports the following:

  • enabled (pulumi.Input[bool]) - Is the App Service Enabled?

  • name (pulumi.Input[str]) - Specifies the name of the App Service. Changing this forces a new resource to be created.

  • schedule (pulumi.Input[dict])

    • frequencyInterval (pulumi.Input[float])

    • frequencyUnit (pulumi.Input[str])

    • keepAtLeastOneBackup (pulumi.Input[bool])

    • retentionPeriodInDays (pulumi.Input[float])

    • startTime (pulumi.Input[str])

  • storageAccountUrl (pulumi.Input[str])

The connection_strings object supports the following:

  • name (pulumi.Input[str]) - Specifies the name of the App Service. Changing this forces a new resource to be created.

  • type (pulumi.Input[str])

  • value (pulumi.Input[str])

The identity object supports the following:

  • identityIds (pulumi.Input[list])

  • principalId (pulumi.Input[str]) - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • tenantId (pulumi.Input[str]) - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • type (pulumi.Input[str])

The logs object supports the following:

  • applicationLogs (pulumi.Input[dict])

    • azureBlobStorage (pulumi.Input[dict])

      • level (pulumi.Input[str])

      • retentionInDays (pulumi.Input[float])

      • sasUrl (pulumi.Input[str])

  • httpLogs (pulumi.Input[dict])

    • fileSystem (pulumi.Input[dict])

      • retentionInDays (pulumi.Input[float])

      • retentionInMb (pulumi.Input[float])

The site_config object supports the following:

  • alwaysOn (pulumi.Input[bool])

  • appCommandLine (pulumi.Input[str])

  • cors (pulumi.Input[dict])

    • allowedOrigins (pulumi.Input[list])

    • supportCredentials (pulumi.Input[bool])

  • defaultDocuments (pulumi.Input[list])

  • dotnetFrameworkVersion (pulumi.Input[str])

  • ftpsState (pulumi.Input[str])

  • http2Enabled (pulumi.Input[bool])

  • ipRestrictions (pulumi.Input[list])

    • ipAddress (pulumi.Input[str])

    • subnetMask (pulumi.Input[str])

  • javaContainer (pulumi.Input[str])

  • javaContainerVersion (pulumi.Input[str])

  • javaVersion (pulumi.Input[str])

  • linuxFxVersion (pulumi.Input[str])

  • localMysqlEnabled (pulumi.Input[bool])

  • managedPipelineMode (pulumi.Input[str])

  • minTlsVersion (pulumi.Input[str])

  • phpVersion (pulumi.Input[str])

  • pythonVersion (pulumi.Input[str])

  • remoteDebuggingEnabled (pulumi.Input[bool])

  • remoteDebuggingVersion (pulumi.Input[str])

  • scmType (pulumi.Input[str])

  • use32BitWorkerProcess (pulumi.Input[bool])

  • virtualNetworkName (pulumi.Input[str])

  • websocketsEnabled (pulumi.Input[bool])

  • windowsFxVersion (pulumi.Input[str])

The site_credential object supports the following:

  • password (pulumi.Input[str]) - The password associated with the username, which can be used to publish to this App Service.

  • username (pulumi.Input[str]) - The username which can be used to publish to this App Service

The source_control object supports the following:

  • branch (pulumi.Input[str]) - Branch name of the Git repository for this App Service.

  • repoUrl (pulumi.Input[str]) - URL of the Git repository for this App Service.

The storage_accounts object supports the following:

  • accessKey (pulumi.Input[str])

  • accountName (pulumi.Input[str])

  • mountPath (pulumi.Input[str])

  • name (pulumi.Input[str]) - Specifies the name of the App Service. Changing this forces a new resource to be created.

  • shareName (pulumi.Input[str])

  • type (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.appservice.AwaitableGetAppServicePlanResult(is_xenon=None, kind=None, location=None, maximum_elastic_worker_count=None, maximum_number_of_workers=None, name=None, properties=None, resource_group_name=None, sku=None, tags=None, id=None)
class pulumi_azure.appservice.AwaitableGetAppServiceResult(app_service_plan_id=None, app_settings=None, client_affinity_enabled=None, client_cert_enabled=None, connection_strings=None, default_site_hostname=None, enabled=None, https_only=None, location=None, name=None, outbound_ip_addresses=None, possible_outbound_ip_addresses=None, resource_group_name=None, site_configs=None, site_credentials=None, source_controls=None, tags=None, id=None)
class pulumi_azure.appservice.CustomHostnameBinding(resource_name, opts=None, app_service_name=None, hostname=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Hostname Binding within an App Service.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_name (pulumi.Input[str]) – The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.

  • hostname (pulumi.Input[str]) – Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.

app_service_name = None

The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.

hostname = None

Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, app_service_name=None, hostname=None, resource_group_name=None)

Get an existing CustomHostnameBinding resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_name (pulumi.Input[str]) – The name of the App Service in which to add the Custom Hostname Binding. Changing this forces a new resource to be created.

  • hostname (pulumi.Input[str]) – Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.appservice.FunctionApp(resource_name, opts=None, app_service_plan_id=None, app_settings=None, auth_settings=None, client_affinity_enabled=None, connection_strings=None, enable_builtin_logging=None, enabled=None, https_only=None, identity=None, location=None, name=None, resource_group_name=None, site_config=None, storage_connection_string=None, tags=None, version=None, __props__=None, __name__=None, __opts__=None)

Manages a Function App.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_plan_id (pulumi.Input[str]) – The ID of the App Service Plan within which to create this Function App. Changing this forces a new resource to be created.

  • app_settings (pulumi.Input[dict]) – A key-value pair of App Settings.

  • auth_settings (pulumi.Input[dict]) – A auth_settings block as defined below.

  • client_affinity_enabled (pulumi.Input[bool]) – Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

  • connection_strings (pulumi.Input[list]) – An connection_string block as defined below.

  • enable_builtin_logging (pulumi.Input[bool]) – Should the built-in logging of this Function App be enabled? Defaults to true.

  • enabled (pulumi.Input[bool]) – Is the Function App enabled?

  • https_only (pulumi.Input[bool]) – Can the Function App only be accessed via HTTPS? Defaults to false.

  • identity (pulumi.Input[dict]) – An identity block as defined below.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the Connection String.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Function App.

  • site_config (pulumi.Input[dict]) – A site_config object as defined below.

  • storage_connection_string (pulumi.Input[str]) – The connection string of the backend storage account which will be used by this Function App (such as the dashboard, logs).

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • version (pulumi.Input[str]) – The runtime version associated with the Function App. Defaults to ~1.

The auth_settings object supports the following:

  • activeDirectory (pulumi.Input[dict])

    • allowedAudiences (pulumi.Input[list])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

  • additionalLoginParams (pulumi.Input[dict])

  • allowedExternalRedirectUrls (pulumi.Input[list])

  • defaultProvider (pulumi.Input[str])

  • enabled (pulumi.Input[bool]) - Is the Function App enabled?

  • facebook (pulumi.Input[dict])

    • app_id (pulumi.Input[str])

    • appSecret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • google (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • issuer (pulumi.Input[str])

  • microsoft (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • runtimeVersion (pulumi.Input[str])

  • tokenRefreshExtensionHours (pulumi.Input[float])

  • tokenStoreEnabled (pulumi.Input[bool])

  • twitter (pulumi.Input[dict])

    • consumerKey (pulumi.Input[str])

    • consumerSecret (pulumi.Input[str])

  • unauthenticatedClientAction (pulumi.Input[str])

The connection_strings object supports the following:

  • name (pulumi.Input[str]) - The name of the Connection String.

  • type (pulumi.Input[str]) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

  • value (pulumi.Input[str]) - The value for the Connection String.

The identity object supports the following:

  • principalId (pulumi.Input[str]) - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • tenantId (pulumi.Input[str]) - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • type (pulumi.Input[str]) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

The site_config object supports the following:

  • alwaysOn (pulumi.Input[bool]) - Should the Function App be loaded at all times? Defaults to false.

  • cors (pulumi.Input[dict]) - A cors block as defined below.

    • allowedOrigins (pulumi.Input[list])

    • supportCredentials (pulumi.Input[bool])

  • linuxFxVersion (pulumi.Input[str]) - Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

  • use32BitWorkerProcess (pulumi.Input[bool]) - Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

  • virtualNetworkName (pulumi.Input[str]) - The name of the Virtual Network which this App Service should be attached to.

  • websocketsEnabled (pulumi.Input[bool]) - Should WebSockets be enabled?

app_service_plan_id = None

The ID of the App Service Plan within which to create this Function App. Changing this forces a new resource to be created.

app_settings = None

A key-value pair of App Settings.

auth_settings = None

A auth_settings block as defined below.

  • activeDirectory (dict)

    • allowedAudiences (list)

    • client_id (str)

    • client_secret (str)

  • additionalLoginParams (dict)

  • allowedExternalRedirectUrls (list)

  • defaultProvider (str)

  • enabled (bool) - Is the Function App enabled?

  • facebook (dict)

    • app_id (str)

    • appSecret (str)

    • oauthScopes (list)

  • google (dict)

    • client_id (str)

    • client_secret (str)

    • oauthScopes (list)

  • issuer (str)

  • microsoft (dict)

    • client_id (str)

    • client_secret (str)

    • oauthScopes (list)

  • runtimeVersion (str)

  • tokenRefreshExtensionHours (float)

  • tokenStoreEnabled (bool)

  • twitter (dict)

    • consumerKey (str)

    • consumerSecret (str)

  • unauthenticatedClientAction (str)

client_affinity_enabled = None

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

connection_strings = None

An connection_string block as defined below.

  • name (str) - The name of the Connection String.

  • type (str) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

  • value (str) - The value for the Connection String.

default_hostname = None

The default hostname associated with the Function App - such as mysite.azurewebsites.net

enable_builtin_logging = None

Should the built-in logging of this Function App be enabled? Defaults to true.

enabled = None

Is the Function App enabled?

https_only = None

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

identity = None

An identity block as defined below.

  • principalId (str) - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • tenantId (str) - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • type (str) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

kind = None

The Function App kind - such as functionapp,linux,container

location = None

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

name = None

The name of the Connection String.

outbound_ip_addresses = None

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

possible_outbound_ip_addresses = None

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.

resource_group_name = None

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

site_config = None

A site_config object as defined below.

  • alwaysOn (bool) - Should the Function App be loaded at all times? Defaults to false.

  • cors (dict) - A cors block as defined below.

    • allowedOrigins (list)

    • supportCredentials (bool)

  • linuxFxVersion (str) - Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

  • use32BitWorkerProcess (bool) - Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

  • virtualNetworkName (str) - The name of the Virtual Network which this App Service should be attached to.

  • websocketsEnabled (bool) - Should WebSockets be enabled?

site_credential = None

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

  • password (str) - The password associated with the username, which can be used to publish to this App Service.

  • username (str) - The username which can be used to publish to this App Service

storage_connection_string = None

The connection string of the backend storage account which will be used by this Function App (such as the dashboard, logs).

tags = None

A mapping of tags to assign to the resource.

version = None

The runtime version associated with the Function App. Defaults to ~1.

static get(resource_name, id, opts=None, app_service_plan_id=None, app_settings=None, auth_settings=None, client_affinity_enabled=None, connection_strings=None, default_hostname=None, enable_builtin_logging=None, enabled=None, https_only=None, identity=None, kind=None, location=None, name=None, outbound_ip_addresses=None, possible_outbound_ip_addresses=None, resource_group_name=None, site_config=None, site_credential=None, storage_connection_string=None, tags=None, version=None)

Get an existing FunctionApp resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_plan_id (pulumi.Input[str]) – The ID of the App Service Plan within which to create this Function App. Changing this forces a new resource to be created.

  • app_settings (pulumi.Input[dict]) – A key-value pair of App Settings.

  • auth_settings (pulumi.Input[dict]) – A auth_settings block as defined below.

  • client_affinity_enabled (pulumi.Input[bool]) – Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?

  • connection_strings (pulumi.Input[list]) – An connection_string block as defined below.

  • default_hostname (pulumi.Input[str]) – The default hostname associated with the Function App - such as mysite.azurewebsites.net

  • enable_builtin_logging (pulumi.Input[bool]) – Should the built-in logging of this Function App be enabled? Defaults to true.

  • enabled (pulumi.Input[bool]) – Is the Function App enabled?

  • https_only (pulumi.Input[bool]) – Can the Function App only be accessed via HTTPS? Defaults to false.

  • identity (pulumi.Input[dict]) – An identity block as defined below.

  • kind (pulumi.Input[str]) – The Function App kind - such as functionapp,linux,container

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the Connection String.

  • outbound_ip_addresses (pulumi.Input[str]) – A comma separated list of outbound IP addresses - such as 52.23.25.3,52.143.43.12

  • possible_outbound_ip_addresses (pulumi.Input[str]) – 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.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Function App.

  • site_config (pulumi.Input[dict]) – A site_config object as defined below.

  • site_credential (pulumi.Input[dict]) – A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

  • storage_connection_string (pulumi.Input[str]) – The connection string of the backend storage account which will be used by this Function App (such as the dashboard, logs).

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • version (pulumi.Input[str]) – The runtime version associated with the Function App. Defaults to ~1.

The auth_settings object supports the following:

  • activeDirectory (pulumi.Input[dict])

    • allowedAudiences (pulumi.Input[list])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

  • additionalLoginParams (pulumi.Input[dict])

  • allowedExternalRedirectUrls (pulumi.Input[list])

  • defaultProvider (pulumi.Input[str])

  • enabled (pulumi.Input[bool]) - Is the Function App enabled?

  • facebook (pulumi.Input[dict])

    • app_id (pulumi.Input[str])

    • appSecret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • google (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • issuer (pulumi.Input[str])

  • microsoft (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • runtimeVersion (pulumi.Input[str])

  • tokenRefreshExtensionHours (pulumi.Input[float])

  • tokenStoreEnabled (pulumi.Input[bool])

  • twitter (pulumi.Input[dict])

    • consumerKey (pulumi.Input[str])

    • consumerSecret (pulumi.Input[str])

  • unauthenticatedClientAction (pulumi.Input[str])

The connection_strings object supports the following:

  • name (pulumi.Input[str]) - The name of the Connection String.

  • type (pulumi.Input[str]) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

  • value (pulumi.Input[str]) - The value for the Connection String.

The identity object supports the following:

  • principalId (pulumi.Input[str]) - The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • tenantId (pulumi.Input[str]) - The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

  • type (pulumi.Input[str]) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

The site_config object supports the following:

  • alwaysOn (pulumi.Input[bool]) - Should the Function App be loaded at all times? Defaults to false.

  • cors (pulumi.Input[dict]) - A cors block as defined below.

    • allowedOrigins (pulumi.Input[list])

    • supportCredentials (pulumi.Input[bool])

  • linuxFxVersion (pulumi.Input[str]) - Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

  • use32BitWorkerProcess (pulumi.Input[bool]) - Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

  • virtualNetworkName (pulumi.Input[str]) - The name of the Virtual Network which this App Service should be attached to.

  • websocketsEnabled (pulumi.Input[bool]) - Should WebSockets be enabled?

The site_credential object supports the following:

  • password (pulumi.Input[str]) - The password associated with the username, which can be used to publish to this App Service.

  • username (pulumi.Input[str]) - The username which can be used to publish to this App Service

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.appservice.GetAppServicePlanResult(is_xenon=None, kind=None, location=None, maximum_elastic_worker_count=None, maximum_number_of_workers=None, name=None, properties=None, resource_group_name=None, sku=None, tags=None, id=None)

A collection of values returned by getAppServicePlan.

is_xenon = None

A flag that indicates if it’s a xenon plan (support for Windows Container)

kind = None

The Operating System type of the App Service Plan

location = None

The Azure location where the App Service Plan exists

maximum_elastic_worker_count = None

The maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.

maximum_number_of_workers = None

Maximum number of instances that can be assigned to this App Service plan.

properties = None

A properties block as documented below.

sku = None

A sku block as documented below.

tags = None

A mapping of tags assigned to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.appservice.GetAppServiceResult(app_service_plan_id=None, app_settings=None, client_affinity_enabled=None, client_cert_enabled=None, connection_strings=None, default_site_hostname=None, enabled=None, https_only=None, location=None, name=None, outbound_ip_addresses=None, possible_outbound_ip_addresses=None, resource_group_name=None, site_configs=None, site_credentials=None, source_controls=None, tags=None, id=None)

A collection of values returned by getAppService.

app_service_plan_id = None

The ID of the App Service Plan within which the App Service exists.

app_settings = None

A key-value pair of App Settings for the App Service.

client_affinity_enabled = None

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

client_cert_enabled = None

Does the App Service require client certificates for incoming requests?

connection_strings = None

An connection_string block as defined below.

enabled = None

Is the App Service Enabled?

https_only = None

Can the App Service only be accessed via HTTPS?

location = None

The Azure location where the App Service exists.

name = None

The name of the Connection String.

outbound_ip_addresses = None

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

possible_outbound_ip_addresses = None

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.

site_configs = None

A site_config block as defined below.

tags = None

A mapping of tags to assign to the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.appservice.Plan(resource_name, opts=None, app_service_environment_id=None, is_xenon=None, kind=None, location=None, maximum_elastic_worker_count=None, name=None, per_site_scaling=None, properties=None, reserved=None, resource_group_name=None, sku=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manage an App Service Plan component.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_environment_id (pulumi.Input[str]) – The ID of the App Service Environment where the App Service Plan should be located. Changing forces a new resource to be created.

  • kind (pulumi.Input[str]) – The kind of the App Service Plan to create. Possible values are Windows (also available as App), Linux, elastic (for Premium Consumption) and FunctionApp (for a Consumption Plan). Defaults to Windows. Changing this forces a new resource to be created.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • maximum_elastic_worker_count (pulumi.Input[float]) – The maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.

  • name (pulumi.Input[str]) – Specifies the name of the App Service Plan component. Changing this forces a new resource to be created.

  • per_site_scaling (pulumi.Input[bool]) – Can Apps assigned to this App Service Plan be scaled independently? If set to false apps assigned to this plan will scale to all instances of the plan. Defaults to false.

  • reserved (pulumi.Input[bool]) – Is this App Service Plan Reserved. Defaults to false.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the App Service Plan component.

  • sku (pulumi.Input[dict]) – A sku block as documented below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The properties object supports the following:

  • app_service_environment_id (pulumi.Input[str]) - The ID of the App Service Environment where the App Service Plan should be located. Changing forces a new resource to be created.

  • per_site_scaling (pulumi.Input[bool]) - Can Apps assigned to this App Service Plan be scaled independently? If set to false apps assigned to this plan will scale to all instances of the plan. Defaults to false.

  • reserved (pulumi.Input[bool]) - Is this App Service Plan Reserved. Defaults to false.

The sku object supports the following:

  • capacity (pulumi.Input[float]) - Specifies the number of workers associated with this App Service Plan.

  • size (pulumi.Input[str]) - Specifies the plan’s instance size.

  • tier (pulumi.Input[str]) - Specifies the plan’s pricing tier.

app_service_environment_id = None

The ID of the App Service Environment where the App Service Plan should be located. Changing forces a new resource to be created.

kind = None

The kind of the App Service Plan to create. Possible values are Windows (also available as App), Linux, elastic (for Premium Consumption) and FunctionApp (for a Consumption Plan). Defaults to Windows. Changing this forces a new resource to be created.

location = None

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

maximum_elastic_worker_count = None

The maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.

maximum_number_of_workers = None

The maximum number of workers supported with the App Service Plan’s sku.

name = None

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

per_site_scaling = None

Can Apps assigned to this App Service Plan be scaled independently? If set to false apps assigned to this plan will scale to all instances of the plan. Defaults to false.

reserved = None

Is this App Service Plan Reserved. Defaults to false.

resource_group_name = None

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

sku = None

A sku block as documented below.

  • capacity (float) - Specifies the number of workers associated with this App Service Plan.

  • size (str) - Specifies the plan’s instance size.

  • tier (str) - Specifies the plan’s pricing tier.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, app_service_environment_id=None, is_xenon=None, kind=None, location=None, maximum_elastic_worker_count=None, maximum_number_of_workers=None, name=None, per_site_scaling=None, properties=None, reserved=None, resource_group_name=None, sku=None, tags=None)

Get an existing Plan resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_environment_id (pulumi.Input[str]) – The ID of the App Service Environment where the App Service Plan should be located. Changing forces a new resource to be created.

  • kind (pulumi.Input[str]) – The kind of the App Service Plan to create. Possible values are Windows (also available as App), Linux, elastic (for Premium Consumption) and FunctionApp (for a Consumption Plan). Defaults to Windows. Changing this forces a new resource to be created.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • maximum_elastic_worker_count (pulumi.Input[float]) – The maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan.

  • maximum_number_of_workers (pulumi.Input[float]) – The maximum number of workers supported with the App Service Plan’s sku.

  • name (pulumi.Input[str]) – Specifies the name of the App Service Plan component. Changing this forces a new resource to be created.

  • per_site_scaling (pulumi.Input[bool]) – Can Apps assigned to this App Service Plan be scaled independently? If set to false apps assigned to this plan will scale to all instances of the plan. Defaults to false.

  • reserved (pulumi.Input[bool]) – Is this App Service Plan Reserved. Defaults to false.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the App Service Plan component.

  • sku (pulumi.Input[dict]) – A sku block as documented below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The properties object supports the following:

  • app_service_environment_id (pulumi.Input[str]) - The ID of the App Service Environment where the App Service Plan should be located. Changing forces a new resource to be created.

  • per_site_scaling (pulumi.Input[bool]) - Can Apps assigned to this App Service Plan be scaled independently? If set to false apps assigned to this plan will scale to all instances of the plan. Defaults to false.

  • reserved (pulumi.Input[bool]) - Is this App Service Plan Reserved. Defaults to false.

The sku object supports the following:

  • capacity (pulumi.Input[float]) - Specifies the number of workers associated with this App Service Plan.

  • size (pulumi.Input[str]) - Specifies the plan’s instance size.

  • tier (pulumi.Input[str]) - Specifies the plan’s pricing tier.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.appservice.Slot(resource_name, opts=None, app_service_name=None, app_service_plan_id=None, app_settings=None, auth_settings=None, client_affinity_enabled=None, connection_strings=None, enabled=None, https_only=None, identity=None, location=None, name=None, resource_group_name=None, site_config=None, tags=None, __props__=None, __name__=None, __opts__=None)

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

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_name (pulumi.Input[str]) – The name of the App Service within which to create the App Service Slot. Changing this forces a new resource to be created.

  • app_service_plan_id (pulumi.Input[str]) – The ID of the App Service Plan within which to create this App Service Slot. Changing this forces a new resource to be created.

  • app_settings (pulumi.Input[dict]) – A key-value pair of App Settings.

  • auth_settings (pulumi.Input[dict]) – A auth_settings block as defined below.

  • client_affinity_enabled (pulumi.Input[bool]) – Should the App Service Slot send session affinity cookies, which route client requests in the same session to the same instance?

  • connection_strings (pulumi.Input[list]) – An connection_string block as defined below.

  • enabled (pulumi.Input[bool]) – Is the App Service Slot Enabled?

  • https_only (pulumi.Input[bool]) – Can the App Service Slot only be accessed via HTTPS? Defaults to false.

  • identity (pulumi.Input[dict]) – A Managed Service Identity block as defined below.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the Connection String.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the App Service Slot component.

  • site_config (pulumi.Input[dict]) – A site_config object as defined below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The auth_settings object supports the following:

  • activeDirectory (pulumi.Input[dict])

    • allowedAudiences (pulumi.Input[list])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

  • additionalLoginParams (pulumi.Input[dict])

  • allowedExternalRedirectUrls (pulumi.Input[list])

  • defaultProvider (pulumi.Input[str])

  • enabled (pulumi.Input[bool]) - Is the App Service Slot Enabled?

  • facebook (pulumi.Input[dict])

    • app_id (pulumi.Input[str])

    • appSecret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • google (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • issuer (pulumi.Input[str])

  • microsoft (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • runtimeVersion (pulumi.Input[str])

  • tokenRefreshExtensionHours (pulumi.Input[float])

  • tokenStoreEnabled (pulumi.Input[bool])

  • twitter (pulumi.Input[dict])

    • consumerKey (pulumi.Input[str])

    • consumerSecret (pulumi.Input[str])

  • unauthenticatedClientAction (pulumi.Input[str])

The connection_strings object supports the following:

  • name (pulumi.Input[str]) - The name of the Connection String.

  • type (pulumi.Input[str]) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

  • value (pulumi.Input[str]) - The value for the Connection String.

The identity object supports the following:

  • identityIds (pulumi.Input[list])

  • principalId (pulumi.Input[str])

  • tenantId (pulumi.Input[str])

  • type (pulumi.Input[str]) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

The site_config object supports the following:

  • alwaysOn (pulumi.Input[bool]) - Should the app be loaded at all times? Defaults to false.

  • appCommandLine (pulumi.Input[str]) - App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

  • cors (pulumi.Input[dict]) - A cors block as defined below.

    • allowedOrigins (pulumi.Input[list])

    • supportCredentials (pulumi.Input[bool])

  • defaultDocuments (pulumi.Input[list]) - The ordering of default documents to load, if an address isn’t specified.

  • dotnetFrameworkVersion (pulumi.Input[str]) - The version of the .net framework’s CLR used in this App Service Slot. Possible values are v2.0 (which will use the latest version of the .net framework for the .net CLR v2 - currently .net 3.5) and v4.0 (which corresponds to the latest version of the .net CLR v4 - which at the time of writing is .net 4.7.1). For more information on which .net CLR version to use based on the .net framework you’re targeting - please see this table. Defaults to v4.0.

  • ftpsState (pulumi.Input[str])

  • http2Enabled (pulumi.Input[bool]) - Is HTTP2 Enabled on this App Service? Defaults to false.

  • ipRestrictions (pulumi.Input[list]) - A List of objects representing ip restrictions as defined below.

    • ipAddress (pulumi.Input[str])

    • subnetMask (pulumi.Input[str])

  • javaContainer (pulumi.Input[str]) - The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JETTY and TOMCAT.

  • javaContainerVersion (pulumi.Input[str]) - The version of the Java Container to use. If specified java_version and java_container must also be specified.

  • javaVersion (pulumi.Input[str]) - The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11.

  • linuxFxVersion (pulumi.Input[str])

  • localMysqlEnabled (pulumi.Input[bool]) - Is “MySQL In App” Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

  • managedPipelineMode (pulumi.Input[str]) - The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

  • minTlsVersion (pulumi.Input[str]) - The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

  • phpVersion (pulumi.Input[str]) - The version of PHP to use in this App Service Slot. Possible values are 5.5, 5.6, 7.0, 7.1 and 7.2.

  • pythonVersion (pulumi.Input[str]) - The version of Python to use in this App Service Slot. Possible values are 2.7 and 3.4.

  • remoteDebuggingEnabled (pulumi.Input[bool]) - Is Remote Debugging Enabled? Defaults to false.

  • remoteDebuggingVersion (pulumi.Input[str]) - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

  • scmType (pulumi.Input[str]) - The type of Source Control enabled for this App Service Slot. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO and VSTSRM

  • use32BitWorkerProcess (pulumi.Input[bool]) - Should the App Service Slot run in 32 bit mode, rather than 64 bit mode?

  • virtualNetworkName (pulumi.Input[str]) - The name of the Virtual Network which this App Service Slot should be attached to.

  • websocketsEnabled (pulumi.Input[bool]) - Should WebSockets be enabled?

  • windowsFxVersion (pulumi.Input[str])

app_service_name = None

The name of the App Service within which to create the App Service Slot. Changing this forces a new resource to be created.

app_service_plan_id = None

The ID of the App Service Plan within which to create this App Service Slot. Changing this forces a new resource to be created.

app_settings = None

A key-value pair of App Settings.

auth_settings = None

A auth_settings block as defined below.

  • activeDirectory (dict)

    • allowedAudiences (list)

    • client_id (str)

    • client_secret (str)

  • additionalLoginParams (dict)

  • allowedExternalRedirectUrls (list)

  • defaultProvider (str)

  • enabled (bool) - Is the App Service Slot Enabled?

  • facebook (dict)

    • app_id (str)

    • appSecret (str)

    • oauthScopes (list)

  • google (dict)

    • client_id (str)

    • client_secret (str)

    • oauthScopes (list)

  • issuer (str)

  • microsoft (dict)

    • client_id (str)

    • client_secret (str)

    • oauthScopes (list)

  • runtimeVersion (str)

  • tokenRefreshExtensionHours (float)

  • tokenStoreEnabled (bool)

  • twitter (dict)

    • consumerKey (str)

    • consumerSecret (str)

  • unauthenticatedClientAction (str)

client_affinity_enabled = None

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

connection_strings = None

An connection_string block as defined below.

  • name (str) - The name of the Connection String.

  • type (str) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

  • value (str) - The value for the Connection String.

default_site_hostname = None

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

enabled = None

Is the App Service Slot Enabled?

https_only = None

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

identity = None

A Managed Service Identity block as defined below.

  • identityIds (list)

  • principalId (str)

  • tenantId (str)

  • type (str) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

location = None

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

name = None

The name of the Connection String.

resource_group_name = None

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

site_config = None

A site_config object as defined below.

  • alwaysOn (bool) - Should the app be loaded at all times? Defaults to false.

  • appCommandLine (str) - App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

  • cors (dict) - A cors block as defined below.

    • allowedOrigins (list)

    • supportCredentials (bool)

  • defaultDocuments (list) - The ordering of default documents to load, if an address isn’t specified.

  • dotnetFrameworkVersion (str) - The version of the .net framework’s CLR used in this App Service Slot. Possible values are v2.0 (which will use the latest version of the .net framework for the .net CLR v2 - currently .net 3.5) and v4.0 (which corresponds to the latest version of the .net CLR v4 - which at the time of writing is .net 4.7.1). For more information on which .net CLR version to use based on the .net framework you’re targeting - please see this table. Defaults to v4.0.

  • ftpsState (str)

  • http2Enabled (bool) - Is HTTP2 Enabled on this App Service? Defaults to false.

  • ipRestrictions (list) - A List of objects representing ip restrictions as defined below.

    • ipAddress (str)

    • subnetMask (str)

  • javaContainer (str) - The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JETTY and TOMCAT.

  • javaContainerVersion (str) - The version of the Java Container to use. If specified java_version and java_container must also be specified.

  • javaVersion (str) - The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11.

  • linuxFxVersion (str)

  • localMysqlEnabled (bool) - Is “MySQL In App” Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

  • managedPipelineMode (str) - The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

  • minTlsVersion (str) - The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

  • phpVersion (str) - The version of PHP to use in this App Service Slot. Possible values are 5.5, 5.6, 7.0, 7.1 and 7.2.

  • pythonVersion (str) - The version of Python to use in this App Service Slot. Possible values are 2.7 and 3.4.

  • remoteDebuggingEnabled (bool) - Is Remote Debugging Enabled? Defaults to false.

  • remoteDebuggingVersion (str) - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

  • scmType (str) - The type of Source Control enabled for this App Service Slot. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO and VSTSRM

  • use32BitWorkerProcess (bool) - Should the App Service Slot run in 32 bit mode, rather than 64 bit mode?

  • virtualNetworkName (str) - The name of the Virtual Network which this App Service Slot should be attached to.

  • websocketsEnabled (bool) - Should WebSockets be enabled?

  • windowsFxVersion (str)

site_credential = None

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

  • password (str) - The password associated with the username, which can be used to publish to this App Service.

  • username (str) - The username which can be used to publish to this App Service

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, app_service_name=None, app_service_plan_id=None, app_settings=None, auth_settings=None, client_affinity_enabled=None, connection_strings=None, default_site_hostname=None, enabled=None, https_only=None, identity=None, location=None, name=None, resource_group_name=None, site_config=None, site_credential=None, tags=None)

Get an existing Slot resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • app_service_name (pulumi.Input[str]) – The name of the App Service within which to create the App Service Slot. Changing this forces a new resource to be created.

  • app_service_plan_id (pulumi.Input[str]) – The ID of the App Service Plan within which to create this App Service Slot. Changing this forces a new resource to be created.

  • app_settings (pulumi.Input[dict]) – A key-value pair of App Settings.

  • auth_settings (pulumi.Input[dict]) – A auth_settings block as defined below.

  • client_affinity_enabled (pulumi.Input[bool]) – Should the App Service Slot send session affinity cookies, which route client requests in the same session to the same instance?

  • connection_strings (pulumi.Input[list]) – An connection_string block as defined below.

  • default_site_hostname (pulumi.Input[str]) – The Default Hostname associated with the App Service Slot - such as mysite.azurewebsites.net

  • enabled (pulumi.Input[bool]) – Is the App Service Slot Enabled?

  • https_only (pulumi.Input[bool]) – Can the App Service Slot only be accessed via HTTPS? Defaults to false.

  • identity (pulumi.Input[dict]) – A Managed Service Identity block as defined below.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the Connection String.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the App Service Slot component.

  • site_config (pulumi.Input[dict]) – A site_config object as defined below.

  • site_credential (pulumi.Input[dict]) – A site_credential block as defined below, which contains the site-level credentials used to publish to this App Service.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The auth_settings object supports the following:

  • activeDirectory (pulumi.Input[dict])

    • allowedAudiences (pulumi.Input[list])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

  • additionalLoginParams (pulumi.Input[dict])

  • allowedExternalRedirectUrls (pulumi.Input[list])

  • defaultProvider (pulumi.Input[str])

  • enabled (pulumi.Input[bool]) - Is the App Service Slot Enabled?

  • facebook (pulumi.Input[dict])

    • app_id (pulumi.Input[str])

    • appSecret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • google (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • issuer (pulumi.Input[str])

  • microsoft (pulumi.Input[dict])

    • client_id (pulumi.Input[str])

    • client_secret (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

  • runtimeVersion (pulumi.Input[str])

  • tokenRefreshExtensionHours (pulumi.Input[float])

  • tokenStoreEnabled (pulumi.Input[bool])

  • twitter (pulumi.Input[dict])

    • consumerKey (pulumi.Input[str])

    • consumerSecret (pulumi.Input[str])

  • unauthenticatedClientAction (pulumi.Input[str])

The connection_strings object supports the following:

  • name (pulumi.Input[str]) - The name of the Connection String.

  • type (pulumi.Input[str]) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

  • value (pulumi.Input[str]) - The value for the Connection String.

The identity object supports the following:

  • identityIds (pulumi.Input[list])

  • principalId (pulumi.Input[str])

  • tenantId (pulumi.Input[str])

  • type (pulumi.Input[str]) - The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

The site_config object supports the following:

  • alwaysOn (pulumi.Input[bool]) - Should the app be loaded at all times? Defaults to false.

  • appCommandLine (pulumi.Input[str]) - App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

  • cors (pulumi.Input[dict]) - A cors block as defined below.

    • allowedOrigins (pulumi.Input[list])

    • supportCredentials (pulumi.Input[bool])

  • defaultDocuments (pulumi.Input[list]) - The ordering of default documents to load, if an address isn’t specified.

  • dotnetFrameworkVersion (pulumi.Input[str]) - The version of the .net framework’s CLR used in this App Service Slot. Possible values are v2.0 (which will use the latest version of the .net framework for the .net CLR v2 - currently .net 3.5) and v4.0 (which corresponds to the latest version of the .net CLR v4 - which at the time of writing is .net 4.7.1). For more information on which .net CLR version to use based on the .net framework you’re targeting - please see this table. Defaults to v4.0.

  • ftpsState (pulumi.Input[str])

  • http2Enabled (pulumi.Input[bool]) - Is HTTP2 Enabled on this App Service? Defaults to false.

  • ipRestrictions (pulumi.Input[list]) - A List of objects representing ip restrictions as defined below.

    • ipAddress (pulumi.Input[str])

    • subnetMask (pulumi.Input[str])

  • javaContainer (pulumi.Input[str]) - The Java Container to use. If specified java_version and java_container_version must also be specified. Possible values are JETTY and TOMCAT.

  • javaContainerVersion (pulumi.Input[str]) - The version of the Java Container to use. If specified java_version and java_container must also be specified.

  • javaVersion (pulumi.Input[str]) - The version of Java to use. If specified java_container and java_container_version must also be specified. Possible values are 1.7, 1.8 and 11.

  • linuxFxVersion (pulumi.Input[str])

  • localMysqlEnabled (pulumi.Input[bool]) - Is “MySQL In App” Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

  • managedPipelineMode (pulumi.Input[str]) - The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

  • minTlsVersion (pulumi.Input[str]) - The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

  • phpVersion (pulumi.Input[str]) - The version of PHP to use in this App Service Slot. Possible values are 5.5, 5.6, 7.0, 7.1 and 7.2.

  • pythonVersion (pulumi.Input[str]) - The version of Python to use in this App Service Slot. Possible values are 2.7 and 3.4.

  • remoteDebuggingEnabled (pulumi.Input[bool]) - Is Remote Debugging Enabled? Defaults to false.

  • remoteDebuggingVersion (pulumi.Input[str]) - Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

  • scmType (pulumi.Input[str]) - The type of Source Control enabled for this App Service Slot. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO and VSTSRM

  • use32BitWorkerProcess (pulumi.Input[bool]) - Should the App Service Slot run in 32 bit mode, rather than 64 bit mode?

  • virtualNetworkName (pulumi.Input[str]) - The name of the Virtual Network which this App Service Slot should be attached to.

  • websocketsEnabled (pulumi.Input[bool]) - Should WebSockets be enabled?

  • windowsFxVersion (pulumi.Input[str])

The site_credential object supports the following:

  • password (pulumi.Input[str]) - The password associated with the username, which can be used to publish to this App Service.

  • username (pulumi.Input[str]) - The username which can be used to publish to this App Service

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.appservice.get_app_service(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing App Service.

Parameters
  • name (str) – The name of the App Service.

  • resource_group_name (str) – The Name of the Resource Group where the App Service exists.

pulumi_azure.appservice.get_app_service_plan(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing App Service Plan (formerly known as a Server Farm).

Parameters
  • name (str) – The name of the App Service Plan.

  • resource_group_name (str) – The Name of the Resource Group where the App Service Plan exists.