@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Description for Gets the details of a static site.
*
* Uses Azure REST API version 2024-04-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 function getStaticSite(args: GetStaticSiteArgs, opts?: pulumi.InvokeOptions): Promise<GetStaticSiteResult>;
export interface GetStaticSiteArgs {
/**
* Name of the static site.
*/
name: string;
/**
* Name of the resource group to which the resource belongs.
*/
resourceGroupName: string;
}
/**
* Static Site ARM resource.
*/
export interface GetStaticSiteResult {
/**
* <code>false</code> if config file is locked for this static web app; otherwise, <code>true</code>.
*/
readonly allowConfigFileUpdates?: boolean;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The target branch in the repository.
*/
readonly branch?: string;
/**
* Build properties to configure on the repository.
*/
readonly buildProperties?: outputs.web.StaticSiteBuildPropertiesResponse;
/**
* The content distribution endpoint for the static site.
*/
readonly contentDistributionEndpoint: string;
/**
* The custom domains associated with this static site.
*/
readonly customDomains: string[];
/**
* Database connections for the static site
*/
readonly databaseConnections: outputs.web.DatabaseConnectionOverviewResponse[];
/**
* The default autogenerated hostname for the static site.
*/
readonly defaultHostname: string;
/**
* State indicating the status of the enterprise grade CDN serving traffic to the static web app.
*/
readonly enterpriseGradeCdnStatus?: string;
/**
* Resource Id.
*/
readonly id: string;
/**
* Managed service identity.
*/
readonly identity?: outputs.web.ManagedServiceIdentityResponse;
/**
* Identity to use for Key Vault Reference authentication.
*/
readonly keyVaultReferenceIdentity: 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?: string;
/**
* Backends linked to the static side
*/
readonly linkedBackends: outputs.web.StaticSiteLinkedBackendResponse[];
/**
* Resource Location.
*/
readonly location: string;
/**
* Resource Name.
*/
readonly name: string;
/**
* Private endpoint connections
*/
readonly privateEndpointConnections: outputs.web.ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse[];
/**
* The provider that submitted the last deployment to the primary environment of the static site.
*/
readonly provider?: string;
/**
* State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
*/
readonly publicNetworkAccess?: string;
/**
* A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
*/
readonly repositoryToken?: string;
/**
* URL for the repository of the static site.
*/
readonly repositoryUrl?: string;
/**
* Description of a SKU for a scalable resource.
*/
readonly sku?: outputs.web.SkuDescriptionResponse;
/**
* State indicating whether staging environments are allowed or not allowed for a static web app.
*/
readonly stagingEnvironmentPolicy?: string;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Template options for generating a new repository.
*/
readonly templateProperties?: outputs.web.StaticSiteTemplateOptionsResponse;
/**
* Resource type.
*/
readonly type: string;
/**
* User provided function apps registered with the static site
*/
readonly userProvidedFunctionApps: outputs.web.StaticSiteUserProvidedFunctionAppResponse[];
}
/**
* Description for Gets the details of a static site.
*
* Uses Azure REST API version 2024-04-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 function getStaticSiteOutput(args: GetStaticSiteOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStaticSiteResult>;
export interface GetStaticSiteOutputArgs {
/**
* Name of the static site.
*/
name: pulumi.Input<string>;
/**
* Name of the resource group to which the resource belongs.
*/
resourceGroupName: pulumi.Input<string>;
}