Microsoft.Web staticSites/basicAuth
Bicep resource definition
The staticSites/basicAuth resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Web/staticSites/basicAuth resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/staticSites/basicAuth@2024-04-01' = {
kind: 'string'
name: 'string'
properties: {
applicableEnvironmentsMode: 'string'
environments: [
'string'
]
password: 'string'
secretUrl: 'string'
}
}
Property values
Microsoft.Web/staticSites/basicAuth
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'default' (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: staticSites |
| properties | StaticSiteBasicAuthPropertiesARMResource resource specific properties | StaticSiteBasicAuthPropertiesARMResourceProperties |
StaticSiteBasicAuthPropertiesARMResourceProperties
| Name | Description | Value |
|---|---|---|
| applicableEnvironmentsMode | State indicating if basic auth is enabled and for what environments it is active. | string (required) |
| environments | The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. | string[] |
| password | The password for basic auth. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| secretUrl | Url to the secret in Key Vault. | string |
ARM template resource definition
The staticSites/basicAuth resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Web/staticSites/basicAuth resource, add the following JSON to your template.
{
"type": "Microsoft.Web/staticSites/basicAuth",
"apiVersion": "2024-04-01",
"name": "string",
"kind": "string",
"properties": {
"applicableEnvironmentsMode": "string",
"environments": [ "string" ],
"password": "string",
"secretUrl": "string"
}
}
Property values
Microsoft.Web/staticSites/basicAuth
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-04-01' |
| kind | Kind of resource. | string |
| name | The resource name | 'default' (required) |
| properties | StaticSiteBasicAuthPropertiesARMResource resource specific properties | StaticSiteBasicAuthPropertiesARMResourceProperties |
| type | The resource type | 'Microsoft.Web/staticSites/basicAuth' |
StaticSiteBasicAuthPropertiesARMResourceProperties
| Name | Description | Value |
|---|---|---|
| applicableEnvironmentsMode | State indicating if basic auth is enabled and for what environments it is active. | string (required) |
| environments | The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. | string[] |
| password | The password for basic auth. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| secretUrl | Url to the secret in Key Vault. | string |
Terraform (AzAPI provider) resource definition
The staticSites/basicAuth resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Web/staticSites/basicAuth resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/staticSites/basicAuth@2024-04-01"
name = "string"
kind = "string"
body = jsonencode({
properties = {
applicableEnvironmentsMode = "string"
environments = [
"string"
]
password = "string"
secretUrl = "string"
}
})
}
Property values
Microsoft.Web/staticSites/basicAuth
| Name | Description | Value |
|---|---|---|
| kind | Kind of resource. | string |
| name | The resource name | 'default' (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: staticSites |
| properties | StaticSiteBasicAuthPropertiesARMResource resource specific properties | StaticSiteBasicAuthPropertiesARMResourceProperties |
| type | The resource type | "Microsoft.Web/staticSites/basicAuth@2024-04-01" |
StaticSiteBasicAuthPropertiesARMResourceProperties
| Name | Description | Value |
|---|---|---|
| applicableEnvironmentsMode | State indicating if basic auth is enabled and for what environments it is active. | string (required) |
| environments | The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. | string[] |
| password | The password for basic auth. | string Constraints: Sensitive value. Pass in as a secure parameter. |
| secretUrl | Url to the secret in Key Vault. | string |