Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Static Website
  3. API Docs
  4. Website
Azure Static Website v0.0.5 published on Wednesday, Sep 14, 2022 by Pulumi
pulumi/pulumi-azure-static-website

azure-static-website.Website

Explore with Pulumi AI

azure-static-website logo
Azure Static Website v0.0.5 published on Wednesday, Sep 14, 2022 by Pulumi
pulumi/pulumi-azure-static-website

    Create Website Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Website(name: string, args: WebsiteArgs, opts?: ComponentResourceOptions);
    @overload
def Website(resource_name: str,
            args: WebsiteArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Website(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            site_path: Optional[str] = None,
            dns_zone_name: Optional[str] = None,
            domain_resource_group: Optional[str] = None,
            error_document: Optional[str] = None,
            index_document: Optional[str] = None,
            subdomain: Optional[str] = None,
            with_cdn: Optional[bool] = None)
    func NewWebsite(ctx *Context, name string, args WebsiteArgs, opts ...ResourceOption) (*Website, error)
    public Website(string name, WebsiteArgs args, ComponentResourceOptions? opts = null)
    public Website(String name, WebsiteArgs args)
public Website(String name, WebsiteArgs args, ComponentResourceOptions options)

    type: azure-static-website:Website
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WebsiteArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WebsiteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WebsiteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebsiteArgs
    The arguments to resource properties.
    opts ComponentResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebsiteArgs
    The arguments to resource properties.
    options ComponentResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var websiteResource = new AzureStaticWebsite.Website("websiteResource", new()
{
    SitePath = "string",
    DnsZoneName = "string",
    DomainResourceGroup = "string",
    ErrorDocument = "string",
    IndexDocument = "string",
    Subdomain = "string",
    WithCDN = false,
});

    example, err := azurestaticwebsite.NewWebsite(ctx, "websiteResource", &azurestaticwebsite.WebsiteArgs{
	SitePath:            pulumi.String("string"),
	DnsZoneName:         pulumi.String("string"),
	DomainResourceGroup: pulumi.String("string"),
	ErrorDocument:       pulumi.String("string"),
	IndexDocument:       pulumi.String("string"),
	Subdomain:           pulumi.String("string"),
	WithCDN:             pulumi.Bool(false),
})

    var websiteResource = new Website("websiteResource", WebsiteArgs.builder()
    .sitePath("string")
    .dnsZoneName("string")
    .domainResourceGroup("string")
    .errorDocument("string")
    .indexDocument("string")
    .subdomain("string")
    .withCDN(false)
    .build());

    website_resource = azure_static_website.Website("websiteResource",
    site_path="string",
    dns_zone_name="string",
    domain_resource_group="string",
    error_document="string",
    index_document="string",
    subdomain="string",
    with_cdn=False)

    const websiteResource = new azure_static_website.Website("websiteResource", {
    sitePath: "string",
    dnsZoneName: "string",
    domainResourceGroup: "string",
    errorDocument: "string",
    indexDocument: "string",
    subdomain: "string",
    withCDN: false,
});

    type: azure-static-website:Website
properties:
    dnsZoneName: string
    domainResourceGroup: string
    errorDocument: string
    indexDocument: string
    sitePath: string
    subdomain: string
    withCDN: false

    Website Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Website resource accepts the following input properties:

    SitePath string
    The root directory containing the website's contents.
    DnsZoneName string
    The name of the DNS zone that will be used to serve the static website. This must be set in order for this component to make the site accessible from a custom domain
    DomainResourceGroup string
    The name of the resource group your DNS zone is attached to
    ErrorDocument string
    The default 404 error page
    IndexDocument string
    The default document for the site. Defaults to index.html
    Subdomain string
    The subdomain used to access the static website. If not specified will configure with apex/root domain of the DNS zone specified.
    WithCDN bool
    Provision CDN to serve content.
    SitePath string
    The root directory containing the website's contents.
    DnsZoneName string
    The name of the DNS zone that will be used to serve the static website. This must be set in order for this component to make the site accessible from a custom domain
    DomainResourceGroup string
    The name of the resource group your DNS zone is attached to
    ErrorDocument string
    The default 404 error page
    IndexDocument string
    The default document for the site. Defaults to index.html
    Subdomain string
    The subdomain used to access the static website. If not specified will configure with apex/root domain of the DNS zone specified.
    WithCDN bool
    Provision CDN to serve content.
    sitePath String
    The root directory containing the website's contents.
    dnsZoneName String
    The name of the DNS zone that will be used to serve the static website. This must be set in order for this component to make the site accessible from a custom domain
    domainResourceGroup String
    The name of the resource group your DNS zone is attached to
    errorDocument String
    The default 404 error page
    indexDocument String
    The default document for the site. Defaults to index.html
    subdomain String
    The subdomain used to access the static website. If not specified will configure with apex/root domain of the DNS zone specified.
    withCDN Boolean
    Provision CDN to serve content.
    sitePath string
    The root directory containing the website's contents.
    dnsZoneName string
    The name of the DNS zone that will be used to serve the static website. This must be set in order for this component to make the site accessible from a custom domain
    domainResourceGroup string
    The name of the resource group your DNS zone is attached to
    errorDocument string
    The default 404 error page
    indexDocument string
    The default document for the site. Defaults to index.html
    subdomain string
    The subdomain used to access the static website. If not specified will configure with apex/root domain of the DNS zone specified.
    withCDN boolean
    Provision CDN to serve content.
    site_path str
    The root directory containing the website's contents.
    dns_zone_name str
    The name of the DNS zone that will be used to serve the static website. This must be set in order for this component to make the site accessible from a custom domain
    domain_resource_group str
    The name of the resource group your DNS zone is attached to
    error_document str
    The default 404 error page
    index_document str
    The default document for the site. Defaults to index.html
    subdomain str
    The subdomain used to access the static website. If not specified will configure with apex/root domain of the DNS zone specified.
    with_cdn bool
    Provision CDN to serve content.
    sitePath String
    The root directory containing the website's contents.
    dnsZoneName String
    The name of the DNS zone that will be used to serve the static website. This must be set in order for this component to make the site accessible from a custom domain
    domainResourceGroup String
    The name of the resource group your DNS zone is attached to
    errorDocument String
    The default 404 error page
    indexDocument String
    The default document for the site. Defaults to index.html
    subdomain String
    The subdomain used to access the static website. If not specified will configure with apex/root domain of the DNS zone specified.
    withCDN Boolean
    Provision CDN to serve content.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Website resource produces the following output properties:

    OriginURL string
    The Storage URL for the site
    ResourceGroupName string
    The name of the resource group that was provisioned to contain the needed static website resources
    CdnURL string
    The CDN URL for the site
    CustomDomainURL string
    The custom domain URL where the static website can be accessed
    OriginURL string
    The Storage URL for the site
    ResourceGroupName string
    The name of the resource group that was provisioned to contain the needed static website resources
    CdnURL string
    The CDN URL for the site
    CustomDomainURL string
    The custom domain URL where the static website can be accessed
    originURL String
    The Storage URL for the site
    resourceGroupName String
    The name of the resource group that was provisioned to contain the needed static website resources
    cdnURL String
    The CDN URL for the site
    customDomainURL String
    The custom domain URL where the static website can be accessed
    originURL string
    The Storage URL for the site
    resourceGroupName string
    The name of the resource group that was provisioned to contain the needed static website resources
    cdnURL string
    The CDN URL for the site
    customDomainURL string
    The custom domain URL where the static website can be accessed
    origin_url str
    The Storage URL for the site
    resource_group_name str
    The name of the resource group that was provisioned to contain the needed static website resources
    cdn_url str
    The CDN URL for the site
    custom_domain_url str
    The custom domain URL where the static website can be accessed
    originURL String
    The Storage URL for the site
    resourceGroupName String
    The name of the resource group that was provisioned to contain the needed static website resources
    cdnURL String
    The CDN URL for the site
    customDomainURL String
    The custom domain URL where the static website can be accessed

    Package Details

    Repository
    azure-static-website pulumi/pulumi-azure-static-website
    License
    azure-static-website logo
    Azure Static Website v0.0.5 published on Wednesday, Sep 14, 2022 by Pulumi
    pulumi/pulumi-azure-static-website