@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.79 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Static Site ARM resource.
*
* Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.
*
* Other available API versions: 2019-08-01, 2020-06-01, 2020-09-01, 2020-10-01, 2020-12-01, 2021-01-01, 2021-01-15, 2021-02-01, 2021-03-01, 2022-03-01, 2022-09-01, 2023-01-01, 2023-12-01, 2024-11-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native web [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class StaticSite extends pulumi.CustomResource {
/**
* Get an existing StaticSite resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): StaticSite;
/**
* Returns true if the given object is an instance of StaticSite. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is StaticSite;
/**
* <code>false</code> if config file is locked for this static web app; otherwise, <code>true</code>.
*/
readonly allowConfigFileUpdates: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The target branch in the repository.
*/
readonly branch: pulumi.Output<string | undefined>;
/**
* Build properties to configure on the repository.
*/
readonly buildProperties: pulumi.Output<outputs.web.StaticSiteBuildPropertiesResponse | undefined>;
/**
* The content distribution endpoint for the static site.
*/
readonly contentDistributionEndpoint: pulumi.Output<string>;
/**
* The custom domains associated with this static site.
*/
readonly customDomains: pulumi.Output<string[]>;
/**
* Database connections for the static site
*/
readonly databaseConnections: pulumi.Output<outputs.web.DatabaseConnectionOverviewResponse[]>;
/**
* The default autogenerated hostname for the static site.
*/
readonly defaultHostname: pulumi.Output<string>;
/**
* State indicating the status of the enterprise grade CDN serving traffic to the static web app.
*/
readonly enterpriseGradeCdnStatus: pulumi.Output<string | undefined>;
/**
* Managed service identity.
*/
readonly identity: pulumi.Output<outputs.web.ManagedServiceIdentityResponse | undefined>;
/**
* Identity to use for Key Vault Reference authentication.
*/
readonly keyVaultReferenceIdentity: pulumi.Output<string>;
/**
* Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
*/
readonly kind: pulumi.Output<string | undefined>;
/**
* Backends linked to the static side
*/
readonly linkedBackends: pulumi.Output<outputs.web.StaticSiteLinkedBackendResponse[]>;
/**
* Resource Location.
*/
readonly location: pulumi.Output<string>;
/**
* Resource Name.
*/
readonly name: pulumi.Output<string>;
/**
* Private endpoint connections
*/
readonly privateEndpointConnections: pulumi.Output<outputs.web.ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse[]>;
/**
* The provider that submitted the last deployment to the primary environment of the static site.
*/
readonly provider: pulumi.Output<string | undefined>;
/**
* State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
*/
readonly publicNetworkAccess: pulumi.Output<string | undefined>;
/**
* A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
*/
readonly repositoryToken: pulumi.Output<string | undefined>;
/**
* URL for the repository of the static site.
*/
readonly repositoryUrl: pulumi.Output<string | undefined>;
/**
* Description of a SKU for a scalable resource.
*/
readonly sku: pulumi.Output<outputs.web.SkuDescriptionResponse | undefined>;
/**
* State indicating whether staging environments are allowed or not allowed for a static web app.
*/
readonly stagingEnvironmentPolicy: pulumi.Output<string | undefined>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Template options for generating a new repository.
*/
readonly templateProperties: pulumi.Output<outputs.web.StaticSiteTemplateOptionsResponse | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* User provided function apps registered with the static site
*/
readonly userProvidedFunctionApps: pulumi.Output<outputs.web.StaticSiteUserProvidedFunctionAppResponse[]>;
/**
* Create a StaticSite resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: StaticSiteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a StaticSite resource.
*/
export interface StaticSiteArgs {
/**
* <code>false</code> if config file is locked for this static web app; otherwise, <code>true</code>.
*/
allowConfigFileUpdates?: pulumi.Input<boolean>;
/**
* The target branch in the repository.
*/
branch?: pulumi.Input<string>;
/**
* Build properties to configure on the repository.
*/
buildProperties?: pulumi.Input<inputs.web.StaticSiteBuildPropertiesArgs>;
/**
* State indicating the status of the enterprise grade CDN serving traffic to the static web app.
*/
enterpriseGradeCdnStatus?: pulumi.Input<string | enums.web.EnterpriseGradeCdnStatus>;
/**
* Managed service identity.
*/
identity?: pulumi.Input<inputs.web.ManagedServiceIdentityArgs>;
/**
* Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
*/
kind?: pulumi.Input<string>;
/**
* Resource Location.
*/
location?: pulumi.Input<string>;
/**
* Name of the static site to create or update.
*/
name?: pulumi.Input<string>;
/**
* The provider that submitted the last deployment to the primary environment of the static site.
*/
provider?: pulumi.Input<string>;
/**
* State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
*/
publicNetworkAccess?: pulumi.Input<string>;
/**
* A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
*/
repositoryToken?: pulumi.Input<string>;
/**
* URL for the repository of the static site.
*/
repositoryUrl?: pulumi.Input<string>;
/**
* Name of the resource group to which the resource belongs.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Description of a SKU for a scalable resource.
*/
sku?: pulumi.Input<inputs.web.SkuDescriptionArgs>;
/**
* State indicating whether staging environments are allowed or not allowed for a static web app.
*/
stagingEnvironmentPolicy?: pulumi.Input<enums.web.StagingEnvironmentPolicy>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Template options for generating a new repository.
*/
templateProperties?: pulumi.Input<inputs.web.StaticSiteTemplateOptionsArgs>;
}