Azure Native v2.63.0, Sep 24 24

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.web.getStaticSite

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-azure-native

Using getStaticSite

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getStaticSite(args: GetStaticSiteArgs, opts?: InvokeOptions): Promise<GetStaticSiteResult>
function getStaticSiteOutput(args: GetStaticSiteOutputArgs, opts?: InvokeOptions): Output<GetStaticSiteResult>

def get_static_site(name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetStaticSiteResult
def get_static_site_output(name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetStaticSiteResult]

func LookupStaticSite(ctx *Context, args *LookupStaticSiteArgs, opts ...InvokeOption) (*LookupStaticSiteResult, error)
func LookupStaticSiteOutput(ctx *Context, args *LookupStaticSiteOutputArgs, opts ...InvokeOption) LookupStaticSiteResultOutput

> Note: This function is named LookupStaticSite in the Go SDK.

public static class GetStaticSite 
{
    public static Task<GetStaticSiteResult> InvokeAsync(GetStaticSiteArgs args, InvokeOptions? opts = null)
    public static Output<GetStaticSiteResult> Invoke(GetStaticSiteInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetStaticSiteResult> getStaticSite(GetStaticSiteArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:web:getStaticSite
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the static site.
ResourceGroupName string: Name of the resource group to which the resource belongs.

Name string: Name of the static site.
ResourceGroupName string: Name of the resource group to which the resource belongs.

name String: Name of the static site.
resourceGroupName String: Name of the resource group to which the resource belongs.

name string: Name of the static site.
resourceGroupName string: Name of the resource group to which the resource belongs.

name str: Name of the static site.
resource_group_name str: Name of the resource group to which the resource belongs.

name String: Name of the static site.
resourceGroupName String: Name of the resource group to which the resource belongs.

getStaticSite Result

The following output properties are available:

ContentDistributionEndpoint string: The content distribution endpoint for the static site.
CustomDomains List<string>: The custom domains associated with this static site.
DatabaseConnections List<Pulumi.AzureNative.Web.Outputs.DatabaseConnectionOverviewResponse>: Database connections for the static site
DefaultHostname string: The default autogenerated hostname for the static site.
Id string: Resource Id.
KeyVaultReferenceIdentity string: Identity to use for Key Vault Reference authentication.
LinkedBackends List<Pulumi.AzureNative.Web.Outputs.StaticSiteLinkedBackendResponse>: Backends linked to the static side
Location string: Resource Location.
Name string: Resource Name.
PrivateEndpointConnections List<Pulumi.AzureNative.Web.Outputs.ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse>: Private endpoint connections
Type string: Resource type.
UserProvidedFunctionApps List<Pulumi.AzureNative.Web.Outputs.StaticSiteUserProvidedFunctionAppResponse>: User provided function apps registered with the static site
AllowConfigFileUpdates bool: false if config file is locked for this static web app; otherwise, true.
Branch string: The target branch in the repository.
BuildProperties Pulumi.AzureNative.Web.Outputs.StaticSiteBuildPropertiesResponse: Build properties to configure on the repository.
EnterpriseGradeCdnStatus string: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
Identity Pulumi.AzureNative.Web.Outputs.ManagedServiceIdentityResponse: Managed service identity.
Kind string: Kind of resource.
Provider string: The provider that submitted the last deployment to the primary environment of the static site.
PublicNetworkAccess string: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
RepositoryToken string: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
RepositoryUrl string: URL for the repository of the static site.
Sku Pulumi.AzureNative.Web.Outputs.SkuDescriptionResponse: Description of a SKU for a scalable resource.
StagingEnvironmentPolicy string: State indicating whether staging environments are allowed or not allowed for a static web app.
Tags Dictionary<string, string>: Resource tags.
TemplateProperties Pulumi.AzureNative.Web.Outputs.StaticSiteTemplateOptionsResponse: Template options for generating a new repository.

ContentDistributionEndpoint string: The content distribution endpoint for the static site.
CustomDomains []string: The custom domains associated with this static site.
DatabaseConnections []DatabaseConnectionOverviewResponse: Database connections for the static site
DefaultHostname string: The default autogenerated hostname for the static site.
Id string: Resource Id.
KeyVaultReferenceIdentity string: Identity to use for Key Vault Reference authentication.
LinkedBackends []StaticSiteLinkedBackendResponse: Backends linked to the static side
Location string: Resource Location.
Name string: Resource Name.
PrivateEndpointConnections []ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse: Private endpoint connections
Type string: Resource type.
UserProvidedFunctionApps []StaticSiteUserProvidedFunctionAppResponse: User provided function apps registered with the static site
AllowConfigFileUpdates bool: false if config file is locked for this static web app; otherwise, true.
Branch string: The target branch in the repository.
BuildProperties StaticSiteBuildPropertiesResponse: Build properties to configure on the repository.
EnterpriseGradeCdnStatus string: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
Identity ManagedServiceIdentityResponse: Managed service identity.
Kind string: Kind of resource.
Provider string: The provider that submitted the last deployment to the primary environment of the static site.
PublicNetworkAccess string: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
RepositoryToken string: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
RepositoryUrl string: URL for the repository of the static site.
Sku SkuDescriptionResponse: Description of a SKU for a scalable resource.
StagingEnvironmentPolicy string: State indicating whether staging environments are allowed or not allowed for a static web app.
Tags map[string]string: Resource tags.
TemplateProperties StaticSiteTemplateOptionsResponse: Template options for generating a new repository.

contentDistributionEndpoint String: The content distribution endpoint for the static site.
customDomains List<String>: The custom domains associated with this static site.
databaseConnections List<DatabaseConnectionOverviewResponse>: Database connections for the static site
defaultHostname String: The default autogenerated hostname for the static site.
id String: Resource Id.
keyVaultReferenceIdentity String: Identity to use for Key Vault Reference authentication.
linkedBackends List<StaticSiteLinkedBackendResponse>: Backends linked to the static side
location String: Resource Location.
name String: Resource Name.
privateEndpointConnections List<ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse>: Private endpoint connections
type String: Resource type.
userProvidedFunctionApps List<StaticSiteUserProvidedFunctionAppResponse>: User provided function apps registered with the static site
allowConfigFileUpdates Boolean: false if config file is locked for this static web app; otherwise, true.
branch String: The target branch in the repository.
buildProperties StaticSiteBuildPropertiesResponse: Build properties to configure on the repository.
enterpriseGradeCdnStatus String: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
identity ManagedServiceIdentityResponse: Managed service identity.
kind String: Kind of resource.
provider String: The provider that submitted the last deployment to the primary environment of the static site.
publicNetworkAccess String: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
repositoryToken String: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
repositoryUrl String: URL for the repository of the static site.
sku SkuDescriptionResponse: Description of a SKU for a scalable resource.
stagingEnvironmentPolicy String: State indicating whether staging environments are allowed or not allowed for a static web app.
tags Map<String,String>: Resource tags.
templateProperties StaticSiteTemplateOptionsResponse: Template options for generating a new repository.

contentDistributionEndpoint string: The content distribution endpoint for the static site.
customDomains string[]: The custom domains associated with this static site.
databaseConnections DatabaseConnectionOverviewResponse[]: Database connections for the static site
defaultHostname string: The default autogenerated hostname for the static site.
id string: Resource Id.
keyVaultReferenceIdentity string: Identity to use for Key Vault Reference authentication.
linkedBackends StaticSiteLinkedBackendResponse[]: Backends linked to the static side
location string: Resource Location.
name string: Resource Name.
privateEndpointConnections ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse[]: Private endpoint connections
type string: Resource type.
userProvidedFunctionApps StaticSiteUserProvidedFunctionAppResponse[]: User provided function apps registered with the static site
allowConfigFileUpdates boolean: false if config file is locked for this static web app; otherwise, true.
branch string: The target branch in the repository.
buildProperties StaticSiteBuildPropertiesResponse: Build properties to configure on the repository.
enterpriseGradeCdnStatus string: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
identity ManagedServiceIdentityResponse: Managed service identity.
kind string: Kind of resource.
provider string: The provider that submitted the last deployment to the primary environment of the static site.
publicNetworkAccess string: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
repositoryToken string: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
repositoryUrl string: URL for the repository of the static site.
sku SkuDescriptionResponse: Description of a SKU for a scalable resource.
stagingEnvironmentPolicy string: State indicating whether staging environments are allowed or not allowed for a static web app.
tags {[key: string]: string}: Resource tags.
templateProperties StaticSiteTemplateOptionsResponse: Template options for generating a new repository.

content_distribution_endpoint str: The content distribution endpoint for the static site.
custom_domains Sequence[str]: The custom domains associated with this static site.
database_connections Sequence[DatabaseConnectionOverviewResponse]: Database connections for the static site
default_hostname str: The default autogenerated hostname for the static site.
id str: Resource Id.
key_vault_reference_identity str: Identity to use for Key Vault Reference authentication.
linked_backends Sequence[StaticSiteLinkedBackendResponse]: Backends linked to the static side
location str: Resource Location.
name str: Resource Name.
private_endpoint_connections Sequence[ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse]: Private endpoint connections
type str: Resource type.
user_provided_function_apps Sequence[StaticSiteUserProvidedFunctionAppResponse]: User provided function apps registered with the static site
allow_config_file_updates bool: false if config file is locked for this static web app; otherwise, true.
branch str: The target branch in the repository.
build_properties StaticSiteBuildPropertiesResponse: Build properties to configure on the repository.
enterprise_grade_cdn_status str: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
identity ManagedServiceIdentityResponse: Managed service identity.
kind str: Kind of resource.
provider str: The provider that submitted the last deployment to the primary environment of the static site.
public_network_access str: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
repository_token str: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
repository_url str: URL for the repository of the static site.
sku SkuDescriptionResponse: Description of a SKU for a scalable resource.
staging_environment_policy str: State indicating whether staging environments are allowed or not allowed for a static web app.
tags Mapping[str, str]: Resource tags.
template_properties StaticSiteTemplateOptionsResponse: Template options for generating a new repository.

contentDistributionEndpoint String: The content distribution endpoint for the static site.
customDomains List<String>: The custom domains associated with this static site.
databaseConnections List<Property Map>: Database connections for the static site
defaultHostname String: The default autogenerated hostname for the static site.
id String: Resource Id.
keyVaultReferenceIdentity String: Identity to use for Key Vault Reference authentication.
linkedBackends List<Property Map>: Backends linked to the static side
location String: Resource Location.
name String: Resource Name.
privateEndpointConnections List<Property Map>: Private endpoint connections
type String: Resource type.
userProvidedFunctionApps List<Property Map>: User provided function apps registered with the static site
allowConfigFileUpdates Boolean: false if config file is locked for this static web app; otherwise, true.
branch String: The target branch in the repository.
buildProperties Property Map: Build properties to configure on the repository.
enterpriseGradeCdnStatus String: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
identity Property Map: Managed service identity.
kind String: Kind of resource.
provider String: The provider that submitted the last deployment to the primary environment of the static site.
publicNetworkAccess String: State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
repositoryToken String: A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
repositoryUrl String: URL for the repository of the static site.
sku Property Map: Description of a SKU for a scalable resource.
stagingEnvironmentPolicy String: State indicating whether staging environments are allowed or not allowed for a static web app.
tags Map<String>: Resource tags.
templateProperties Property Map: Template options for generating a new repository.

Supporting Types

ArmIdWrapperResponse

Id string

Id string

id String

id string

id str

id String

ArmPlanResponse

Name string: The name.
Product string: The product.
PromotionCode string: The promotion code.
Publisher string: The publisher.
Version string: Version of product.

Name string: The name.
Product string: The product.
PromotionCode string: The promotion code.
Publisher string: The publisher.
Version string: Version of product.

name String: The name.
product String: The product.
promotionCode String: The promotion code.
publisher String: The publisher.
version String: Version of product.

name string: The name.
product string: The product.
promotionCode string: The promotion code.
publisher string: The publisher.
version string: Version of product.

name str: The name.
product str: The product.
promotion_code str: The promotion code.
publisher str: The publisher.
version str: Version of product.

name String: The name.
product String: The product.
promotionCode String: The promotion code.
publisher String: The publisher.
version String: Version of product.

CapabilityResponse

Name string: Name of the SKU capability.
Reason string: Reason of the SKU capability.
Value string: Value of the SKU capability.

Name string: Name of the SKU capability.
Reason string: Reason of the SKU capability.
Value string: Value of the SKU capability.

name String: Name of the SKU capability.
reason String: Reason of the SKU capability.
value String: Value of the SKU capability.

name string: Name of the SKU capability.
reason string: Reason of the SKU capability.
value string: Value of the SKU capability.

name str: Name of the SKU capability.
reason str: Reason of the SKU capability.
value str: Value of the SKU capability.

name String: Name of the SKU capability.
reason String: Reason of the SKU capability.
value String: Value of the SKU capability.

DatabaseConnectionOverviewResponse

ConfigurationFiles List<Pulumi.AzureNative.Web.Inputs.StaticSiteDatabaseConnectionConfigurationFileOverviewResponse>: A list of configuration files associated with this database connection.
ConnectionIdentity string: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
Name string: If present, the name of this database connection resource.
Region string: The region of the database resource.
ResourceId string: The resource id of the database.

ConfigurationFiles []StaticSiteDatabaseConnectionConfigurationFileOverviewResponse: A list of configuration files associated with this database connection.
ConnectionIdentity string: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
Name string: If present, the name of this database connection resource.
Region string: The region of the database resource.
ResourceId string: The resource id of the database.

configurationFiles List<StaticSiteDatabaseConnectionConfigurationFileOverviewResponse>: A list of configuration files associated with this database connection.
connectionIdentity String: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
name String: If present, the name of this database connection resource.
region String: The region of the database resource.
resourceId String: The resource id of the database.

configurationFiles StaticSiteDatabaseConnectionConfigurationFileOverviewResponse[]: A list of configuration files associated with this database connection.
connectionIdentity string: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
name string: If present, the name of this database connection resource.
region string: The region of the database resource.
resourceId string: The resource id of the database.

configuration_files Sequence[StaticSiteDatabaseConnectionConfigurationFileOverviewResponse]: A list of configuration files associated with this database connection.
connection_identity str: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
name str: If present, the name of this database connection resource.
region str: The region of the database resource.
resource_id str: The resource id of the database.

configurationFiles List<Property Map>: A list of configuration files associated with this database connection.
connectionIdentity String: If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
name String: If present, the name of this database connection resource.
region String: The region of the database resource.
resourceId String: The resource id of the database.

ErrorEntityResponse

Code string: Basic error code.
Details List<Pulumi.AzureNative.Web.Inputs.ErrorEntityResponse>: Error Details.
ExtendedCode string: Type of error.
InnerErrors List<Pulumi.AzureNative.Web.Inputs.ErrorEntityResponse>: Inner errors.
Message string: Any details of the error.
MessageTemplate string: Message template.
Parameters List<string>: Parameters for the template.
Target string: The error target.

Code string: Basic error code.
Details []ErrorEntityResponse: Error Details.
ExtendedCode string: Type of error.
InnerErrors []ErrorEntityResponse: Inner errors.
Message string: Any details of the error.
MessageTemplate string: Message template.
Parameters []string: Parameters for the template.
Target string: The error target.

code String: Basic error code.
details List<ErrorEntityResponse>: Error Details.
extendedCode String: Type of error.
innerErrors List<ErrorEntityResponse>: Inner errors.
message String: Any details of the error.
messageTemplate String: Message template.
parameters List<String>: Parameters for the template.
target String: The error target.

code string: Basic error code.
details ErrorEntityResponse[]: Error Details.
extendedCode string: Type of error.
innerErrors ErrorEntityResponse[]: Inner errors.
message string: Any details of the error.
messageTemplate string: Message template.
parameters string[]: Parameters for the template.
target string: The error target.

code str: Basic error code.
details Sequence[ErrorEntityResponse]: Error Details.
extended_code str: Type of error.
inner_errors Sequence[ErrorEntityResponse]: Inner errors.
message str: Any details of the error.
message_template str: Message template.
parameters Sequence[str]: Parameters for the template.
target str: The error target.

code String: Basic error code.
details List<Property Map>: Error Details.
extendedCode String: Type of error.
innerErrors List<Property Map>: Inner errors.
message String: Any details of the error.
messageTemplate String: Message template.
parameters List<String>: Parameters for the template.
target String: The error target.

ManagedServiceIdentityResponse

PrincipalId string: Principal Id of managed service identity.
TenantId string: Tenant of managed service identity.
Type string: Type of managed service identity.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Web.Inputs.UserAssignedIdentityResponse>: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

PrincipalId string: Principal Id of managed service identity.
TenantId string: Tenant of managed service identity.
Type string: Type of managed service identity.
UserAssignedIdentities map[string]UserAssignedIdentityResponse: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

principalId String: Principal Id of managed service identity.
tenantId String: Tenant of managed service identity.
type String: Type of managed service identity.
userAssignedIdentities Map<String,UserAssignedIdentityResponse>: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

principalId string: Principal Id of managed service identity.
tenantId string: Tenant of managed service identity.
type string: Type of managed service identity.
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

principal_id str: Principal Id of managed service identity.
tenant_id str: Tenant of managed service identity.
type str: Type of managed service identity.
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

principalId String: Principal Id of managed service identity.
tenantId String: Tenant of managed service identity.
type String: Type of managed service identity.
userAssignedIdentities Map<Property Map>: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

PrivateLinkConnectionStateResponse

ActionsRequired string: ActionsRequired for a private link connection
Description string: Description of a private link connection
Status string: Status of a private link connection

ActionsRequired string: ActionsRequired for a private link connection
Description string: Description of a private link connection
Status string: Status of a private link connection

actionsRequired String: ActionsRequired for a private link connection
description String: Description of a private link connection
status String: Status of a private link connection

actionsRequired string: ActionsRequired for a private link connection
description string: Description of a private link connection
status string: Status of a private link connection

actions_required str: ActionsRequired for a private link connection
description str: Description of a private link connection
status str: Status of a private link connection

actionsRequired String: ActionsRequired for a private link connection
description String: Description of a private link connection
status String: Status of a private link connection

RemotePrivateEndpointConnectionResponse

Id string: Resource Id.
Name string: Resource Name.
ProvisioningState string
Type string: Resource type.
IpAddresses List<string>: Private IPAddresses mapped to the remote private endpoint
Kind string: Kind of resource.
PrivateEndpoint Pulumi.AzureNative.Web.Inputs.ArmIdWrapperResponse: PrivateEndpoint of a remote private endpoint connection
PrivateLinkServiceConnectionState Pulumi.AzureNative.Web.Inputs.PrivateLinkConnectionStateResponse: The state of a private link connection

Id string: Resource Id.
Name string: Resource Name.
ProvisioningState string
Type string: Resource type.
IpAddresses []string: Private IPAddresses mapped to the remote private endpoint
Kind string: Kind of resource.
PrivateEndpoint ArmIdWrapperResponse: PrivateEndpoint of a remote private endpoint connection
PrivateLinkServiceConnectionState PrivateLinkConnectionStateResponse: The state of a private link connection

id String: Resource Id.
name String: Resource Name.
provisioningState String
type String: Resource type.
ipAddresses List<String>: Private IPAddresses mapped to the remote private endpoint
kind String: Kind of resource.
privateEndpoint ArmIdWrapperResponse: PrivateEndpoint of a remote private endpoint connection
privateLinkServiceConnectionState PrivateLinkConnectionStateResponse: The state of a private link connection

id string: Resource Id.
name string: Resource Name.
provisioningState string
type string: Resource type.
ipAddresses string[]: Private IPAddresses mapped to the remote private endpoint
kind string: Kind of resource.
privateEndpoint ArmIdWrapperResponse: PrivateEndpoint of a remote private endpoint connection
privateLinkServiceConnectionState PrivateLinkConnectionStateResponse: The state of a private link connection

id str: Resource Id.
name str: Resource Name.
provisioning_state str
type str: Resource type.
ip_addresses Sequence[str]: Private IPAddresses mapped to the remote private endpoint
kind str: Kind of resource.
private_endpoint ArmIdWrapperResponse: PrivateEndpoint of a remote private endpoint connection
private_link_service_connection_state PrivateLinkConnectionStateResponse: The state of a private link connection

id String: Resource Id.
name String: Resource Name.
provisioningState String
type String: Resource type.
ipAddresses List<String>: Private IPAddresses mapped to the remote private endpoint
kind String: Kind of resource.
privateEndpoint Property Map: PrivateEndpoint of a remote private endpoint connection
privateLinkServiceConnectionState Property Map: The state of a private link connection

ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse

Error Pulumi.AzureNative.Web.Inputs.ErrorEntityResponse: Azure-AsyncOperation Error info.
Id string: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
Identity Pulumi.AzureNative.Web.Inputs.ManagedServiceIdentityResponse: MSI resource
Location string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
Name string: Name of resource.
Plan Pulumi.AzureNative.Web.Inputs.ArmPlanResponse: Azure resource manager plan.
Properties Pulumi.AzureNative.Web.Inputs.RemotePrivateEndpointConnectionResponse: Resource specific properties.
Sku Pulumi.AzureNative.Web.Inputs.SkuDescriptionResponse: SKU description of the resource.
Status string: Azure-AsyncOperation Status info.
Tags Dictionary<string, string>: Tags associated with resource.
Type string: Type of resource e.g "Microsoft.Web/sites".
Zones List<string>: Logical Availability Zones the service is hosted in

Error ErrorEntityResponse: Azure-AsyncOperation Error info.
Id string: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
Identity ManagedServiceIdentityResponse: MSI resource
Location string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
Name string: Name of resource.
Plan ArmPlanResponse: Azure resource manager plan.
Properties RemotePrivateEndpointConnectionResponse: Resource specific properties.
Sku SkuDescriptionResponse: SKU description of the resource.
Status string: Azure-AsyncOperation Status info.
Tags map[string]string: Tags associated with resource.
Type string: Type of resource e.g "Microsoft.Web/sites".
Zones []string: Logical Availability Zones the service is hosted in

error ErrorEntityResponse: Azure-AsyncOperation Error info.
id String: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
identity ManagedServiceIdentityResponse: MSI resource
location String: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
name String: Name of resource.
plan ArmPlanResponse: Azure resource manager plan.
properties RemotePrivateEndpointConnectionResponse: Resource specific properties.
sku SkuDescriptionResponse: SKU description of the resource.
status String: Azure-AsyncOperation Status info.
tags Map<String,String>: Tags associated with resource.
type String: Type of resource e.g "Microsoft.Web/sites".
zones List<String>: Logical Availability Zones the service is hosted in

error ErrorEntityResponse: Azure-AsyncOperation Error info.
id string: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
identity ManagedServiceIdentityResponse: MSI resource
location string: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
name string: Name of resource.
plan ArmPlanResponse: Azure resource manager plan.
properties RemotePrivateEndpointConnectionResponse: Resource specific properties.
sku SkuDescriptionResponse: SKU description of the resource.
status string: Azure-AsyncOperation Status info.
tags {[key: string]: string}: Tags associated with resource.
type string: Type of resource e.g "Microsoft.Web/sites".
zones string[]: Logical Availability Zones the service is hosted in

error ErrorEntityResponse: Azure-AsyncOperation Error info.
id str: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
identity ManagedServiceIdentityResponse: MSI resource
location str: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
name str: Name of resource.
plan ArmPlanResponse: Azure resource manager plan.
properties RemotePrivateEndpointConnectionResponse: Resource specific properties.
sku SkuDescriptionResponse: SKU description of the resource.
status str: Azure-AsyncOperation Status info.
tags Mapping[str, str]: Tags associated with resource.
type str: Type of resource e.g "Microsoft.Web/sites".
zones Sequence[str]: Logical Availability Zones the service is hosted in

error Property Map: Azure-AsyncOperation Error info.
id String: Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
identity Property Map: MSI resource
location String: Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
name String: Name of resource.
plan Property Map: Azure resource manager plan.
properties Property Map: Resource specific properties.
sku Property Map: SKU description of the resource.
status String: Azure-AsyncOperation Status info.
tags Map<String>: Tags associated with resource.
type String: Type of resource e.g "Microsoft.Web/sites".
zones List<String>: Logical Availability Zones the service is hosted in

SkuCapacityResponse

Default int: Default number of workers for this App Service plan SKU.
ElasticMaximum int: Maximum number of Elastic workers for this App Service plan SKU.
Maximum int: Maximum number of workers for this App Service plan SKU.
Minimum int: Minimum number of workers for this App Service plan SKU.
ScaleType string: Available scale configurations for an App Service plan.

Default int: Default number of workers for this App Service plan SKU.
ElasticMaximum int: Maximum number of Elastic workers for this App Service plan SKU.
Maximum int: Maximum number of workers for this App Service plan SKU.
Minimum int: Minimum number of workers for this App Service plan SKU.
ScaleType string: Available scale configurations for an App Service plan.

default_ Integer: Default number of workers for this App Service plan SKU.
elasticMaximum Integer: Maximum number of Elastic workers for this App Service plan SKU.
maximum Integer: Maximum number of workers for this App Service plan SKU.
minimum Integer: Minimum number of workers for this App Service plan SKU.
scaleType String: Available scale configurations for an App Service plan.

default number: Default number of workers for this App Service plan SKU.
elasticMaximum number: Maximum number of Elastic workers for this App Service plan SKU.
maximum number: Maximum number of workers for this App Service plan SKU.
minimum number: Minimum number of workers for this App Service plan SKU.
scaleType string: Available scale configurations for an App Service plan.

default int: Default number of workers for this App Service plan SKU.
elastic_maximum int: Maximum number of Elastic workers for this App Service plan SKU.
maximum int: Maximum number of workers for this App Service plan SKU.
minimum int: Minimum number of workers for this App Service plan SKU.
scale_type str: Available scale configurations for an App Service plan.

default Number: Default number of workers for this App Service plan SKU.
elasticMaximum Number: Maximum number of Elastic workers for this App Service plan SKU.
maximum Number: Maximum number of workers for this App Service plan SKU.
minimum Number: Minimum number of workers for this App Service plan SKU.
scaleType String: Available scale configurations for an App Service plan.

SkuDescriptionResponse

Capabilities List<Pulumi.AzureNative.Web.Inputs.CapabilityResponse>: Capabilities of the SKU, e.g., is traffic manager enabled?
Capacity int: Current number of instances assigned to the resource.
Family string: Family code of the resource SKU.
Locations List<string>: Locations of the SKU.
Name string: Name of the resource SKU.
Size string: Size specifier of the resource SKU.
SkuCapacity Pulumi.AzureNative.Web.Inputs.SkuCapacityResponse: Min, max, and default scale values of the SKU.
Tier string: Service tier of the resource SKU.

Capabilities []CapabilityResponse: Capabilities of the SKU, e.g., is traffic manager enabled?
Capacity int: Current number of instances assigned to the resource.
Family string: Family code of the resource SKU.
Locations []string: Locations of the SKU.
Name string: Name of the resource SKU.
Size string: Size specifier of the resource SKU.
SkuCapacity SkuCapacityResponse: Min, max, and default scale values of the SKU.
Tier string: Service tier of the resource SKU.

capabilities List<CapabilityResponse>: Capabilities of the SKU, e.g., is traffic manager enabled?
capacity Integer: Current number of instances assigned to the resource.
family String: Family code of the resource SKU.
locations List<String>: Locations of the SKU.
name String: Name of the resource SKU.
size String: Size specifier of the resource SKU.
skuCapacity SkuCapacityResponse: Min, max, and default scale values of the SKU.
tier String: Service tier of the resource SKU.

capabilities CapabilityResponse[]: Capabilities of the SKU, e.g., is traffic manager enabled?
capacity number: Current number of instances assigned to the resource.
family string: Family code of the resource SKU.
locations string[]: Locations of the SKU.
name string: Name of the resource SKU.
size string: Size specifier of the resource SKU.
skuCapacity SkuCapacityResponse: Min, max, and default scale values of the SKU.
tier string: Service tier of the resource SKU.

capabilities Sequence[CapabilityResponse]: Capabilities of the SKU, e.g., is traffic manager enabled?
capacity int: Current number of instances assigned to the resource.
family str: Family code of the resource SKU.
locations Sequence[str]: Locations of the SKU.
name str: Name of the resource SKU.
size str: Size specifier of the resource SKU.
sku_capacity SkuCapacityResponse: Min, max, and default scale values of the SKU.
tier str: Service tier of the resource SKU.

capabilities List<Property Map>: Capabilities of the SKU, e.g., is traffic manager enabled?
capacity Number: Current number of instances assigned to the resource.
family String: Family code of the resource SKU.
locations List<String>: Locations of the SKU.
name String: Name of the resource SKU.
size String: Size specifier of the resource SKU.
skuCapacity Property Map: Min, max, and default scale values of the SKU.
tier String: Service tier of the resource SKU.

StaticSiteBuildPropertiesResponse

ApiBuildCommand string: A custom command to run during deployment of the Azure Functions API application.
ApiLocation string: The path to the api code within the repository.
AppArtifactLocation string: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)
AppBuildCommand string: A custom command to run during deployment of the static content application.
AppLocation string: The path to the app code within the repository.
GithubActionSecretNameOverride string: Github Action secret name override.
OutputLocation string: The output path of the app after building.
SkipGithubActionWorkflowGeneration bool: Skip Github Action workflow generation.

ApiBuildCommand string: A custom command to run during deployment of the Azure Functions API application.
ApiLocation string: The path to the api code within the repository.
AppArtifactLocation string: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)
AppBuildCommand string: A custom command to run during deployment of the static content application.
AppLocation string: The path to the app code within the repository.
GithubActionSecretNameOverride string: Github Action secret name override.
OutputLocation string: The output path of the app after building.
SkipGithubActionWorkflowGeneration bool: Skip Github Action workflow generation.

apiBuildCommand String: A custom command to run during deployment of the Azure Functions API application.
apiLocation String: The path to the api code within the repository.
appArtifactLocation String: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)
appBuildCommand String: A custom command to run during deployment of the static content application.
appLocation String: The path to the app code within the repository.
githubActionSecretNameOverride String: Github Action secret name override.
outputLocation String: The output path of the app after building.
skipGithubActionWorkflowGeneration Boolean: Skip Github Action workflow generation.

apiBuildCommand string: A custom command to run during deployment of the Azure Functions API application.
apiLocation string: The path to the api code within the repository.
appArtifactLocation string: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)
appBuildCommand string: A custom command to run during deployment of the static content application.
appLocation string: The path to the app code within the repository.
githubActionSecretNameOverride string: Github Action secret name override.
outputLocation string: The output path of the app after building.
skipGithubActionWorkflowGeneration boolean: Skip Github Action workflow generation.

api_build_command str: A custom command to run during deployment of the Azure Functions API application.
api_location str: The path to the api code within the repository.
app_artifact_location str: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)
app_build_command str: A custom command to run during deployment of the static content application.
app_location str: The path to the app code within the repository.
github_action_secret_name_override str: Github Action secret name override.
output_location str: The output path of the app after building.
skip_github_action_workflow_generation bool: Skip Github Action workflow generation.

apiBuildCommand String: A custom command to run during deployment of the Azure Functions API application.
apiLocation String: The path to the api code within the repository.
appArtifactLocation String: Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)
appBuildCommand String: A custom command to run during deployment of the static content application.
appLocation String: The path to the app code within the repository.
githubActionSecretNameOverride String: Github Action secret name override.
outputLocation String: The output path of the app after building.
skipGithubActionWorkflowGeneration Boolean: Skip Github Action workflow generation.

StaticSiteDatabaseConnectionConfigurationFileOverviewResponse

Contents string: The Base64 encoding of the file contents.
FileName string: The name of the configuration file.
Type string: The type of configuration file.

Contents string: The Base64 encoding of the file contents.
FileName string: The name of the configuration file.
Type string: The type of configuration file.

contents String: The Base64 encoding of the file contents.
fileName String: The name of the configuration file.
type String: The type of configuration file.

contents string: The Base64 encoding of the file contents.
fileName string: The name of the configuration file.
type string: The type of configuration file.

contents str: The Base64 encoding of the file contents.
file_name str: The name of the configuration file.
type str: The type of configuration file.

contents String: The Base64 encoding of the file contents.
fileName String: The name of the configuration file.
type String: The type of configuration file.

StaticSiteLinkedBackendResponse

CreatedOn string: The date and time on which the backend was linked to the static site.
ProvisioningState string: The provisioning state of the linking process.
BackendResourceId string: The resource id of the backend linked to the static site
Region string: The region of the backend linked to the static site

CreatedOn string: The date and time on which the backend was linked to the static site.
ProvisioningState string: The provisioning state of the linking process.
BackendResourceId string: The resource id of the backend linked to the static site
Region string: The region of the backend linked to the static site

createdOn String: The date and time on which the backend was linked to the static site.
provisioningState String: The provisioning state of the linking process.
backendResourceId String: The resource id of the backend linked to the static site
region String: The region of the backend linked to the static site

createdOn string: The date and time on which the backend was linked to the static site.
provisioningState string: The provisioning state of the linking process.
backendResourceId string: The resource id of the backend linked to the static site
region string: The region of the backend linked to the static site

created_on str: The date and time on which the backend was linked to the static site.
provisioning_state str: The provisioning state of the linking process.
backend_resource_id str: The resource id of the backend linked to the static site
region str: The region of the backend linked to the static site

createdOn String: The date and time on which the backend was linked to the static site.
provisioningState String: The provisioning state of the linking process.
backendResourceId String: The resource id of the backend linked to the static site
region String: The region of the backend linked to the static site

StaticSiteTemplateOptionsResponse

Description string: Description of the newly generated repository.
IsPrivate bool: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
Owner string: Owner of the newly generated repository.
RepositoryName string: Name of the newly generated repository.
TemplateRepositoryUrl string: URL of the template repository. The newly generated repository will be based on this one.

Description string: Description of the newly generated repository.
IsPrivate bool: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
Owner string: Owner of the newly generated repository.
RepositoryName string: Name of the newly generated repository.
TemplateRepositoryUrl string: URL of the template repository. The newly generated repository will be based on this one.

description String: Description of the newly generated repository.
isPrivate Boolean: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
owner String: Owner of the newly generated repository.
repositoryName String: Name of the newly generated repository.
templateRepositoryUrl String: URL of the template repository. The newly generated repository will be based on this one.

description string: Description of the newly generated repository.
isPrivate boolean: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
owner string: Owner of the newly generated repository.
repositoryName string: Name of the newly generated repository.
templateRepositoryUrl string: URL of the template repository. The newly generated repository will be based on this one.

description str: Description of the newly generated repository.
is_private bool: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
owner str: Owner of the newly generated repository.
repository_name str: Name of the newly generated repository.
template_repository_url str: URL of the template repository. The newly generated repository will be based on this one.

description String: Description of the newly generated repository.
isPrivate Boolean: Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
owner String: Owner of the newly generated repository.
repositoryName String: Name of the newly generated repository.
templateRepositoryUrl String: URL of the template repository. The newly generated repository will be based on this one.

StaticSiteUserProvidedFunctionAppResponse

CreatedOn string: The date and time on which the function app was registered with the static site.
Id string: Resource Id.
Name string: Resource Name.
Type string: Resource type.
FunctionAppRegion string: The region of the function app registered with the static site
FunctionAppResourceId string: The resource id of the function app registered with the static site
Kind string: Kind of resource.

CreatedOn string: The date and time on which the function app was registered with the static site.
Id string: Resource Id.
Name string: Resource Name.
Type string: Resource type.
FunctionAppRegion string: The region of the function app registered with the static site
FunctionAppResourceId string: The resource id of the function app registered with the static site
Kind string: Kind of resource.

createdOn String: The date and time on which the function app was registered with the static site.
id String: Resource Id.
name String: Resource Name.
type String: Resource type.
functionAppRegion String: The region of the function app registered with the static site
functionAppResourceId String: The resource id of the function app registered with the static site
kind String: Kind of resource.

createdOn string: The date and time on which the function app was registered with the static site.
id string: Resource Id.
name string: Resource Name.
type string: Resource type.
functionAppRegion string: The region of the function app registered with the static site
functionAppResourceId string: The resource id of the function app registered with the static site
kind string: Kind of resource.

created_on str: The date and time on which the function app was registered with the static site.
id str: Resource Id.
name str: Resource Name.
type str: Resource type.
function_app_region str: The region of the function app registered with the static site
function_app_resource_id str: The resource id of the function app registered with the static site
kind str: Kind of resource.

createdOn String: The date and time on which the function app was registered with the static site.
id String: Resource Id.
name String: Resource Name.
type String: Resource type.
functionAppRegion String: The region of the function app registered with the static site
functionAppResourceId String: The resource id of the function app registered with the static site
kind String: Kind of resource.

UserAssignedIdentityResponse

ClientId string: Client Id of user assigned identity
PrincipalId string: Principal Id of user assigned identity

ClientId string: Client Id of user assigned identity
PrincipalId string: Principal Id of user assigned identity

clientId String: Client Id of user assigned identity
principalId String: Principal Id of user assigned identity

clientId string: Client Id of user assigned identity
principalId string: Principal Id of user assigned identity

client_id str: Client Id of user assigned identity
principal_id str: Principal Id of user assigned identity

clientId String: Client Id of user assigned identity
principalId String: Principal Id of user assigned identity

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.web.getStaticSite

On this page

On this page

Using getStaticSite

getStaticSite Result

Supporting Types

ArmIdWrapperResponse

ArmPlanResponse

CapabilityResponse

DatabaseConnectionOverviewResponse

ErrorEntityResponse

ManagedServiceIdentityResponse

PrivateLinkConnectionStateResponse

RemotePrivateEndpointConnectionResponse

ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse

SkuCapacityResponse

SkuDescriptionResponse

StaticSiteBuildPropertiesResponse

StaticSiteDatabaseConnectionConfigurationFileOverviewResponse

StaticSiteLinkedBackendResponse

StaticSiteTemplateOptionsResponse

StaticSiteUserProvidedFunctionAppResponse

UserAssignedIdentityResponse

Package Details

On this page

On this page