appservice

class pulumi_azure.appservice.ActiveSlot(resource_name, opts=None, app_service_name=None, app_service_slot_name=None, resource_group_name=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 azurerm_app_service resource will be overwritten when promoting a Slot using the azurerm_app_service_active_slot 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.

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, client_affinity_enabled=None, client_cert_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, __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 azurerm_app_service resource will be overwritten when promoting a Slot using the azurerm_app_service_active_slot 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. Changing this forces a new resource to be created.
  • app_settings (pulumi.Input[dict]) – A key-value pair of App Settings.
  • 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? Changing this forces a new resource to be created.
  • 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.
  • 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.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
app_service_plan_id = None

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

app_settings = None

A key-value pair of App Settings.

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.

default_site_hostname = None

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

enabled = None

Is the App Service Enabled? Changing this forces a new resource to be created.

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.

location = None

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

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.

site_credential = None

A site_credential block as defined below, which contains the site-level credentials 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.

tags = None

A mapping of tags to assign to the resource.

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.CustomHostnameBinding(resource_name, opts=None, app_service_name=None, hostname=None, resource_group_name=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.

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, 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, __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.
  • 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.
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.

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.

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.

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

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.

site_credential = None

A site_credential block as defined below, which contains the site-level credentials 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.

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(kind=None, location=None, maximum_number_of_workers=None, properties=None, sku=None, tags=None, id=None)

A collection of values returned by getAppServicePlan.

kind = None

The Operating System type of the App Service Plan

location = None

The Azure location where the App Service Plan exists

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, outbound_ip_addresses=None, possible_outbound_ip_addresses=None, site_config=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.

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_config = 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, kind=None, location=None, name=None, per_site_scaling=None, properties=None, reserved=None, resource_group_name=None, sku=None, tags=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 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.
  • 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.
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 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_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.

tags = None

A mapping of tags to assign to the resource.

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, 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, __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 azurerm_app_service resource will be overwritten when promoting a Slot using the azurerm_app_service_active_slot 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.
  • 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.
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.

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.

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.

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.

tags = None

A mapping of tags to assign to the resource.

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, site_config=None, opts=None)

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

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).