{ "azurerm_api_management": { "full_properties": { "location": { "description": "The Azure location where the API Management Service exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the API Management Service. Changing this forces a new resource to be created.", "required": true }, "publisher_email": { "description": "The email of publisher/company.", "required": true }, "publisher_name": { "description": "The name of publisher/company.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as documented below.", "required": true } }, "path": "/docs/providers/azurerm/r/api_management.html", "properties": [ "name", "location", "resource_group_name", "publisher_name", "publisher_email", "sku" ] }, "azurerm_app_service": { "full_properties": { "app_service_plan_id": { "description": "The ID of the App Service Plan within which to create this App Service. Changing this forces a new resource to be created.", "required": true }, "app_settings": { "description": "A key-value pair of App Settings.", "required": false }, "client_affinity_enabled": { "description": "Should the App Service send session affinity cookies, which route client requests in the same session to the same instance?", "required": false }, "connection_string": { "description": "An connection_string block as defined below.", "required": false }, "enabled": { "description": "Is the App Service Enabled? Changing this forces a new resource to be created.", "required": false }, "https_only": { "description": "Can the App Service only be accessed via HTTPS? Defaults to false.", "required": false }, "identity": { "description": "A Managed Service Identity block as defined below.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the App Service. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the App Service.", "required": true }, "site_config": { "description": "A site_config block as defined below.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/app_service.html", "properties": [ "name", "resource_group_name", "location", "app_service_plan_id", "app_settings", "connection_string", "client_affinity_enabled", "enabled", "https_only", "site_config", "tags", "identity" ] }, "azurerm_app_service_active_slot": { "full_properties": { "app_service_name": { "description": "The name of the App Service within which the Slot exists. Changing this forces a new resource to be created.", "required": true }, "app_service_slot_name": { "description": "The name of the App Service Slot which should be promoted to the Production Slot within the App Service.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the App Service exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/app_service_active_slot.html", "properties": [ "resource_group_name", "app_service_name", "app_service_slot_name" ] }, "azurerm_app_service_custom_hostname_binding": { "full_properties": { "hostname": { "description": "Specifies the Custom Hostname to use for the App Service, example www.example.com. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/app_service_custom_hostname_binding.html", "properties": [ "hostname" ] }, "azurerm_app_service_plan": { "full_properties": { "kind": { "description": "The kind of the App Service Plan to create. Possible values are Windows (also available as App), Linux and FunctionApp (for a Consumption Plan). Defaults to Windows. Changing this forces a new resource to be created.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the App Service Plan component. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the App Service Plan component.", "required": true } }, "path": "/docs/providers/azurerm/r/app_service_plan.html", "properties": [ "name", "resource_group_name", "location", "kind" ] }, "azurerm_app_service_slot": { "full_properties": { "app_service_name": { "description": "The name of the App Service within which to create the App Service Slot. Changing this forces a new resource to be created.", "required": true }, "app_service_plan_id": { "description": "The ID of the App Service Plan within which to create this App Service Slot. Changing this forces a new resource to be created.", "required": true }, "app_settings": { "description": "A key-value pair of App Settings.", "required": false }, "client_affinity_enabled": { "description": "Should the App Service Slot send session affinity cookies, which route client requests in the same session to the same instance?", "required": false }, "connection_string": { "description": "An connection_string block as defined below.", "required": false }, "enabled": { "description": "Is the App Service Slot Enabled?", "required": false }, "https_only": { "description": "Can the App Service Slot only be accessed via HTTPS? Defaults to false.", "required": false }, "identity": { "description": "A Managed Service Identity block as defined below.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the App Service Slot component. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the App Service Slot component.", "required": true }, "site_config": { "description": "A site_config object as defined below.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/app_service_slot.html", "properties": [ "name", "resource_group_name", "location", "app_service_plan_id", "app_service_name", "app_settings", "connection_string", "client_affinity_enabled", "enabled", "https_only", "site_config", "identity", "tags" ] }, "azurerm_application_gateway": { "full_properties": { "backend_address_pool": { "description": "One or more backend_address_pool blocks as defined below.", "required": true }, "backend_http_settings": { "description": "One or more backend_http_settings blocks as defined below.", "required": true }, "frontend_ip_configuration": { "description": "One or more frontend_ip_configuration blocks as defined below.", "required": true }, "frontend_port": { "description": "One or more frontend_port blocks as defined below.", "required": true }, "gateway_ip_configuration": { "description": "One or more gateway_ip_configuration blocks as defined below.", "required": true }, "http_listener": { "description": "One or more http_listener blocks as defined below.", "required": true }, "location": { "description": "The Azure region where the Application Gateway should exist. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the Application Gateway. Changing this forces a new resource to be created.", "required": true }, "request_routing_rule": { "description": "One or more request_routing_rule blocks as defined below.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to the Application Gateway should exist. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as defined below.", "required": true } }, "path": "/docs/providers/azurerm/r/application_gateway.html", "properties": [ "name", "resource_group_name", "location", "backend_address_pool", "backend_http_settings", "frontend_ip_configuration", "frontend_port", "gateway_ip_configuration", "http_listener", "request_routing_rule", "sku" ] }, "azurerm_application_insights": { "full_properties": { "application_type": { "description": "Specifies the type of Application Insights to create. Valid values are Java, iOS, MobileCenter, Other, Phone, Store and Web.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Application Insights component. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/application_insights.html", "properties": [ "name", "resource_group_name", "location", "application_type", "tags" ] }, "azurerm_application_security_group": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Application Security Group. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Application Security Group.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/application_security_group.html", "properties": [ "name", "resource_group_name", "location", "tags" ] }, "azurerm_automation_account": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Automation Account. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Automation Account is created. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as defined below.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/automation_account.html", "properties": [ "name", "resource_group_name", "location", "sku", "tags" ] }, "azurerm_automation_credential": { "full_properties": { "account_name": { "description": "The name of the automation account in which the Credential is created. Changing this forces a new resource to be created.", "required": true }, "description": { "description": "The description associated with this Automation Credential.", "required": false }, "name": { "description": "Specifies the name of the Credential. Changing this forces a new resource to be created.", "required": true }, "password": { "description": "The password associated with this Automation Credential.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Credential is created. Changing this forces a new resource to be created.", "required": true }, "username": { "description": "The username associated with this Automation Credential.", "required": true } }, "path": "/docs/providers/azurerm/r/automation_credential.html", "properties": [ "name", "resource_group_name", "account_name", "username", "password", "description" ] }, "azurerm_automation_dsc_configuration": { "full_properties": { "automation_account_name": { "description": "The name of the automation account in which the DSC Configuration is created. Changing this forces a new resource to be created.", "required": true }, "content_embedded": { "description": "The PowerShell DSC Configuration script.", "required": true }, "description": { "description": "Description to go with DSC Configuration.", "required": false }, "location": { "description": "Must be the same location as the Automation Account.", "required": true }, "log_verbose": { "description": "Verbose log option.", "required": false }, "name": { "description": "Specifies the name of the DSC Configuration. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the DSC Configuration is created. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/automation_dsc_configuration.html", "properties": [ "name", "resource_group_name", "automation_account_name", "content_embedded", "location", "log_verbose", "description" ] }, "azurerm_automation_dsc_nodeconfiguration": { "full_properties": { "automation_account_name": { "description": "The name of the automation account in which the DSC Node Configuration is created. Changing this forces a new resource to be created.", "required": true }, "content_embedded": { "description": "The PowerShell DSC Node Configuration (mof content).", "required": true }, "name": { "description": "Specifies the name of the DSC Node Configuration. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the DSC Node Configuration is created. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/automation_dsc_nodeconfiguration.html", "properties": [ "name", "resource_group_name", "automation_account_name", "content_embedded" ] }, "azurerm_automation_module": { "full_properties": { "automation_account_name": { "description": "The name of the automation account in which the Module is created. Changing this forces a new resource to be created.", "required": true }, "module_link": { "description": "The published Module link.", "required": true }, "name": { "description": "Specifies the name of the Module. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Module is created. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/automation_module.html", "properties": [ "name", "resource_group_name", "automation_account_name", "module_link" ] }, "azurerm_automation_runbook": { "full_properties": { "account_name": { "description": "The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.", "required": true }, "content": { "description": "The desired content of the runbook.", "required": false }, "description": { "description": "A description for this credential.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "log_progress": { "description": "Progress log option.", "required": true }, "log_verbose": { "description": "Verbose log option.", "required": true }, "name": { "description": "Specifies the name of the Runbook. Changing this forces a new resource to be created.", "required": true }, "publish_content_link": { "description": "The published runbook content link.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.", "required": true }, "runbook_type": { "description": "The type of the runbook - can be either Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShellWorkflow, PowerShell or Script.", "required": true } }, "path": "/docs/providers/azurerm/r/automation_runbook.html", "properties": [ "name", "resource_group_name", "location", "account_name", "runbook_type", "log_progress", "log_verbose", "publish_content_link", "description", "content" ] }, "azurerm_automation_schedule": { "full_properties": { "automation_account_name": { "description": "The name of the automation account in which the Schedule is created. Changing this forces a new resource to be created.", "required": true }, "description": { "description": "A description for this Schedule.", "required": false }, "expiry_time": { "description": "The end time of the schedule.", "required": false }, "frequency": { "description": "The frequency of the schedule. - can be either OneTime, Day, Hour, Week, or Month.", "required": true }, "interval": { "description": "The number of frequencys between runs. Only valid when frequency is Day, Hour, Week, or Month and defaults to 1.", "required": false }, "month_days": { "description": "List of days of the month that the job should execute on. Must be between 1 and 31. -1 for last day of the month. Only valid when frequency is Month.", "required": false }, "monthly_occurrence": { "description": "List of occurrences of days within a month. Only valid when frequency is Month. The monthly_occurrence block supports fields documented below.", "required": false }, "name": { "description": "Specifies the name of the Schedule. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Schedule is created. Changing this forces a new resource to be created.", "required": true }, "start_time": { "description": "Start time of the schedule. Must be at least five minutes in the future. Defaults to seven minutes in the future from the time the resource is created.", "required": false }, "timezone": { "description": "The timezone of the start time. Defaults to UTC. For possible values see: https://msdn.microsoft.com/en-us/library/ms912391(v=winembedded.11).aspx", "required": false }, "week_days": { "description": "List of days of the week that the job should execute on. Only valid when frequency is Week.", "required": false } }, "path": "/docs/providers/azurerm/r/automation_schedule.html", "properties": [ "name", "resource_group_name", "automation_account_name", "frequency", "description", "interval", "start_time", "expiry_time", "timezone", "week_days", "month_days", "monthly_occurrence" ] }, "azurerm_autoscale_setting": { "full_properties": { "enabled": { "description": "Specifies whether automatic scaling is enabled for the target resource. Defaults to true.", "required": false }, "location": { "description": "Specifies the supported Azure location where the AutoScale Setting should exist. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the AutoScale Setting. Changing this forces a new resource to be created.", "required": true }, "notification": { "description": "Specifies a notification block as defined below.", "required": false }, "profile": { "description": "Specifies one or more (up to 20) profile blocks as defined below.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in the AutoScale Setting should be created. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "target_resource_id": { "description": "Specifies the resource ID of the resource that the autoscale setting should be added to.", "required": true } }, "path": "/docs/providers/azurerm/r/autoscale_setting.html", "properties": [ "name", "resource_group_name", "location", "profile", "target_resource_id", "enabled", "notification", "tags" ] }, "azurerm_availability_set": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the availability set. Changing this forces a new resource to be created.", "required": true }, "platform_update_domain_count": { "description": "Specifies the number of update domains that are used. Defaults to 5.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the availability set. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/availability_set.html", "properties": [ "name", "resource_group_name", "location", "platform_update_domain_count" ] }, "azurerm_azuread_application": { "full_properties": { "available_to_other_tenants": { "description": "Is this Azure AD Application available to other tenants? Defaults to false.", "required": false }, "homepage": { "description": "The URL to the application's home page. If no homepage is specified this defaults to https://{name}.", "required": false }, "identifier_uris": { "description": "A list of user-defined URI(s) that uniquely identify a Web application within it's Azure AD tenant, or within a verified custom domain if the application is multi-tenant.", "required": false }, "name": { "description": "The display name for the application.", "required": true }, "oauth2_allow_implicit_flow": { "description": "Does this Azure AD Application allow OAuth2.0 implicit flow tokens? Defaults to false.", "required": false }, "reply_urls": { "description": "A list of URLs that user tokens are sent to for sign in, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to.", "required": false } }, "path": "/docs/providers/azurerm/r/azuread_application.html", "properties": [ "name", "homepage", "identifier_uris", "reply_urls", "available_to_other_tenants", "oauth2_allow_implicit_flow" ] }, "azurerm_azuread_service_principal": { "full_properties": { "application_id": { "description": "The ID of the Azure AD Application for which to create a Service Principal.", "required": true } }, "path": "/docs/providers/azurerm/r/azuread_service_principal.html", "properties": [ "application_id" ] }, "azurerm_azuread_service_principal_password": { "full_properties": { "end_date": { "description": "The End Date which the Password is valid until, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). Changing this field forces a new resource to be created.", "required": true }, "key_id": { "description": "A GUID used to uniquely identify this Key. If not specified a GUID will be created. Changing this field forces a new resource to be created.", "required": false }, "service_principal_id": { "description": "The ID of the Service Principal for which this password should be created. Changing this field forces a new resource to be created.", "required": true }, "start_date": { "description": "The Start Date which the Password is valid from, formatted as a RFC3339 date string (e.g. 2018-01-01T01:02:03Z). If this isn't specified, the current date is used. Changing this field forces a new resource to be created.", "required": false }, "value": { "description": "The Password for this Service Principal.", "required": true } }, "path": "/docs/providers/azurerm/r/azuread_service_principal_password.html", "properties": [ "service_principal_id", "value", "end_date", "key_id", "start_date" ] }, "azurerm_cdn_endpoint": { "full_properties": { "content_types_to_compress": { "description": "An array of strings that indicates a content types on which compression will be applied. The value for the elements should be MIME types.", "required": false }, "geo_filter": { "description": "A set of Geo Filters for this CDN Endpoint. Each geo_filter block supports fields documented below.", "required": false }, "is_compression_enabled": { "description": "Indicates whether compression is to be enabled. Defaults to false.", "required": false }, "is_http_allowed": { "description": "Defaults to true.", "required": false }, "is_https_allowed": { "description": "Defaults to true.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the CDN Endpoint. Changing this forces a new resource to be created.", "required": true }, "optimization_type": { "description": "What types of optimization should this CDN Endpoint optimize for? Possible values include DynamicSiteAcceleration, GeneralMediaStreaming, GeneralWebDelivery, LargeFileDownload and VideoOnDemandMediaStreaming.", "required": false }, "origin": { "description": "The set of origins of the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options. Each origin block supports fields documented below.", "required": false }, "origin_host_header": { "description": "The host header CDN provider will send along with content requests to origins. Defaults to the host name of the origin.", "required": false }, "origin_path": { "description": "The path used at for origin requests.", "required": false }, "probe_path": { "description": "the path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin_path.", "required": false }, "profile_name": { "description": "The CDN Profile to which to attach the CDN Endpoint.", "required": true }, "querystring_caching_behaviour": { "description": "Sets query string caching behavior. Allowed values are IgnoreQueryString, BypassCaching and UseQueryString. Defaults to IgnoreQueryString.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the CDN Endpoint.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/cdn_endpoint.html", "properties": [ "name", "resource_group_name", "profile_name", "location", "is_http_allowed", "is_https_allowed", "content_types_to_compress", "geo_filter", "is_compression_enabled", "querystring_caching_behaviour", "optimization_type", "origin", "origin_host_header", "origin_path", "probe_path", "tags" ] }, "azurerm_cdn_profile": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the CDN Profile. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "sku": { "description": "The pricing related information of current CDN profile. Accepted values are Standard_Akamai, Standard_ChinaCdn, Standard_Microsoft, Standard_Verizon or Premium_Verizon.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/cdn_profile.html", "properties": [ "name", "resource_group_name", "location", "sku", "tags" ] }, "azurerm_cognitive_account": { "full_properties": { "kind": { "description": "Specifies the type of Cognitive Service Account that should be created. Possible values are Academic, Bing.Autosuggest, Bing.Autosuggest.v7, Bing.CustomSearch, Bing.Search, Bing.Search.v7, Bing.Speech, Bing.SpellCheck, Bing.SpellCheck.v7, ComputerVision, ContentModerator, CustomSpeech, Emotion, Face, LUIS, Recommendations, SpeakerRecognition, Speech, SpeechTranslation, TextAnalytics, TextTranslation and WebLM. Changing this forces a new resource to be created.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Cognitive Service Account. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Cognitive Service Account is created. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as defined below.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/cognitive_account.html", "properties": [ "name", "resource_group_name", "location", "kind", "sku", "tags" ] }, "azurerm_container_group": { "full_properties": { "container": { "description": "The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.", "required": true }, "dns_name_label": { "description": "The DNS label/name for the container groups IP.", "required": false }, "image_registry_credential": { "description": "Set image registry credentials for the group as documented in the image_registry_credential block below", "required": false }, "ip_address_type": { "description": "Specifies the ip address type of the container. Public is the only acceptable value at this time. Changing this forces a new resource to be created.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Container Group. Changing this forces a new resource to be created.", "required": true }, "os_type": { "description": "The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.", "required": true }, "restart_policy": { "description": "Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always.", "required": false } }, "path": "/docs/providers/azurerm/r/container_group.html", "properties": [ "name", "resource_group_name", "location", "ip_address_type", "dns_name_label", "os_type", "restart_policy", "image_registry_credential", "container" ] }, "azurerm_container_registry": { "full_properties": { "admin_enabled": { "description": "Specifies whether the admin user is enabled. Defaults to false.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Container Registry. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Container Registry. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "The SKU name of the the container registry. Possible values are Classic (which was previously Basic), Basic, Standard and Premium.", "required": false }, "storage_account_id": { "description": "The ID of a Storage Account which must be located in the same Azure Region as the Container Registry.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/container_registry.html", "properties": [ "name", "resource_group_name", "location", "admin_enabled", "storage_account_id", "sku", "tags" ] }, "azurerm_container_service": { "full_properties": { "agent_pool_profile": { "description": "One or more Agent Pool Profile's block as documented below.", "required": true }, "diagnostics_profile": { "description": "A VM Diagnostics Profile block as documented below.", "required": true }, "linux_profile": { "description": "A Linux Profile block as documented below.", "required": true }, "location": { "description": "The location where the Container Service instance should be created. Changing this forces a new resource to be created.", "required": true }, "master_profile": { "description": "A Master Profile block as documented below.", "required": true }, "name": { "description": "The name of the Container Service instance to create. Changing this forces a new resource to be created.", "required": true }, "orchestration_platform": { "description": "Specifies the Container Orchestration Platform to use. Currently can be either DCOS, Kubernetes or Swarm. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "service_principal": { "description": "A Service Principal block as documented below.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/container_service.html", "properties": [ "name", "location", "resource_group_name", "orchestration_platform", "master_profile", "linux_profile", "agent_pool_profile", "service_principal", "diagnostics_profile", "tags" ] }, "azurerm_cosmosdb_account": { "full_properties": { "capabilities": { "description": "Enable capabilities for this Cosmos DB account. Possible values are EnableTable and EnableGremlin.", "required": false }, "consistency_policy": { "description": "Specifies a consistency_policy resource, used to define the consistency policy for this CosmosDB account.", "required": true }, "enable_automatic_failover": { "description": "Enable automatic fail over for this Cosmos DB account.", "required": false }, "enable_multiple_write_locations": { "description": "Enable multi-master support for this Cosmos DB account.", "required": false }, "geo_location": { "description": "Specifies a geo_location resource, used to define where data should be replicated with the failover_priority 0 specifying the primary location.", "required": true }, "ip_range_filter": { "description": "CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IP's for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces.", "required": false }, "is_virtual_network_filter_enabled": { "description": "Enables virtual network filtering for this Cosmos DB account.", "required": false }, "kind": { "description": "Specifies the Kind of CosmosDB to create - possible values are GlobalDocumentDB and MongoDB. Defaults to GlobalDocumentDB. Changing this forces a new resource to be created.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.", "required": true }, "offer_type": { "description": "Specifies the Offer Type to use for this CosmosDB Account - currently this can only be set to Standard.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the CosmosDB Account is created. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "virtual_network_rule": { "description": "Specifies a virtual_network_rules resource, used to define which subnets are allowed to access this CosmosDB account.", "required": false } }, "path": "/docs/providers/azurerm/r/cosmosdb_account.html", "properties": [ "name", "resource_group_name", "location", "tags", "offer_type", "kind", "consistency_policy", "geo_location", "ip_range_filter", "enable_automatic_failover", "capabilities", "is_virtual_network_filter_enabled", "virtual_network_rule", "enable_multiple_write_locations" ] }, "azurerm_data_lake_analytics_account": { "full_properties": { "default_store_account_name": { "description": "Specifies the data lake store to use by default. Changing this forces a new resource to be created.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Data Lake Analytics Account. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Data Lake Analytics Account.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "tier": { "description": "The monthly commitment tier for Data Lake Analytics Account. Accepted values are Consumption, Commitment_100000AUHours, Commitment_10000AUHours, Commitment_1000AUHours, Commitment_100AUHours, Commitment_500000AUHours, Commitment_50000AUHours, Commitment_5000AUHours, or Commitment_500AUHours.", "required": false } }, "path": "/docs/providers/azurerm/r/data_lake_analytics_account.html", "properties": [ "name", "resource_group_name", "location", "default_store_account_name", "tier", "tags" ] }, "azurerm_data_lake_analytics_firewall_rule": { "full_properties": { "account_name": { "description": "Specifies the name of the Data Lake Analytics for which the Firewall Rule should take effect.", "required": true }, "end_ip_address": { "description": "The End IP Address for the firewall rule.", "required": true }, "name": { "description": "Specifies the name of the Data Lake Analytics. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Data Lake Analytics.", "required": true }, "start_ip_address": { "description": "The Start IP address for the firewall rule.", "required": true } }, "path": "/docs/providers/azurerm/r/data_lake_analytics_firewall_rule.html", "properties": [ "name", "resource_group_name", "account_name", "start_ip_address", "end_ip_address" ] }, "azurerm_data_lake_store": { "full_properties": { "encryption_state": { "description": "Is Encryption enabled on this Data Lake Store Account? Possible values are Enabled or Disabled. Defaults to Enabled.", "required": false }, "encryption_type": { "description": "The Encryption Type used for this Data Lake Store Account. Currently can be set to SystemManaged when encryption_state is Enabled - and must be a blank string when it's Disabled.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Data Lake Store.", "required": true }, "tier": { "description": "The monthly commitment tier for Data Lake Store. Accepted values are Consumption, Commitment_1TB, Commitment_10TB, Commitment_100TB, Commitment_500TB, Commitment_1PB or Commitment_5PB.", "required": false } }, "path": "/docs/providers/azurerm/r/data_lake_store.html", "properties": [ "name", "resource_group_name", "location", "tier", "encryption_state", "encryption_type" ] }, "azurerm_data_lake_store_firewall_rule": { "full_properties": { "account_name": { "description": "Specifies the name of the Data Lake Store for which the Firewall Rule should take effect.", "required": true }, "end_ip_address": { "description": "The End IP Address for the firewall rule.", "required": true }, "name": { "description": "Specifies the name of the Data Lake Store. Changing this forces a new resource to be created. Has to be between 3 to 24 characters.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Data Lake Store.", "required": true }, "start_ip_address": { "description": "The Start IP address for the firewall rule.", "required": true } }, "path": "/docs/providers/azurerm/r/data_lake_store_firewall_rule.html", "properties": [ "name", "resource_group_name", "account_name", "start_ip_address", "end_ip_address" ] }, "azurerm_databricks_workspace": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource has to be created. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Databricks Workspace resource. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in which the Databricks Workspace should exist. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "The sku to use for the Databricks Workspace. Possible values are Standard or Premium. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/databricks_workspace.html", "properties": [ "name", "resource_group_name", "location", "sku", "tags" ] }, "azurerm_dev_test_lab": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the Dev Test Lab should exist. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Dev Test Lab. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group under which the Dev Test Lab resource has to be created. Changing this forces a new resource to be created.", "required": true }, "storage_type": { "description": "The type of storage used by the Dev Test Lab. Possible values are Standard and Premium. Defaults to Premium. Changing this forces a new resource to be created.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/dev_test_lab.html", "properties": [ "name", "resource_group_name", "location", "storage_type", "tags" ] }, "azurerm_dev_test_linux_virtual_machine": { "full_properties": { "name": { "description": "Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dev_test_linux_virtual_machine.html", "properties": [ "name" ] }, "azurerm_dev_test_policy": { "full_properties": { "description": { "description": "A description for the Policy.", "required": false }, "evaluator_type": { "description": "The Evaluation Type used for this Policy. Possible values include: 'AllowedValuesPolicy', 'MaxValuePolicy'. Changing this forces a new resource to be created.", "required": true }, "fact_data": { "description": "The Fact Data for this Policy.", "required": false }, "lab_name": { "description": "Specifies the name of the Dev Test Lab in which the Policy should be created. Changing this forces a new resource to be created.", "required": true }, "location": { "description": "Specifies the supported Azure location where the Dev Test Lab exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Dev Test Policy. Possible values are GalleryImage, LabPremiumVmCount, LabTargetCost, LabVmCount, LabVmSize, UserOwnedLabPremiumVmCount, UserOwnedLabVmCount and UserOwnedLabVmCountInSubnet. Changing this forces a new resource to be created.", "required": true }, "policy_set_name": { "description": "Specifies the name of the Policy Set within the Dev Test Lab where this policy should be created. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "threshold": { "description": "The Threshold for this Policy.", "required": true } }, "path": "/docs/providers/azurerm/r/dev_test_policy.html", "properties": [ "name", "policy_set_name", "lab_name", "resource_group_name", "location", "description", "evaluator_type", "threshold", "fact_data", "tags" ] }, "azurerm_dev_test_virtual_network": { "full_properties": { "description": { "description": "A description for the Virtual Network.", "required": false }, "lab_name": { "description": "Specifies the name of the Dev Test Lab in which the Virtual Network should be created. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Dev Test Virtual Network. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Dev Test Lab resource exists. Changing this forces a new resource to be created.", "required": true }, "subnet": { "description": "A subnet block as defined below.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/dev_test_virtual_network.html", "properties": [ "name", "lab_name", "resource_group_name", "description", "subnet", "tags" ] }, "azurerm_dev_test_windows_virtual_machine": { "full_properties": { "name": { "description": "Specifies the name of the Dev Test Machine. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dev_test_windows_virtual_machine.html", "properties": [ "name" ] }, "azurerm_devspace_controller": { "full_properties": { "host_suffix": { "description": "The host suffix for the DevSpace Controller. Changing this forces a new resource to be created.", "required": true }, "location": { "description": "Specifies the supported location where the DevSpace Controller should exist. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the DevSpace Controller. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group under which the DevSpace Controller resource has to be created. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as documented below. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "target_container_host_credentials_base64": { "description": "Base64 encoding of kube_config_raw of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.", "required": true }, "target_container_host_resource_id": { "description": "The resource id of Azure Kubernetes Service cluster. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/devspace_controller.html", "properties": [ "name", "resource_group_name", "location", "sku", "host_suffix", "target_container_host_resource_id", "target_container_host_credentials_base64", "tags" ] }, "azurerm_dns_a_record": { "full_properties": { "TTL": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "name": { "description": "The name of the DNS A Record.", "required": true }, "records": { "description": "List of IPv4 Addresses.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_a_record.html", "properties": [ "name", "resource_group_name", "zone_name", "TTL", "records", "tags" ] }, "azurerm_dns_aaaa_record": { "full_properties": { "TTL": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "name": { "description": "The name of the DNS AAAA Record.", "required": true }, "records": { "description": "List of IPv6 Addresses.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_aaaa_record.html", "properties": [ "name", "resource_group_name", "zone_name", "TTL", "records", "tags" ] }, "azurerm_dns_caa_record": { "full_properties": { "name": { "description": "The name of the DNS CAA Record.", "required": true }, "record": { "description": "A list of values that make up the CAA record. Each record block supports fields documented below.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "ttl": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_caa_record.html", "properties": [ "name", "resource_group_name", "zone_name", "ttl", "record", "tags" ] }, "azurerm_dns_cname_record": { "full_properties": { "TTL": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "name": { "description": "The name of the DNS CNAME Record.", "required": true }, "record": { "description": "The target of the CNAME.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_cname_record.html", "properties": [ "name", "resource_group_name", "zone_name", "TTL", "record", "tags" ] }, "azurerm_dns_mx_record": { "full_properties": { "name": { "description": "The name of the DNS MX Record.", "required": true }, "record": { "description": "A list of values that make up the MX record. Each record block supports fields documented below.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "ttl": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_mx_record.html", "properties": [ "name", "resource_group_name", "zone_name", "ttl", "record", "tags" ] }, "azurerm_dns_ns_record": { "full_properties": { "name": { "description": "The name of the DNS NS Record.", "required": true }, "record": { "description": "A list of values that make up the NS record. Each record block supports fields documented below. This field has been deprecated and will be removed in a future release.", "required": false }, "records": { "description": "A list of values that make up the NS record. WARNING: Either records or record is required.", "required": false }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "ttl": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_ns_record.html", "properties": [ "name", "resource_group_name", "zone_name", "ttl", "records", "record", "tags" ] }, "azurerm_dns_ptr_record": { "full_properties": { "name": { "description": "The name of the DNS PTR Record.", "required": true }, "records": { "description": "List of Fully Qualified Domain Names.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "ttl": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_ptr_record.html", "properties": [ "name", "resource_group_name", "zone_name", "ttl", "records", "tags" ] }, "azurerm_dns_srv_record": { "full_properties": { "name": { "description": "The name of the DNS SRV Record.", "required": true }, "record": { "description": "A list of values that make up the SRV record. Each record block supports fields documented below.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "ttl": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_srv_record.html", "properties": [ "name", "resource_group_name", "zone_name", "ttl", "record", "tags" ] }, "azurerm_dns_txt_record": { "full_properties": { "name": { "description": "The name of the DNS TXT Record.", "required": true }, "record": { "description": "A list of values that make up the txt record. Each record block supports fields documented below.", "required": true }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "ttl": { "description": "The Time To Live (TTL) of the DNS record in seconds.", "required": true }, "zone_name": { "description": "Specifies the DNS Zone where the resource exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/dns_txt_record.html", "properties": [ "name", "resource_group_name", "zone_name", "ttl", "record", "tags" ] }, "azurerm_dns_zone": { "full_properties": { "name": { "description": "The name of the DNS Zone. Must be a valid domain name.", "required": true }, "registration_virtual_network_ids": { "description": "A list of Virtual Network ID's that register hostnames in this DNS zone. This field can only be set when zone_type is set to Private.", "required": false }, "resolution_virtual_network_ids": { "description": "A list of Virtual Network ID's that resolve records in this DNS zone. This field can only be set when zone_type is set to Private.", "required": false }, "resource_group_name": { "description": "Specifies the resource group where the resource exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "zone_type": { "description": "Specifies the type of this DNS zone. Possible values are Public or Private (Defaults to Public).", "required": true } }, "path": "/docs/providers/azurerm/r/dns_zone.html", "properties": [ "name", "resource_group_name", "zone_type", "registration_virtual_network_ids", "resolution_virtual_network_ids", "tags" ] }, "azurerm_eventgrid_topic": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the EventGrid Topic resource. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the EventGrid Topic exists. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/eventgrid_topic.html", "properties": [ "name", "resource_group_name", "location", "tags" ] }, "azurerm_eventhub": { "full_properties": { "capture_description": { "description": "A capture_description block as defined below.", "required": false }, "message_retention": { "description": "Specifies the number of days to retain the events for this Event Hub. Needs to be between 1 and 7 days; or 1 day when using a Basic SKU for the parent EventHub Namespace.", "required": true }, "name": { "description": "Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "Specifies the name of the EventHub Namespace. Changing this forces a new resource to be created.", "required": true }, "partition_count": { "description": "Specifies the current number of shards on the Event Hub.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the EventHub's parent Namespace exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/eventhub.html", "properties": [ "name", "namespace_name", "resource_group_name", "partition_count", "message_retention", "capture_description" ] }, "azurerm_eventhub_authorization_rule": { "full_properties": { "eventhub_name": { "description": "Specifies the name of the EventHub. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the EventHub Authorization Rule resource. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the EventHub Namespace exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/eventhub_authorization_rule.html", "properties": [ "name", "namespace_name", "eventhub_name", "resource_group_name" ] }, "azurerm_eventhub_consumer_group": { "full_properties": { "eventhub_name": { "description": "Specifies the name of the EventHub. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the EventHub Consumer Group resource. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "Specifies the name of the grandparent EventHub Namespace. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the EventHub Consumer Group's grandparent Namespace exists. Changing this forces a new resource to be created.", "required": true }, "user_metadata": { "description": "Specifies the user metadata.", "required": false } }, "path": "/docs/providers/azurerm/r/eventhub_consumer_group.html", "properties": [ "name", "namespace_name", "eventhub_name", "resource_group_name", "user_metadata" ] }, "azurerm_eventhub_namespace": { "full_properties": { "auto_inflate_enabled": { "description": "Is Auto Inflate enabled for the EventHub Namespace?", "required": false }, "capacity": { "description": "Specifies the Capacity / Throughput Units for a Standard SKU namespace. Valid values range from 1 - 20.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "maximum_throughput_units": { "description": "Specifies the maximum number of throughput units when Auto Inflate is Enabled. Valid values range from 1 - 20.", "required": false }, "name": { "description": "Specifies the name of the EventHub Namespace resource. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the namespace. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "Defines which tier to use. Valid options are Basic and Standard.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/eventhub_namespace.html", "properties": [ "name", "resource_group_name", "location", "sku", "capacity", "auto_inflate_enabled", "maximum_throughput_units", "tags" ] }, "azurerm_express_route_circuit": { "full_properties": { "bandwidth_in_mbps": { "description": "The bandwidth in Mbps of the circuit being created.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the ExpressRoute circuit. Changing this forces a new resource to be created.", "required": true }, "peering_location": { "description": "The name of the peering location and not the Azure resource location.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the ExpressRoute circuit. Changing this forces a new resource to be created.", "required": true }, "service_provider_name": { "description": "The name of the ExpressRoute Service Provider.", "required": true } }, "path": "/docs/providers/azurerm/r/express_route_circuit.html", "properties": [ "name", "resource_group_name", "location", "service_provider_name", "peering_location", "bandwidth_in_mbps" ] }, "azurerm_express_route_circuit_authorization": { "full_properties": { "express_route_circuit_name": { "description": "The name of the Express Route Circuit in which to create the Authorization.", "required": true }, "name": { "description": "The name of the ExpressRoute circuit. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true } }, "path": "/docs/providers/azurerm/r/express_route_circuit_authorization.html", "properties": [ "name", "resource_group_name", "express_route_circuit_name" ] }, "azurerm_express_route_circuit_peering": { "full_properties": { "peering_type": { "description": "The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/express_route_circuit_peering.html", "properties": [ "peering_type" ] }, "azurerm_firewall": { "full_properties": { "ip_configuration": { "description": "A ip_configuration block as documented below.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Firewall. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the resource. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/firewall.html", "properties": [ "name", "resource_group_name", "location", "ip_configuration", "tags" ] }, "azurerm_firewall_network_rule_collection": { "full_properties": { "action": { "description": "Specifies the action the rule will apply to matching traffic. Possible values are Allow and Deny.", "required": true }, "azure_firewall_name": { "description": "Specifies the name of the Firewall in which to the Network Rule Collection should be created. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Network Rule Collection which must be unique within the Firewall. Changing this forces a new resource to be created.", "required": true }, "priority": { "description": "Specifies the priority of the rule collection. Possible values are between 100 - 65000.", "required": true }, "resource_group_name": { "description": "Specifies the name of the Resource Group in which the Firewall exists. Changing this forces a new resource to be created.", "required": true }, "rule": { "description": "One or more rule blocks as defined below.", "required": true } }, "path": "/docs/providers/azurerm/r/firewall_network_rule_collection.html", "properties": [ "name", "azure_firewall_name", "resource_group_name", "priority", "action", "rule" ] }, "azurerm_function_app": { "full_properties": { "app_service_plan_id": { "description": "The ID of the App Service Plan within which to create this Function App. Changing this forces a new resource to be created.", "required": true }, "app_settings": { "description": "A key-value pair of App Settings.", "required": false }, "client_affinity_enabled": { "description": "Should the Function App send session affinity cookies, which route client requests in the same session to the same instance?", "required": false }, "connection_string": { "description": "An connection_string block as defined below.", "required": false }, "enable_builtin_logging": { "description": "Should the built-in logging of this Function App be enabled? Defaults to true.", "required": false }, "enabled": { "description": "Is the Function App enabled?", "required": false }, "https_only": { "description": "Can the Function App only be accessed via HTTPS? Defaults to false.", "required": false }, "identity": { "description": "An identity block as defined below.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Function App. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Function App.", "required": true }, "site_config": { "description": "A site_config object as defined below.", "required": false }, "storage_connection_string": { "description": "The connection string of the backend storage account which will be used by this Function App (such as the dashboard, logs).", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "version": { "description": "The runtime version associated with the Function App. Defaults to ~1.", "required": false } }, "path": "/docs/providers/azurerm/r/function_app.html", "properties": [ "name", "resource_group_name", "location", "app_service_plan_id", "storage_connection_string", "app_settings", "enable_builtin_logging", "connection_string", "client_affinity_enabled", "enabled", "https_only", "version", "site_config", "identity", "tags" ] }, "azurerm_image": { "full_properties": { "data_disk": { "description": "One or more data_disk elements as defined below.", "required": false }, "location": { "description": "Specified the supported Azure location where the resource exists.", "required": true }, "name": { "description": "Specifies the name of the image. Changing this forces a", "required": true }, "os_disk": { "description": "One or more os_disk elements as defined below.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create", "required": true }, "source_virtual_machine_id": { "description": "The Virtual Machine ID from which to create the image.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/image.html", "properties": [ "name", "resource_group_name", "location", "source_virtual_machine_id", "os_disk", "data_disk", "tags" ] }, "azurerm_iothub": { "full_properties": { "endpoint": { "description": "An endpoint block as defined below.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource has to be createc. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the IotHub resource. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group under which the IotHub resource has to be created. Changing this forces a new resource to be created.", "required": true }, "route": { "description": "A route block as defined below.", "required": false }, "sku": { "description": "A sku block as defined below.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/iothub.html", "properties": [ "name", "resource_group_name", "location", "sku", "endpoint", "route", "tags" ] }, "azurerm_iothub_consumer_group": { "full_properties": { "eventhub_endpoint_name": { "description": "The name of the Event Hub-compatible endpoint in the IoT hub. Changing this forces a new resource to be created.", "required": true }, "iothub_name": { "description": "The name of the IoT Hub. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of this Consumer Group. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group that contains the IoT hub. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/iothub_consumer_group.html", "properties": [ "name", "iothub_name", "eventhub_endpoint_name", "resource_group_name" ] }, "azurerm_key_vault": { "full_properties": { "access_policy": { "description": "An access policy block as described below. A maximum of 16 may be declared.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Key Vault. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Key Vault. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "An SKU block as described below.", "required": true }, "tenant_id": { "description": "The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault.", "required": true } }, "path": "/docs/providers/azurerm/r/key_vault.html", "properties": [ "name", "location", "resource_group_name", "sku", "tenant_id", "access_policy" ] }, "azurerm_key_vault_access_policy": { "full_properties": { "application_id": { "description": "The object ID of an Application in Azure Active Directory.", "required": false }, "certificate_permissions": { "description": "List of certificate permissions, must be one or more from", "required": false }, "key_permissions": { "description": "List of key permissions, must be one or more from", "required": true }, "object_id": { "description": "The object ID of a user, service principal or security", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "secret_permissions": { "description": "List of secret permissions, must be one or more", "required": true }, "tenant_id": { "description": "The Azure Active Directory tenant ID that should be used", "required": true }, "vault_name": { "description": "Specifies the name of the Key Vault resource. Changing this", "required": true } }, "path": "/docs/providers/azurerm/r/key_vault_access_policy.html", "properties": [ "vault_name", "resource_group_name", "tenant_id", "object_id", "application_id", "certificate_permissions", "key_permissions", "secret_permissions" ] }, "azurerm_key_vault_certificate": { "full_properties": { "certificate": { "description": "A certificate block as defined below, used to Import an existing certificate.", "required": false }, "certificate_policy": { "description": "A certificate_policy block as defined below.", "required": true }, "name": { "description": "Specifies the name of the Key Vault Certificate. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "vault_uri": { "description": "Specifies the URI used to access the Key Vault instance, available on the azurerm_key_vault resource.", "required": true } }, "path": "/docs/providers/azurerm/r/key_vault_certificate.html", "properties": [ "name", "vault_uri", "certificate", "certificate_policy", "tags" ] }, "azurerm_key_vault_key": { "full_properties": { "key_opts": { "description": "A list of JSON web key operations. Possible values include: decrypt, encrypt, sign, unwrapKey, verify and wrapKey. Please note these values are case sensitive.", "required": true }, "key_size": { "description": "Specifies the Size of the Key to create in bytes. For example, 1024 or 2048. Changing this forces a new resource to be created.", "required": true }, "key_type": { "description": "Specifies the Key Type to use for this Key Vault Key. Possible values are EC (Elliptic Curve), Oct (Octet), RSA and RSA-HSM. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Key Vault Key. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "vault_uri": { "description": "Specifies the URI used to access the Key Vault instance, available on the azurerm_key_vault resource.", "required": true } }, "path": "/docs/providers/azurerm/r/key_vault_key.html", "properties": [ "name", "vault_uri", "key_type", "key_size", "key_opts", "tags" ] }, "azurerm_key_vault_secret": { "full_properties": { "content_type": { "description": "Specifies the content type for the Key Vault Secret.", "required": false }, "name": { "description": "Specifies the name of the Key Vault Secret. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "value": { "description": "Specifies the value of the Key Vault Secret.", "required": true }, "vault_uri": { "description": "Specifies the URI used to access the Key Vault instance, available on the azurerm_key_vault resource.", "required": true } }, "path": "/docs/providers/azurerm/r/key_vault_secret.html", "properties": [ "name", "value", "vault_uri", "content_type", "tags" ] }, "azurerm_kubernetes_cluster": { "full_properties": { "agent_pool_profile": { "description": "One or more agent_pool_profile blocks as documented below.", "required": true }, "dns_prefix": { "description": "DNS prefix specified when creating the managed cluster.", "required": true }, "location": { "description": "The location where the Managed Kubernetes Cluster should be created. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the Managed Kubernetes Cluster to create. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "Specifies the Resource Group where the Managed Kubernetes Cluster should exist. Changing this forces a new resource to be created.", "required": true }, "service_principal": { "description": "A service_principal block as documented below.", "required": true } }, "path": "/docs/providers/azurerm/r/kubernetes_cluster.html", "properties": [ "name", "location", "resource_group_name", "agent_pool_profile", "dns_prefix", "service_principal" ] }, "azurerm_lb": { "full_properties": { "frontend_ip_configuration": { "description": "A frontend ip configuration block as documented below.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists.", "required": true }, "name": { "description": "Specifies the name of the LoadBalancer.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the LoadBalancer.", "required": true }, "sku": { "description": "The SKU of the Azure Load Balancer. Accepted values are Basic and Standard. Defaults to Basic.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/loadbalancer.html", "properties": [ "name", "resource_group_name", "location", "frontend_ip_configuration", "sku", "tags" ] }, "azurerm_lb_backend_address_pool": { "full_properties": { "loadbalancer_id": { "description": "The ID of the Load Balancer in which to create the Backend Address Pool.", "required": true }, "name": { "description": "Specifies the name of the Backend Address Pool.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the resource.", "required": true } }, "path": "/docs/providers/azurerm/r/loadbalancer_backend_address_pool.html", "properties": [ "name", "resource_group_name", "loadbalancer_id" ] }, "azurerm_lb_nat_pool": { "full_properties": { "backend_port": { "description": "The port used for the internal endpoint. Possible values range between 1 and 65535, inclusive.", "required": true }, "frontend_ip_configuration_name": { "description": "The name of the frontend IP configuration exposing this rule.", "required": true }, "frontend_port_end": { "description": "The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.", "required": true }, "frontend_port_start": { "description": "The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with this Load Balancer. Possible values range between 1 and 65534, inclusive.", "required": true }, "loadbalancer_id": { "description": "The ID of the Load Balancer in which to create the NAT pool.", "required": true }, "name": { "description": "Specifies the name of the NAT pool.", "required": true }, "protocol": { "description": "The transport protocol for the external endpoint. Possible values are Udp or Tcp.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the resource.", "required": true } }, "path": "/docs/providers/azurerm/r/loadbalancer_nat_pool.html", "properties": [ "name", "resource_group_name", "loadbalancer_id", "frontend_ip_configuration_name", "protocol", "frontend_port_start", "frontend_port_end", "backend_port" ] }, "azurerm_lb_nat_rule": { "full_properties": { "backend_port": { "description": "The port used for internal connections on the endpoint. Possible values range between 1 and 65535, inclusive.", "required": true }, "enable_floating_ip": { "description": "Enables the Floating IP Capacity, required to configure a SQL AlwaysOn Availability Group.", "required": false }, "frontend_ip_configuration_name": { "description": "The name of the frontend IP configuration exposing this rule.", "required": true }, "frontend_port": { "description": "The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 1 and 65534, inclusive.", "required": true }, "loadbalancer_id": { "description": "The ID of the Load Balancer in which to create the NAT Rule.", "required": true }, "name": { "description": "Specifies the name of the NAT Rule.", "required": true }, "protocol": { "description": "The transport protocol for the external endpoint. Possible values are Udp, Tcp or All.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the resource.", "required": true } }, "path": "/docs/providers/azurerm/r/loadbalancer_nat_rule.html", "properties": [ "name", "resource_group_name", "loadbalancer_id", "frontend_ip_configuration_name", "protocol", "frontend_port", "backend_port", "enable_floating_ip" ] }, "azurerm_lb_probe": { "full_properties": { "interval_in_seconds": { "description": "The interval, in seconds between probes to the backend endpoint for health status. The default value is 15, the minimum value is 5.", "required": false }, "loadbalancer_id": { "description": "The ID of the LoadBalancer in which to create the NAT Rule.", "required": true }, "name": { "description": "Specifies the name of the Probe.", "required": true }, "number_of_probes": { "description": "The number of failed probe attempts after which the backend endpoint is removed from rotation. The default value is 2. NumberOfProbes multiplied by intervalInSeconds value must be greater or equal to 10.Endpoints are returned to rotation when at least one probe is successful.", "required": false }, "port": { "description": "Port on which the Probe queries the backend endpoint. Possible values range from 1 to 65535, inclusive.", "required": true }, "protocol": { "description": "Specifies the protocol of the end point. Possible values are Http, Https or Tcp. If Tcp is specified, a received ACK is required for the probe to be successful. If Http is specified, a 200 OK response from the specified URI is required for the probe to be successful.", "required": false }, "request_path": { "description": "The URI used for requesting health status from the backend endpoint. Required if protocol is set to Http. Otherwise, it is not allowed.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the resource.", "required": true } }, "path": "/docs/providers/azurerm/r/loadbalancer_probe.html", "properties": [ "name", "resource_group_name", "loadbalancer_id", "protocol", "port", "request_path", "interval_in_seconds", "number_of_probes" ] }, "azurerm_lb_rule": { "full_properties": { "backend_address_pool_id": { "description": "A reference to a Backend Address Pool over which this Load Balancing Rule operates.", "required": false }, "backend_port": { "description": "The port used for internal connections on the endpoint. Possible values range between 0 and 65535, inclusive.", "required": true }, "enable_floating_ip": { "description": "Floating IP is pertinent to failover scenarios: a \"floating” IP is reassigned to a secondary server in case the primary server fails. Floating IP is required for SQL AlwaysOn.", "required": false }, "frontend_ip_configuration_name": { "description": "The name of the frontend IP configuration to which the rule is associated.", "required": true }, "frontend_port": { "description": "The port for the external endpoint. Port numbers for each Rule must be unique within the Load Balancer. Possible values range between 0 and 65534, inclusive.", "required": true }, "idle_timeout_in_minutes": { "description": "Specifies the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to Tcp.", "required": false }, "load_distribution": { "description": "Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are: Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers. SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers. SourceIPProtocol – The load balancer is configured to use a 3 tuple hash to map traffic to available servers. Also known as Session Persistence, where the options are called None, Client IP and Client IP and Protocol respectively.", "required": false }, "loadbalancer_id": { "description": "The ID of the Load Balancer in which to create the Rule.", "required": true }, "name": { "description": "Specifies the name of the LB Rule.", "required": true }, "probe_id": { "description": "A reference to a Probe used by this Load Balancing Rule.", "required": false }, "protocol": { "description": "The transport protocol for the external endpoint. Possible values are Tcp, Udp or All.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the resource.", "required": true } }, "path": "/docs/providers/azurerm/r/loadbalancer_rule.html", "properties": [ "name", "resource_group_name", "loadbalancer_id", "frontend_ip_configuration_name", "protocol", "frontend_port", "backend_port", "backend_address_pool_id", "probe_id", "enable_floating_ip", "idle_timeout_in_minutes", "load_distribution" ] }, "azurerm_local_network_gateway": { "full_properties": { "address_space": { "description": "The list of string CIDRs representing the", "required": true }, "bgp_settings": { "description": "A bgp_settings block as defined below containing the", "required": false }, "gateway_address": { "description": "The IP address of the gateway to which to", "required": true }, "location": { "description": "The location/region where the local network gateway is", "required": true }, "name": { "description": "The name of the local network gateway. Changing this", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/local_network_gateway.html", "properties": [ "name", "resource_group_name", "location", "gateway_address", "address_space", "bgp_settings", "tags" ] }, "azurerm_log_analytics_solution": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "plan": { "description": "A plan block as documented below.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which the Log Analytics solution is created. Changing this forces a new resource to be created. Note: The solution and it's related workspace can only exist in the same resource group.", "required": true }, "solution_name": { "description": "Specifies the name of the solution to be deployed. See here for options.Changing this forces a new resource to be created.", "required": true }, "workspace_resource_id": { "description": "The full resource ID of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.", "required": true }, "workspace_resource_name": { "description": "The full name of the Log Analytics workspace with which the solution will be linked. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/log_analytics_solution.html", "properties": [ "solution_name", "resource_group_name", "location", "workspace_resource_id", "workspace_resource_name", "plan" ] }, "azurerm_log_analytics_workspace": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "Specifies the Sku of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, and PerGB2018 (new Sku as of 2018-04-03).", "required": true } }, "path": "/docs/providers/azurerm/r/log_analytics_workspace.html", "properties": [ "name", "resource_group_name", "location", "sku" ] }, "azurerm_log_analytics_workspace_linked_service": { "full_properties": { "linked_service_name": { "description": "Name of the type of linkedServices resource to connect to the Log Analytics Workspace specified in workspace_name. Currently it defaults to and only supports automation as a value. Changing this forces a new resource to be created.", "required": false }, "linked_service_properties": { "description": "A linked_service_properties block as defined below.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Log Analytics Linked Service is created. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "workspace_name": { "description": "Name of the Log Analytics Workspace that will contain the linkedServices resource. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/log_analytics_workspace_linked_service.html", "properties": [ "resource_group_name", "workspace_name", "linked_service_name", "linked_service_properties", "tags" ] }, "azurerm_logic_app_action_custom": { "full_properties": { "name": { "description": "Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/logic_app_action_custom.html", "properties": [ "name" ] }, "azurerm_logic_app_action_http": { "full_properties": { "name": { "description": "Specifies the name of the HTTP Action to be created within the Logic App Workflow. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/logic_app_action_http.html", "properties": [ "name" ] }, "azurerm_logic_app_trigger_custom": { "full_properties": { "name": { "description": "Specifies the name of the HTTP Trigger to be created within the Logic App Workflow. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/logic_app_trigger_custom.html", "properties": [ "name" ] }, "azurerm_logic_app_trigger_http_request": { "full_properties": { "name": { "description": "Specifies the name of the HTTP Request Trigger to be created within the Logic App Workflow. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/logic_app_trigger_http_request.html", "properties": [ "name" ] }, "azurerm_logic_app_trigger_recurrence": { "full_properties": { "name": { "description": "Specifies the name of the Recurrence Triggers to be created within the Logic App Workflow. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/logic_app_trigger_recurrence.html", "properties": [ "name" ] }, "azurerm_logic_app_workflow": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the Logic App Workflow exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Logic App Workflow. Changing this forces a new resource to be created.", "required": true }, "parameters": { "description": "A map of Key-Value pairs.", "required": false }, "resource_group_name": { "description": "The name of the Resource Group in which the Logic App Workflow should be created. Changing this forces a new resource to be created.", "required": true }, "workflow_schema": { "description": "Specifies the Schema to use for this Logic App Workflow. Defaults to https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#. Changing this forces a new resource to be created.", "required": false }, "workflow_version": { "description": "Specifies the version of the Schema used for this Logic App Workflow. Defaults to 1.0.0.0. Changing this forces a new resource to be create.d", "required": false } }, "path": "/docs/providers/azurerm/r/logic_app_workflow.html", "properties": [ "name", "resource_group_name", "location", "workflow_schema", "workflow_version", "parameters" ] }, "azurerm_managed_disk": { "full_properties": { "Copy": { "description": "Copy an existing managed disk or snapshot (specified with source_resource_id).", "required": false }, "Empty": { "description": "Create an empty managed disk.", "required": false }, "FromImage": { "description": "Copy a Platform Image (specified with image_reference_id)", "required": false }, "Import": { "description": "Import a VHD file in to the managed disk (VHD specified with source_uri).", "required": false }, "create_optionImportEmptyCopyFromImage": { }, "disk_size_gb": { "description": "Specifies the size of the managed disk to create in gigabytes.", "required": false }, "encryption_settings": { "description": "an encryption_settings block as defined below.", "required": false }, "image_reference_id": { "description": "ID of an existing platform/marketplace disk image to copy when create_option is FromImage.", "required": false }, "location": { "description": "Specified the supported Azure location where the resource exists.", "required": true }, "name": { "description": "Specifies the name of the managed disk. Changing this forces a", "required": true }, "os_type": { "description": "Specify a value when the source of an Import or Copy", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create", "required": true }, "source_resource_id": { "description": "ID of an existing managed disk to copy when create_option is Copy.", "required": false }, "source_uri": { "description": "URI to a valid VHD file to be used when create_option is Import.", "required": false }, "storage_account_type": { "description": "The type of storage to use for the managed disk.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "zones": { "description": "A collection containing the availability zone to allocate the Managed Disk in.", "required": false } }, "path": "/docs/providers/azurerm/r/managed_disk.html", "properties": [ "name", "resource_group_name", "location", "storage_account_type", "create_optionImportEmptyCopyFromImage", "Import", "Empty", "Copy", "FromImage", "source_uri", "source_resource_id", "image_reference_id", "os_type", "disk_size_gb", "encryption_settings", "tags", "zones" ] }, "azurerm_management_group": { "full_properties": { "display_name": { "description": "A friendly name for this Management Group. If not specified, this'll be the same as the group_id.", "required": false }, "group_id": { "description": "The UUID for this Management Group, which needs to be unique across your tenant - which will be generated if not provided. Changing this forces a new resource to be created.", "required": false }, "parent_management_group_id": { "description": "The ID of the Parent Management Group. Changing this forces a new resource to be created.", "required": false }, "subscription_ids": { "description": "A list of Subscription ID's which should be assigned to the Management Group.", "required": false } }, "path": "/docs/providers/azurerm/r/management_group.html", "properties": [ "group_id", "display_name", "parent_management_group_id", "subscription_ids" ] }, "azurerm_management_lock": { "full_properties": { "lock_level": { "description": "Specifies the Level to be used for this Lock. Possible values are CanNotDelete and ReadOnly. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Management Lock. Changing this forces a new resource to be created.", "required": true }, "scope": { "description": "Specifies the scope at which the Management Lock should be created. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/management_lock.html", "properties": [ "name", "scope", "lock_level" ] }, "azurerm_metric_alertrule": { "full_properties": { "description": { "description": "A verbose description of the alert rule that will be included in the alert email.", "required": false }, "enabled": { "description": "If true, the alert rule is enabled. Defaults to true.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the alert rule. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the alert rule. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/metric_alertrule.html", "properties": [ "name", "resource_group_name", "location", "description", "enabled" ] }, "azurerm_monitor_action_group": { "full_properties": { "email_receiver": { "description": "One or more email_receiver blocks as defined below.", "required": false }, "enabled": { "description": "Whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications. Defaults to true.", "required": false }, "name": { "description": "The name of the Action Group. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Action Group instance.", "required": true }, "short_name": { "description": "The short name of the action group. This will be used in SMS messages.", "required": true }, "sms_receiver": { "description": "One or more sms_receiver blocks as defined below.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "webhook_receiver": { "description": "One or more webhook_receiver blocks as defined below.", "required": false } }, "path": "/docs/providers/azurerm/r/monitor_action_group.html", "properties": [ "name", "resource_group_name", "short_name", "enabled", "email_receiver", "sms_receiver", "webhook_receiver", "tags" ] }, "azurerm_monitor_activity_log_alert": { "full_properties": { "action": { "description": "One or more action blocks as defined below.", "required": false }, "criteria": { "description": "A criteria block as defined below.", "required": true }, "description": { "description": "The description of this activity log alert.", "required": false }, "enabled": { "description": "Should this Activity Log Alert be enabled? Defaults to true.", "required": false }, "name": { "description": "The name of the activity log alert. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the activity log alert instance.", "required": true }, "scopes": { "description": "The Scope at which the Activity Log should be applied, for example a the Resource ID of a Subscription or a Resource (such as a Storage Account).", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/monitor_activity_log_alert.html", "properties": [ "name", "resource_group_name", "scopes", "criteria", "action", "enabled", "description", "tags" ] }, "azurerm_monitor_diagnostic_setting": { "full_properties": { "event_hub_name": { "description": "Specifies the name of the Event Hub where Diagnostics Data should be sent. Changing this forces a new resource to be created.", "required": false }, "name": { "description": "Specifies the name of the Diagnostic Setting. Changing this forces a new resource to be created.", "required": true }, "resource_id": { "description": "The ID of an existing Resource on which to configure Diagnostic Settings. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/monitor_diagnostic_setting.html", "properties": [ "name", "resource_id", "event_hub_name" ] }, "azurerm_monitor_log_profile": { "full_properties": { "categories": { "description": "List of categories of the logs.", "required": true }, "locations": { "description": "List of regions for which Activity Log events are stored or streamed.", "required": true }, "name": { "description": "The name of the Log Profile. Changing this forces a", "required": true }, "retention_policy": { "description": "A retention_policy block as documented below. A retention policy for how long Activity Logs are retained in the storage account.", "required": true }, "servicebus_rule_id": { "description": "The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of storage_account_id or servicebus_rule_id must be set.", "required": false }, "storage_account_id": { "description": "The resource ID of the storage account in which the Activity Log is stored. At least one of storage_account_id or servicebus_rule_id must be set.", "required": false } }, "path": "/docs/providers/azurerm/r/monitor_log_profile.html", "properties": [ "name", "categories", "locations", "storage_account_id", "servicebus_rule_id", "retention_policy" ] }, "azurerm_monitor_metric_alert": { "full_properties": { "action": { "description": "One or more action blocks as defined below.", "required": false }, "auto_mitigate": { "description": "Should the alerts in this Metric Alert be auto resolved? Defaults to false.", "required": false }, "criteria": { "description": "One or more criteria blocks as defined below.", "required": true }, "description": { "description": "The description of this Metric Alert.", "required": false }, "enabled": { "description": "Should this Metric Alert be enabled? Defaults to true.", "required": false }, "frequency": { "description": "The evaluation frequency of this Metric Alert, represented in ISO 8601 duration format. Possible values are PT1M, PT5M, PT15M, PT30M and PT1H. Defaults to PT1M.", "required": false }, "name": { "description": "The name of the Metric Alert. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Metric Alert instance.", "required": true }, "scopes": { "description": "The resource ID at which the metric criteria should be applied.", "required": true }, "severity": { "description": "The severity of this Metric Alert. Possible values are 0, 1, 2, 3 and 4. Defaults to 3.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "window_size": { "description": "The period of time that is used to monitor alert activity, represented in ISO 8601 duration format. This value must be greater than frequency. Possible values are PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H and P1D. Defaults to PT5M.", "required": false } }, "path": "/docs/providers/azurerm/r/monitor_metric_alert.html", "properties": [ "name", "resource_group_name", "scopes", "criteria", "action", "enabled", "auto_mitigate", "description", "frequency", "severity", "window_size", "tags" ] }, "azurerm_mssql_elasticpool": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.", "required": true }, "per_database_settings": { "description": "A per_database_settings block as defined below.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.", "required": true }, "server_name": { "description": "The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as defined below.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/mssql_elasticpool.html", "properties": [ "name", "resource_group_name", "location", "server_name", "sku", "per_database_settings", "tags" ] }, "azurerm_mysql_configuration": { "full_properties": { "name": { "description": "Specifies the name of the MySQL Configuration, which needs to be a valid MySQL configuration name. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.", "required": true }, "server_name": { "description": "Specifies the name of the MySQL Server. Changing this forces a new resource to be created.", "required": true }, "value": { "description": "Specifies the value of the MySQL Configuration. See the MySQL documentation for valid values.", "required": true } }, "path": "/docs/providers/azurerm/r/mysql_configuration.html", "properties": [ "name", "server_name", "resource_group_name", "value" ] }, "azurerm_mysql_database": { "full_properties": { "charset": { "description": "Specifies the Charset for the MySQL Database, which needs to be a valid MySQL Charset. Changing this forces a new resource to be created.", "required": true }, "collation": { "description": "Specifies the Collation for the MySQL Database, which needs to be a valid MySQL Collation. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the MySQL Database, which needs to be a valid MySQL identifier. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.", "required": true }, "server_name": { "description": "Specifies the name of the MySQL Server. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/mysql_database.html", "properties": [ "name", "server_name", "resource_group_name", "charset", "collation" ] }, "azurerm_mysql_firewall_rule": { "full_properties": { "end_ip_address": { "description": "Specifies the End IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the MySQL Firewall Rule. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the MySQL Server exists. Changing this forces a new resource to be created.", "required": true }, "server_name": { "description": "Specifies the name of the MySQL Server. Changing this forces a new resource to be created.", "required": true }, "start_ip_address": { "description": "Specifies the Start IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/mysql_firewall_rule.html", "properties": [ "name", "server_name", "resource_group_name", "start_ip_address", "end_ip_address" ] }, "azurerm_mysql_server": { "full_properties": { "administrator_login": { "description": "The Administrator Login for the MySQL Server. Changing this forces a new resource to be created.", "required": true }, "administrator_login_password": { "description": "The Password associated with the administrator_login for the MySQL Server.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the MySQL Server. Changing this forces a new resource to be created. This needs to be globally unique within Azure.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the MySQL Server. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as defined below.", "required": true }, "ssl_enforcement": { "description": "Specifies if SSL should be enforced on connections. Possible values are Enforced and Disabled.", "required": true }, "storage_profile": { "description": "A storage_profile block as defined below.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "version": { "description": "Specifies the version of MySQL to use. Valid values are 5.6 and 5.7. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/mysql_server.html", "properties": [ "name", "resource_group_name", "location", "sku", "storage_profile", "administrator_login", "administrator_login_password", "version", "ssl_enforcement", "tags" ] }, "azurerm_mysql_virtual_network_rule": { "full_properties": { "name": { "description": "The name of the MySQL Virtual Network Rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/mysql_virtual_network_rule.html", "properties": [ "name" ] }, "azurerm_network_interface": { "full_properties": { "enable_accelerated_networking": { "description": "Enables Azure Accelerated Networking using SR-IOV. Only certain VM instance sizes are supported. Refer to Create a Virtual Machine with Accelerated Networking. Defaults to false.", "required": false }, "enable_ip_forwarding": { "description": "Enables IP Forwarding on the NIC. Defaults to false.", "required": false }, "internal_dns_name_label": { "description": "Relative DNS name for this NIC used for internal communications between VMs in the same VNet", "required": false }, "location": { "description": "The location/region where the network interface is created. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the network interface. Changing this forces a new resource to be created.", "required": true }, "network_security_group_id": { "description": "The ID of the Network Security Group to associate with the network interface.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the network interface. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/network_interface.html", "properties": [ "name", "resource_group_name", "location", "network_security_group_id", "internal_dns_name_label", "enable_ip_forwarding", "enable_accelerated_networking" ] }, "azurerm_network_interface_application_gateway_backend_address_pool_association": { "full_properties": { "backend_address_pool_id": { "description": "The ID of the Application Gateway's Backend Address Pool which this Network Interface which should be connected to. Changing this forces a new resource to be created.", "required": true }, "ip_configuration_name": { "description": "The Name of the IP Configuration within the Network Interface which should be connected to the Backend Address Pool. Changing this forces a new resource to be created.", "required": true }, "network_interface_id": { "description": "The ID of the Network Interface. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/network_interface_application_gateway_backend_address_pool_association.html", "properties": [ "network_interface_id", "ip_configuration_name", "backend_address_pool_id" ] }, "azurerm_network_interface_backend_address_pool_association": { "full_properties": { "backend_address_pool_id": { "description": "The ID of the Load Balancer Backend Address Pool which this Network Interface which should be connected to. Changing this forces a new resource to be created.", "required": true }, "ip_configuration_name": { "description": "The Name of the IP Configuration within the Network Interface which should be connected to the Backend Address Pool. Changing this forces a new resource to be created.", "required": true }, "network_interface_id": { "description": "The ID of the Network Interface. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/network_interface_backend_address_pool_association.html", "properties": [ "network_interface_id", "ip_configuration_name", "backend_address_pool_id" ] }, "azurerm_network_interface_nat_rule_association": { "full_properties": { "ip_configuration_name": { "description": "The Name of the IP Configuration within the Network Interface which should be connected to the NAT Rule. Changing this forces a new resource to be created.", "required": true }, "nat_rule_id": { "description": "The ID of the Load Balancer NAT Rule which this Network Interface which should be connected to. Changing this forces a new resource to be created.", "required": true }, "network_interface_id": { "description": "The ID of the Network Interface. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/network_interface_nat_rule_association.html", "properties": [ "network_interface_id", "ip_configuration_name", "nat_rule_id" ] }, "azurerm_network_security_group": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the network security group. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the network security group. Changing this forces a new resource to be created.", "required": true }, "security_rule": { "description": "One or more security_rule blocks as defined below.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/network_security_group.html", "properties": [ "name", "resource_group_name", "location", "security_rule", "tags" ] }, "azurerm_network_security_rule": { "full_properties": { "access": { "description": "Specifies whether network traffic is allowed or denied. Possible values are Allow and Deny.", "required": true }, "description": { "description": "A description for this rule. Restricted to 140 characters.", "required": false }, "destination_address_prefix": { "description": "CIDR or destination IP range or * to match any IP. Tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. This is required if destination_address_prefixes is not specified.", "required": false }, "destination_address_prefixes": { "description": "List of destination address prefixes. Tags may not be used. This is required if destination_address_prefix is not specified.", "required": false }, "destination_application_security_group_ids": { "description": "A List of destination Application Security Group ID's", "required": false }, "destination_port_range": { "description": "Destination Port or Range. Integer or range between 0 and 65535 or * to match any. This is required if destination_port_ranges is not specified.", "required": false }, "destination_port_ranges": { "description": "List of destination ports or port ranges. This is required if destination_port_range is not specified.", "required": false }, "direction": { "description": "The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are Inbound and Outbound.", "required": true }, "name": { "description": "The name of the security rule. This needs to be unique across all Rules in the Network Security Group. Changing this forces a new resource to be created.", "required": true }, "network_security_group_name": { "description": "The name of the Network Security Group that we want to attach the rule to. Changing this forces a new resource to be created.", "required": true }, "priority": { "description": "Specifies the priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", "required": true }, "protocol": { "description": "Network protocol this rule applies to. Possible values include Tcp, Udp or * (which matches both).", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Network Security Rule. Changing this forces a new resource to be created.", "required": true }, "source_address_prefix": { "description": "CIDR or source IP range or * to match any IP. Tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. This is required if source_address_prefixes is not specified.", "required": false }, "source_address_prefixes": { "description": "List of source address prefixes. Tags may not be used. This is required if source_address_prefix is not specified.", "required": false }, "source_application_security_group_ids": { "description": "A List of source Application Security Group ID's", "required": false }, "source_port_range": { "description": "Source Port or Range. Integer or range between 0 and 65535 or * to match any. This is required if source_port_ranges is not specified.", "required": false }, "source_port_ranges": { "description": "List of source ports or port ranges. This is required if source_port_range is not specified.", "required": false } }, "path": "/docs/providers/azurerm/r/network_security_rule.html", "properties": [ "name", "resource_group_name", "network_security_group_name", "description", "protocol", "source_port_range", "source_port_ranges", "destination_port_range", "destination_port_ranges", "source_address_prefix", "source_address_prefixes", "source_application_security_group_ids", "destination_address_prefix", "destination_address_prefixes", "destination_application_security_group_ids", "access", "priority", "direction" ] }, "azurerm_network_watcher": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the Network Watcher. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Network Watcher. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/network_watcher.html", "properties": [ "name", "resource_group_name", "location", "tags" ] }, "azurerm_notification_hub": { "full_properties": { "apns_credential": { "description": "A apns_credential block as defined below.", "required": false }, "location": { "description": "The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name to use for this Notification Hub. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/notification_hub.html", "properties": [ "name", "namespace_name", "resource_group_name", "location", "apns_credential" ] }, "azurerm_notification_hub_authorization_rule": { "full_properties": { "manage": { "description": "Does this Authorization Rule have Manage access to the Notification Hub? Defaults to false.", "required": false }, "name": { "description": "The name to use for this Authorization Rule. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.", "required": true }, "notification_hub_name": { "description": "The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/notification_hub_authorization_rule.html", "properties": [ "name", "notification_hub_name", "namespace_name", "resource_group_name", "manage" ] }, "azurerm_notification_hub_namespace": { "full_properties": { "enabled": { "description": "Is this Notification Hub Namespace enabled? Defaults to true.", "required": false }, "location": { "description": "The Azure Region in which this Notification Hub Namespace should be created.", "required": true }, "name": { "description": "The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.", "required": true }, "namespace_type": { "description": "The Type of Namespace - possible values are Messaging or NotificationHub. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as defined below.", "required": true } }, "path": "/docs/providers/azurerm/r/notification_hub_namespace.html", "properties": [ "name", "resource_group_name", "location", "namespace_type", "sku", "enabled" ] }, "azurerm_packet_capture": { "full_properties": { "name": { "description": "The name to use for this Packet Capture. Changing this forces a new resource to be created.", "required": true }, "network_watcher_name": { "description": "The name of the Network Watcher. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Network Watcher exists. Changing this forces a new resource to be created.", "required": true }, "target_resource_id": { "description": "The ID of the Resource to capture packets from. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/packet_capture.html", "properties": [ "name", "network_watcher_name", "resource_group_name", "target_resource_id" ] }, "azurerm_policy_assignment": { "full_properties": { "description": { "description": "A description to use for this Policy Assignment. Changing this forces a new resource to be created.", "required": false }, "display_name": { "description": "A friendly display name to use for this Policy Assignment. Changing this forces a new resource to be created.", "required": false }, "name": { "description": "The name of the Policy Assignment. Changing this forces a new resource to be created.", "required": true }, "parameters": { "description": "Parameters for the policy definition. This field is a JSON object that maps to the Parameters field from the Policy Definition. Changing this forces a new resource to be created.", "required": false }, "policy_definition_id": { "description": "The ID of the Policy Definition to be applied at the specified Scope.", "required": true }, "scope": { "description": "The Scope at which the Policy Assignment should be applied, which must be a Resource ID (such as Subscription e.g. /subscriptions/00000000-0000-0000-000000000000 or a Resource Group e.g./subscriptions/00000000-0000-0000-000000000000/resourceGroups/myResourceGroup). Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/policy_assignment.html", "properties": [ "name", "scope", "policy_definition_id", "description", "display_name", "parameters" ] }, "azurerm_policy_definition": { "full_properties": { "description": { "description": "The description of the policy definition.", "required": false }, "display_name": { "description": "The display name of the policy definition.", "required": true }, "metadata": { "description": "The metadata for the policy definition. This", "required": false }, "mode": { "description": "The policy mode that allows you to specify which resource", "required": true }, "name": { "description": "The name of the policy definition. Changing this forces a", "required": true }, "parameters": { "description": "Parameters for the policy definition. This field", "required": false }, "policy_rule": { "description": "The policy rule for the policy definition. This", "required": false }, "policy_type": { "description": "The policy type. The value can be \"BuiltIn\", \"Custom\"", "required": true } }, "path": "/docs/providers/azurerm/r/policy_definition.html", "properties": [ "name", "policy_type", "mode", "display_name", "description", "policy_rule", "metadata", "parameters" ] }, "azurerm_postgresql_configuration": { "full_properties": { "name": { "description": "Specifies the name of the PostgreSQL Configuration, which needs to be a valid PostgreSQL configuration name. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.", "required": true }, "server_name": { "description": "Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.", "required": true }, "value": { "description": "Specifies the value of the PostgreSQL Configuration. See the PostgreSQL documentation for valid values.", "required": true } }, "path": "/docs/providers/azurerm/r/postgresql_configuration.html", "properties": [ "name", "server_name", "resource_group_name", "value" ] }, "azurerm_postgresql_database": { "full_properties": { "charset": { "description": "Specifies the Charset for the PostgreSQL Database, which needs to be a valid PostgreSQL Charset. Changing this forces a new resource to be created.", "required": true }, "collation": { "description": "Specifies the Collation for the PostgreSQL Database, which needs to be a valid PostgreSQL Collation. Note that Microsoft uses different notation - en-US instead of en_US. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the PostgreSQL Database, which needs to be a valid PostgreSQL identifier. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.", "required": true }, "server_name": { "description": "Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/postgresql_database.html", "properties": [ "name", "server_name", "resource_group_name", "charset", "collation" ] }, "azurerm_postgresql_firewall_rule": { "full_properties": { "end_ip_address": { "description": "Specifies the End IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the PostgreSQL Firewall Rule. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the PostgreSQL Server exists. Changing this forces a new resource to be created.", "required": true }, "server_name": { "description": "Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.", "required": true }, "start_ip_address": { "description": "Specifies the Start IP Address associated with this Firewall Rule. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/postgresql_firewall_rule.html", "properties": [ "name", "server_name", "resource_group_name", "start_ip_address", "end_ip_address" ] }, "azurerm_postgresql_server": { "full_properties": { "administrator_login": { "description": "The Administrator Login for the PostgreSQL Server. Changing this forces a new resource to be created.", "required": true }, "administrator_login_password": { "description": "The Password associated with the administrator_login for the PostgreSQL Server.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the PostgreSQL Server. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the PostgreSQL Server. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as defined below.", "required": true }, "ssl_enforcement": { "description": "Specifies if SSL should be enforced on connections. Possible values are Enabled and Disabled.", "required": true }, "storage_profile": { "description": "A storage_profile block as defined below.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "version": { "description": "Specifies the version of PostgreSQL to use. Valid values are 9.5, 9.6, and 10.0. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/postgresql_server.html", "properties": [ "name", "resource_group_name", "location", "sku", "storage_profile", "administrator_login", "administrator_login_password", "version", "ssl_enforcement", "tags" ] }, "azurerm_postgresql_virtual_network_rule": { "full_properties": { "name": { "description": "The name of the PostgreSQL virtual network rule. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/postgresql_virtual_network_rule.html", "properties": [ "name" ] }, "azurerm_public_ip": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Public IP resource . Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "sku": { "description": "The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic.", "required": false } }, "path": "/docs/providers/azurerm/r/public_ip.html", "properties": [ "name", "resource_group_name", "location", "sku" ] }, "azurerm_recovery_services_protected_vm": { "full_properties": { "backup_policy_id": { "description": "Specifies the id of the backup policy to use. Changing this forces a new resource to be created.", "required": true }, "recovery_vault_name": { "description": "Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Recovery Services Protected VM. Changing this forces a new resource to be created.", "required": true }, "source_vm_id": { "description": "Specifies the ID of the VM to backup. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/recovery_services_protected_vm.html", "properties": [ "resource_group_name", "recovery_vault_name", "source_vm_id", "backup_policy_id", "tags" ] }, "azurerm_recovery_services_protection_policy": { "full_properties": { "backup": { "description": "Configures the Policy backup frequecent, times & days as documented in the backup block below.", "required": true }, "name": { "description": "Specifies the name of the Recovery Services Vault Policy. Changing this forces a new resource to be created.", "required": true }, "recovery_vault_name": { "description": "Specifies the name of the Recovery Services Vault to use. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Recovery Services Protected VM. Changing this forces a new resource to be created.", "required": true }, "retention_daily": { "description": "Configures the policy daily retention as documented in the retention_daily block below. Required when backup frequency is Daily.", "required": false }, "retention_monthly": { "description": "Configures the policy monthly retention as documented in the retention_monthly block below.", "required": false }, "retention_weekly": { "description": "Configures the policy weekly retention as documented in the retention_weekly block below. Required when backup frequency is Weekly.", "required": false }, "retention_yearly": { "description": "Configures the policy yearly retention as documented in the retention_yearly block below.", "required": false } }, "path": "/docs/providers/azurerm/r/recovery_services_protection_policy_vm.html", "properties": [ "name", "resource_group_name", "recovery_vault_name", "backup", "retention_daily", "retention_weekly", "retention_monthly", "retention_yearly" ] }, "azurerm_recovery_services_vault": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Recovery Services Vault. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Recovery Services Vault. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "Sets the vault's SKU. Possible values include: Standard, RS0.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/recovery_services_vault.html", "properties": [ "name", "resource_group_name", "location", "tags", "sku" ] }, "azurerm_redis_cache": { "full_properties": { "capacity": { "description": "The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.", "required": true }, "family": { "description": "The SKU family to use. Valid values are C and P, where C = Basic/Standard, P = Premium.", "required": true }, "location": { "description": "The location of the resource group.", "required": true }, "name": { "description": "The name of the Redis instance. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true } }, "path": "/docs/providers/azurerm/r/redis_cache.html", "properties": [ "name", "location", "resource_group_name", "capacity", "family" ] }, "azurerm_redis_firewall_rule": { "full_properties": { "end_ip": { "description": "The highest IP address included in the range.", "required": true }, "name": { "description": "The name of the Firewall Rule. Changing this forces a new resource to be created.", "required": true }, "redis_cache_name": { "description": "The name of the Redis Cache. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which this Redis Cache exists.", "required": true }, "start_ip": { "description": "The lowest IP address included in the range", "required": true } }, "path": "/docs/providers/azurerm/r/redis_firewall_rule.html", "properties": [ "name", "redis_cache_name", "resource_group_name", "start_ip", "end_ip" ] }, "azurerm_relay_namespace": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the Azure Relay Namespace exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Azure Relay Namespace. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Azure Relay Namespace.", "required": true }, "sku": { "description": "A sku block as defined below.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/relay_namespace.html", "properties": [ "name", "resource_group_name", "location", "sku", "tags" ] }, "azurerm_resource_group": { "full_properties": { "location": { "description": "The location where the resource group should be created.", "required": true }, "name": { "description": "The name of the resource group. Must be unique on your", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/resource_group.html", "properties": [ "name", "location", "tags" ] }, "azurerm_role_assignment": { "full_properties": { "name": { "description": "A unique UUID/GUID for this Role Assignment - one will be generated if not specified. Changing this forces a new resource to be created.", "required": false }, "principal_id": { "description": "The ID of the Principal (User or Application) to assign the Role Definition to. Changing this forces a new resource to be created.", "required": true }, "role_definition_id": { "description": "The Scoped-ID of the Role Definition. Changing this forces a new resource to be created. Conflicts with role_definition_name.", "required": false }, "role_definition_name": { "description": "The name of a built-in Role. Changing this forces a new resource to be created. Conflicts with role_definition_id.", "required": false }, "scope": { "description": "The scope at which the Role Assignment applies too, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/role_assignment.html", "properties": [ "name", "scope", "role_definition_id", "role_definition_name", "principal_id" ] }, "azurerm_role_definition": { "full_properties": { "assignable_scopes": { "description": "One or more assignable scopes for this Role Definition, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM.", "required": true }, "description": { "description": "A description of the Role Definition.", "required": false }, "name": { "description": "The name of the Role Definition. Changing this forces a new resource to be created.", "required": true }, "permissions": { "description": "A permissions block as defined below.", "required": true }, "role_definition_id": { "description": "A unique UUID/GUID which identifies this role - one will be generated if not specified. Changing this forces a new resource to be created.", "required": false }, "scope": { "description": "The scope at which the Role Definition applies too, such as /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup, or /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourceGroups/myGroup/providers/Microsoft.Compute/virtualMachines/myVM. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/role_definition.html", "properties": [ "role_definition_id", "name", "scope", "description", "permissions", "assignable_scopes" ] }, "azurerm_route": { "full_properties": { "address_prefix": { "description": "The destination CIDR to which the route applies, such as 10.1.0.0/16", "required": true }, "name": { "description": "The name of the route. Changing this forces a new resource to be created.", "required": true }, "next_hop_in_ip_address": { "description": "Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.", "required": false }, "next_hop_type": { "description": "The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the route. Changing this forces a new resource to be created.", "required": true }, "route_table_name": { "description": "The name of the route table within which create the route. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/route.html", "properties": [ "name", "resource_group_name", "route_table_name", "address_prefix", "next_hop_type", "next_hop_in_ip_address" ] }, "azurerm_route_table": { "full_properties": { "disable_bgp_route_propagation": { "description": "Boolean flag which controls propagation of routes learned by BGP on that route table. True means disable.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the route table. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the route table. Changing this forces a new resource to be created.", "required": true }, "route": { "description": "Can be specified multiple times to define multiple routes. Each route block supports fields documented below.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/route_table.html", "properties": [ "name", "resource_group_name", "location", "route", "disable_bgp_route_propagation", "tags" ] }, "azurerm_scheduler_job": { "full_properties": { "action_web": { "description": "A action_web block defining the job action as described below. Note this is identical to an error_action_web block.", "required": false }, "job_collection_name": { "description": "Specifies the name of the Scheduler Job Collection in which the Job should exist. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the Scheduler Job. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Scheduler Job. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/scheduler_job.html", "properties": [ "name", "resource_group_name", "job_collection_name", "action_web" ] }, "azurerm_scheduler_job_collection": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Scheduler Job Collection. Changing this forces a new resource to be created.", "required": true }, "quota": { "description": "Configures the Job collection quotas as documented in the quota block below.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the Scheduler Job Collection. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "Sets the Job Collection's pricing level's SKU. Possible values include: Standard, Free, P10Premium, P20Premium.", "required": true }, "state": { "description": "Sets Job Collection's state. Possible values include: Enabled, Disabled, Suspended.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/scheduler_job_collection.html", "properties": [ "name", "resource_group_name", "location", "tags", "sku", "state", "quota" ] }, "azurerm_search_service": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the Search Service. Changing this forces a new resource to be created.", "required": true }, "partition_count": { "description": "Default is 1. Valid values include 1, 2, 3, 4, 6, or 12. Valid only when sku is standard. Changing this forces a new resource to be created.", "required": false }, "replica_count": { "description": "Default is 1. Valid values include 1 through 12. Valid only when sku is standard. Changing this forces a new resource to be created.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the Search Service. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "Valid values are free and standard. standard2 and standard3 are also valid, but can only be used when it's enabled on the backend by Microsoft support. free provisions the service in shared clusters. standard provisions the service in dedicated clusters. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource. Changing this forces a new resource to be created.", "required": false } }, "path": "/docs/providers/azurerm/r/search_service.html", "properties": [ "name", "resource_group_name", "location", "sku", "replica_count", "partition_count", "tags" ] }, "azurerm_security_center_contact": { "full_properties": { "alert_notifications": { "description": "Whether to send security alerts notifications to the security contact.", "required": true }, "alerts_to_admins": { "description": "Whether to send security alerts notifications to subscription admins.", "required": true }, "email": { "description": "The email of the Security Center Contact.", "required": true }, "phone": { "description": "The phone number of the Security Center Contact.", "required": true } }, "path": "/docs/providers/azurerm/r/security_center_contact.html", "properties": [ "email", "phone", "alert_notifications", "alerts_to_admins" ] }, "azurerm_security_center_subscription_pricing": { "full_properties": { "tier": { "description": "The pricing tier to use. Possible values are Free and Standard.", "required": true } }, "path": "/docs/providers/azurerm/r/security_center_subscription_pricing.html", "properties": [ "tier" ] }, "azurerm_security_center_workspace": { "full_properties": { "scope": { "description": "The scope of VMs to send their security data to the desired workspace, unless overridden by a setting with more specific scope.", "required": true }, "workspace_id": { "description": "The ID of the Log Analytics Workspace to save the data in.", "required": true } }, "path": "/docs/providers/azurerm/r/security_center_workspace.html", "properties": [ "scope", "workspace_id" ] }, "azurerm_service_fabric_cluster": { "full_properties": { "location": { "description": "Specifies the Azure Region where the Service Fabric Cluster should exist. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the Service Fabric Cluster. Changing this forces a new resource to be created.", "required": true }, "reliability_level": { "description": "Specifies the Reliability Level of the Cluster. Possible values include None, Bronze, Silver, Gold and Platinum.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in which the Service Fabric Cluster exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/service_fabric_cluster.html", "properties": [ "name", "resource_group_name", "location", "reliability_level" ] }, "azurerm_servicebus_namespace": { "full_properties": { "capacity": { "description": "Specifies the capacity, can only be set when sku is Premium namespace. Can be 1, 2 or 4.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the ServiceBus Namespace resource . Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "sku": { "description": "Defines which tier to use. Options are basic, standard or premium.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/servicebus_namespace.html", "properties": [ "name", "resource_group_name", "location", "sku", "capacity", "tags" ] }, "azurerm_servicebus_namespace_authorization_rule": { "full_properties": { "name": { "description": "Specifies the name of the ServiceBus Namespace Authorization Rule resource. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/servicebus_namespace_authorization_rule.html", "properties": [ "name", "namespace_name", "resource_group_name" ] }, "azurerm_servicebus_queue": { "full_properties": { "auto_delete_on_idle": { "description": "The ISO 8601 timespan duration of the idle interval after which the", "required": false }, "default_message_ttl": { "description": "The ISO 8601 timespan duration of the TTL of messages sent to this", "required": false }, "duplicate_detection_history_time_window": { "description": "The ISO 8601 timespan duration during which", "required": false }, "enable_express": { "description": "Boolean flag which controls whether Express Entities", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists.", "required": true }, "name": { "description": "Specifies the name of the ServiceBus Queue resource. Changing this forces a", "required": true }, "namespace_name": { "description": "The name of the ServiceBus Namespace to create", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true } }, "path": "/docs/providers/azurerm/r/servicebus_queue.html", "properties": [ "name", "namespace_name", "location", "resource_group_name", "auto_delete_on_idle", "default_message_ttl", "duplicate_detection_history_time_window", "enable_express" ] }, "azurerm_servicebus_queue_authorization_rule": { "full_properties": { "name": { "description": "Specifies the name of the Authorization Rule. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "Specifies the name of the ServiceBus Namespace in which the Queue exists. Changing this forces a new resource to be created.", "required": true }, "queue_name": { "description": "Specifies the name of the ServiceBus Queue. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/servicebus_queue_authorization_rule.html", "properties": [ "name", "namespace_name", "queue_name", "resource_group_name" ] }, "azurerm_servicebus_subscription": { "full_properties": { "auto_delete_on_idle": { "description": "The idle interval after which the", "required": false }, "dead_lettering_on_message_expiration": { "description": "Boolean flag which controls", "required": false }, "default_message_ttl": { "description": "The TTL of messages sent to this Subscription", "required": false }, "enable_batched_operations": { "description": "Boolean flag which controls whether the", "required": false }, "forward_to": { "description": "The name of a Queue or Topic to automatically forward ", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists.", "required": true }, "lock_duration": { "description": "The lock duration for the subscription, maximum", "required": false }, "max_delivery_count": { "description": "The maximum number of deliveries.", "required": true }, "name": { "description": "Specifies the name of the ServiceBus Subscription resource.", "required": true }, "namespace_name": { "description": "The name of the ServiceBus Namespace to create", "required": true }, "requires_session": { "description": "Boolean flag which controls whether this Subscription", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "topic_name": { "description": "The name of the ServiceBus Topic to create", "required": true } }, "path": "/docs/providers/azurerm/r/servicebus_subscription.html", "properties": [ "name", "namespace_name", "topic_name", "location", "resource_group_name", "max_delivery_count", "auto_delete_on_idle", "default_message_ttl", "lock_duration", "dead_lettering_on_message_expiration", "enable_batched_operations", "requires_session", "forward_to" ] }, "azurerm_servicebus_subscription_rule": { "full_properties": { "action": { "description": "Represents set of actions written in SQL language-based syntax that is performed against a BrokeredMessage.", "required": false }, "correlation_filter": { "description": "A correlation_filter block as documented below to be evaluated against a BrokeredMessage. Required when filter_type is set to CorrelationFilter.", "required": false }, "filter_type": { "description": "Type of filter to be applied to a BrokeredMessage. Possible values are SqlFilter and CorrelationFilter.", "required": true }, "name": { "description": "Specifies the name of the ServiceBus Subscription Rule. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "The name of the ServiceBus Namespace in which the ServiceBus Topic exists. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in the ServiceBus Namespace exists. Changing this forces a new resource to be created.", "required": true }, "sql_filter": { "description": "Represents a filter written in SQL language-based syntax that to be evaluated against a BrokeredMessage. Required when filter_type is set to SqlFilter.", "required": false }, "subscription_name": { "description": "The name of the ServiceBus Subscription in which this Rule should be created. Changing this forces a new resource to be created.", "required": true }, "topic_name": { "description": "The name of the ServiceBus Topic in which the ServiceBus Subscription exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/servicebus_subscription_rule.html", "properties": [ "name", "namespace_name", "topic_name", "subscription_name", "resource_group_name", "filter_type", "sql_filter", "correlation_filter", "action" ] }, "azurerm_servicebus_topic": { "full_properties": { "auto_delete_on_idle": { "description": "The ISO 8601 timespan duration of the idle interval after which the", "required": false }, "default_message_ttl": { "description": "The ISO 8601 timespan duration of TTL of messages sent to this topic if no", "required": false }, "duplicate_detection_history_time_window": { "description": "The ISO 8601 timespan duration during which", "required": false }, "enable_batched_operations": { "description": "Boolean flag which controls if server-side", "required": false }, "enable_express": { "description": "Boolean flag which controls whether Express Entities", "required": false }, "enable_partitioning": { "description": "Boolean flag which controls whether to enable", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists.", "required": true }, "name": { "description": "Specifies the name of the ServiceBus Topic resource. Changing this forces a", "required": true }, "namespace_name": { "description": "The name of the ServiceBus Namespace to create", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "status": { "description": "The Status of the Service Bus Topic. Acceptable values are Active or Disabled. Defaults to Active.", "required": false } }, "path": "/docs/providers/azurerm/r/servicebus_topic.html", "properties": [ "name", "namespace_name", "location", "resource_group_name", "status", "auto_delete_on_idle", "default_message_ttl", "duplicate_detection_history_time_window", "enable_batched_operations", "enable_express", "enable_partitioning" ] }, "azurerm_servicebus_topic_authorization_rule": { "full_properties": { "name": { "description": "Specifies the name of the ServiceBus Topic Authorization Rule resource. Changing this forces a new resource to be created.", "required": true }, "namespace_name": { "description": "Specifies the name of the ServiceBus Namespace. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the ServiceBus Namespace exists. Changing this forces a new resource to be created.", "required": true }, "topic_name": { "description": "Specifies the name of the ServiceBus Topic. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/servicebus_topic_authorization_rule.html", "properties": [ "name", "namespace_name", "topic_name", "resource_group_name" ] }, "azurerm_shared_image": { "full_properties": { "gallery_name": { "description": "Specifies the name of the Shared Image Gallery in which this Shared Image should exist. Changing this forces a new resource to be created.", "required": true }, "identity": { "description": "An identity block as defined below.", "required": true }, "location": { "description": "Specifies the supported Azure location where the Shared Image Gallery exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Shared Image. Changing this forces a new resource to be created.", "required": true }, "os_type": { "description": "The type of Operating System present in this Shared Image. Possible values are Linux and Windows.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/shared_image.html", "properties": [ "name", "gallery_name", "resource_group_name", "location", "identity", "os_type" ] }, "azurerm_shared_image_gallery": { "full_properties": { "description": { "description": "A description for this Shared Image Gallery.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Shared Image Gallery. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Shared Image Gallery. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the Shared Image Gallery.", "required": false } }, "path": "/docs/providers/azurerm/r/shared_image_gallery.html", "properties": [ "name", "resource_group_name", "location", "description", "tags" ] }, "azurerm_shared_image_version": { "full_properties": { "gallery_name": { "description": "The name of the Shared Image Gallery in which the Shared Image exists. Changing this forces a new resource to be created.", "required": true }, "image_name": { "description": "The name of the Shared Image within the Shared Image Gallery in which this Version should be created. Changing this forces a new resource to be created.", "required": true }, "location": { "description": "The Azure Region in which the Shared Image Gallery exists. Changing this forces a new resource to be created.", "required": true }, "managed_image_id": { "description": "The ID of the Managed Image which should be used for this Shared Image Version. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The version number for this Image Version, such as 1.0.0. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the Resource Group in which the Shared Image Gallery exists. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/shared_image_version.html", "properties": [ "name", "gallery_name", "image_name", "location", "resource_group_name", "managed_image_id" ] }, "azurerm_snapshot": { "full_properties": { "create_option": { "description": "Indicates how the snapshot is to be created. Possible values are Copy or Import. Changing this forces a new resource to be created.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/snapshot.html", "properties": [ "name", "resource_group_name", "location", "create_option" ] }, "azurerm_sql_active_directory_administrator": { "full_properties": { "login": { "description": "The login name of the principal to set as the server administrator", "required": true }, "object_id": { "description": "The ID of the principal to set as the server administrator", "required": true }, "resource_group_name": { "description": "The name of the resource group for the SQL server. Changing this forces a new resource to be created.", "required": true }, "server_name": { "description": "The name of the SQL Server on which to set the administrator. Changing this forces a new resource to be created.", "required": true }, "tenant_id": { "description": "The Azure Tenant ID", "required": true } }, "path": "/docs/providers/azurerm/r/sql_active_directory_administrator.html", "properties": [ "server_name", "resource_group_name", "login", "object_id", "tenant_id" ] }, "azurerm_sql_database": { "full_properties": { "collation": { "description": "The name of the collation. Applies only if create_mode is Default. Azure default is SQL_LATIN1_GENERAL_CP1_CI_AS. Changing this forces a new resource to be created.", "required": false }, "create_mode": { "description": "Specifies the type of database to create. Defaults to Default. See below for the accepted values/", "required": false }, "edition": { "description": "The edition of the database to be created. Applies only if create_mode is Default. Valid values are: Basic, Standard, Premium, or DataWarehouse. Please see Azure SQL Database Service Tiers.", "required": false }, "elastic_pool_name": { "description": "The name of the elastic database pool.", "required": false }, "import": { "description": "A Database Import block as documented below. create_mode must be set to Default.", "required": false }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "max_size_bytes": { "description": "The maximum size that the database can grow to. Applies only if create_mode is Default. Please see Azure SQL Database Service Tiers.", "required": false }, "name": { "description": "The name of the database.", "required": true }, "requested_service_objective_id": { "description": "Use requested_service_objective_id or requested_service_objective_name to set the performance level for the database.", "required": false }, "requested_service_objective_name": { "description": "Use requested_service_objective_name or requested_service_objective_id to set the performance level for the database. Please see Azure SQL Database Service Tiers.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the database. This must be the same as Database Server resource group currently.", "required": true }, "restore_point_in_time": { "description": "The point in time for the restore. Only applies if create_mode is PointInTimeRestore e.g. 2013-11-08T22:00:40Z", "required": false }, "server_name": { "description": "The name of the SQL Server on which to create the database.", "required": true }, "source_database_deletion_date": { "description": "The deletion date time of the source database. Only applies to deleted databases where create_mode is PointInTimeRestore.", "required": false }, "source_database_id": { "description": "The URI of the source database if create_mode value is not Default.", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "threat_detection_policy": { "description": "Threat detection policy configuration. The threat_detection_policy block supports fields documented below.", "required": false } }, "path": "/docs/providers/azurerm/r/sql_database.html", "properties": [ "name", "resource_group_name", "location", "server_name", "create_mode", "import", "source_database_id", "restore_point_in_time", "edition", "collation", "max_size_bytes", "requested_service_objective_id", "requested_service_objective_name", "source_database_deletion_date", "elastic_pool_name", "threat_detection_policy", "tags" ] }, "azurerm_sql_elasticpool": { "full_properties": { "db_dtu_max": { "description": "The maximum DTU which will be guaranteed to all databases in the elastic pool to be created.", "required": false }, "db_dtu_min": { "description": "The minimum DTU which will be guaranteed to all databases in the elastic pool to be created.", "required": false }, "dtu": { "description": "The total shared DTU for the elastic pool. Valid values depend on the edition which has been defined. Refer to Azure SQL Database Service Tiers for valid combinations.", "required": true }, "edition": { "description": "The edition of the elastic pool to be created. Valid values are Basic, Standard, and Premium. Refer to Azure SQL Database Service Tiers for details. Changing this forces a new resource to be created.", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the elastic pool. This needs to be globally unique. Changing this forces a new resource to be created.", "required": true }, "pool_size": { "description": "The maximum size in MB that all databases in the elastic pool can grow to. The maximum size must be consistent with combination of edition and dtu and the limits documented in Azure SQL Database Service Tiers. If not defined when creating an elastic pool, the value is set to the size implied by edition and dtu.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the elastic pool. This must be the same as the resource group of the underlying SQL server.", "required": true }, "server_name": { "description": "The name of the SQL Server on which to create the elastic pool. Changing this forces a new resource to be created.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/sql_elasticpool.html", "properties": [ "name", "resource_group_name", "location", "server_name", "edition", "dtu", "db_dtu_min", "db_dtu_max", "pool_size", "tags" ] }, "azurerm_sql_firewall_rule": { "full_properties": { "end_ip_address": { "description": "The ending IP address to allow through the firewall for this rule.", "required": true }, "name": { "description": "The name of the firewall rule.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "server_name": { "description": "The name of the SQL Server on which to create the Firewall Rule.", "required": true }, "start_ip_address": { "description": "The starting IP address to allow through the firewall for this rule.", "required": true } }, "path": "/docs/providers/azurerm/r/sql_firewall_rule.html", "properties": [ "name", "resource_group_name", "server_name", "start_ip_address", "end_ip_address" ] }, "azurerm_sql_server": { "full_properties": { "administrator_login": { "description": "The administrator login name for the new server. Changing this forces a new resource to be created.", "required": true }, "administrator_login_password": { "description": "The password associated with the administrator_login user. Needs to comply with Azure's Password Policy", "required": true }, "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "The name of the SQL Server. This needs to be globally unique within Azure.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to create the SQL Server.", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "version": { "description": "The version for the new server. Valid values are: 2.0 (for v11 server) and 12.0 (for v12 server).", "required": true } }, "path": "/docs/providers/azurerm/r/sql_server.html", "properties": [ "name", "resource_group_name", "location", "version", "administrator_login", "administrator_login_password", "tags" ] }, "azurerm_sql_virtual_network_rule": { "full_properties": { "name": { "description": "The name of the SQL virtual network rule. Changing this forces a new resource to be created. Cannot be empty and must only contain alphanumeric characters and hyphens. Cannot start with a number, and cannot start or end with a hyphen.", "required": true } }, "path": "/docs/providers/azurerm/r/sql_virtual_network_rule.html", "properties": [ "name" ] }, "azurerm_storage_account": { "full_properties": { "access_tier": { "description": "Defines the access tier for BlobStorage and StorageV2 accounts. Valid options are Hot and Cool, defaults to Hot.", "required": false }, "account_encryption_source": { "description": "The Encryption Source for this Storage Account. Possible values are Microsoft.Keyvault and Microsoft.Storage. Defaults to Microsoft.Storage.", "required": false }, "account_kind": { "description": "Defines the Kind of account. Valid options are Storage,", "required": false }, "account_replication_type": { "description": "Defines the type of replication to use for this storage account. Valid options are LRS, GRS, RAGRS and ZRS.", "required": true }, "account_tier": { "description": "Defines the Tier to use for this storage account. Valid options are Standard and Premium. Changing this forces a new resource to be created", "required": true }, "custom_domain": { "description": "A custom_domain block as documented below.", "required": false }, "enable_blob_encryption": { "description": "Boolean flag which controls if Encryption Services are enabled for Blob storage, see here for more information. Defaults to true.", "required": false }, "enable_file_encryption": { "description": "Boolean flag which controls if Encryption Services are enabled for File storage, see here for more information. Defaults to true.", "required": false }, "enable_https_traffic_only": { "description": "Boolean flag which forces HTTPS if enabled, see here", "required": false }, "identity": { "description": "A Managed Service Identity block as defined below.", "required": false }, "location": { "description": "Specifies the supported Azure location where the", "required": true }, "name": { "description": "Specifies the name of the storage account. Changing this forces a", "required": true }, "network_rules": { "description": "A network_rules block as documented below.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/storage_account.html", "properties": [ "name", "resource_group_name", "location", "account_kind", "account_tier", "account_replication_type", "access_tier", "enable_blob_encryption", "enable_file_encryption", "enable_https_traffic_only", "account_encryption_source", "custom_domain", "network_rules", "tags", "identity" ] }, "azurerm_storage_blob": { "full_properties": { "attempts": { "description": "The number of attempts to make per page or block when uploading. Defaults to 1.", "required": false }, "content_type": { "description": "The content type of the storage blob. Cannot be defined if source_uri is defined. Defaults to application/octet-stream.", "required": false }, "name": { "description": "The name of the storage blob. Must be unique within the storage container the blob is located.", "required": true }, "parallelism": { "description": "The number of workers per CPU core to run for concurrent uploads. Defaults to 8.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "size": { "description": "Used only for page blobs to specify the size in bytes of the blob to be created. Must be a multiple of 512. Defaults to 0.", "required": false }, "source": { "description": "An absolute path to a file on the local system. Cannot be defined if source_uri is defined.", "required": false }, "source_uri": { "description": "The URI of an existing blob, or a file in the Azure File service, to use as the source contents", "required": false }, "storage_account_name": { "description": "Specifies the storage account in which to create the storage container.", "required": true }, "storage_container_name": { "description": "The name of the storage container in which this blob should be created.", "required": true }, "type": { "description": "The type of the storage blob to be created. One of either block or page. When not copying from an existing blob,", "required": false } }, "path": "/docs/providers/azurerm/r/storage_blob.html", "properties": [ "name", "resource_group_name", "storage_account_name", "storage_container_name", "type", "size", "content_type", "source", "source_uri", "parallelism", "attempts" ] }, "azurerm_storage_container": { "full_properties": { "container_access_type": { "description": "The 'interface' for access the container provides. Can be either blob, container or private. Defaults to private.", "required": false }, "name": { "description": "The name of the storage container. Must be unique within the storage service the container is located.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "storage_account_name": { "description": "Specifies the storage account in which to create the storage container.", "required": true } }, "path": "/docs/providers/azurerm/r/storage_container.html", "properties": [ "name", "resource_group_name", "storage_account_name", "container_access_type" ] }, "azurerm_storage_queue": { "full_properties": { "name": { "description": "The name of the storage queue. Must be unique within the storage account the queue is located.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "storage_account_name": { "description": "Specifies the storage account in which to create the storage queue.", "required": true } }, "path": "/docs/providers/azurerm/r/storage_queue.html", "properties": [ "name", "resource_group_name", "storage_account_name" ] }, "azurerm_storage_share": { "full_properties": { "name": { "description": "The name of the share. Must be unique within the storage account where the share is located.", "required": true }, "quota": { "description": "The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5 TB (5120 GB). Default is 5120.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "storage_account_name": { "description": "Specifies the storage account in which to create the share.", "required": true } }, "path": "/docs/providers/azurerm/r/storage_share.html", "properties": [ "name", "resource_group_name", "storage_account_name", "quota" ] }, "azurerm_storage_table": { "full_properties": { "name": { "description": "The name of the storage table. Must be unique within the storage account the table is located.", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "storage_account_name": { "description": "Specifies the storage account in which to create the storage table.", "required": true } }, "path": "/docs/providers/azurerm/r/storage_table.html", "properties": [ "name", "resource_group_name", "storage_account_name" ] }, "azurerm_subnet": { "full_properties": { "address_prefix": { "description": "The address prefix to use for the subnet.", "required": true }, "name": { "description": "The name of the subnet. Changing this forces a new resource to be created.", "required": true }, "network_security_group_id": { "description": "The ID of the Network Security Group to associate with the subnet.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the subnet. Changing this forces a new resource to be created.", "required": true }, "virtual_network_name": { "description": "The name of the virtual network to which to attach the subnet. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/subnet.html", "properties": [ "name", "resource_group_name", "virtual_network_name", "address_prefix", "network_security_group_id" ] }, "azurerm_subnet_network_security_group_association": { "full_properties": { "network_security_group_id": { "description": "The ID of the Network Security Group which should be associated with the Subnet. Changing this forces a new resource to be created.", "required": true }, "subnet_id": { "description": "The ID of the Subnet. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/subnet_network_security_group_association.html", "properties": [ "network_security_group_id", "subnet_id" ] }, "azurerm_subnet_route_table_association": { "full_properties": { "route_table_id": { "description": "The ID of the Route Table which should be associated with the Subnet. Changing this forces a new resource to be created.", "required": true }, "subnet_id": { "description": "The ID of the Subnet. Changing this forces a new resource to be created.", "required": true } }, "path": "/docs/providers/azurerm/r/subnet_route_table_association.html", "properties": [ "route_table_id", "subnet_id" ] }, "azurerm_template_deployment": { "full_properties": { "deployment_mode": { "description": "Specifies the mode that is used to deploy resources. This value could be either Incremental or Complete.", "required": true }, "name": { "description": "Specifies the name of the template deployment. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "template_body": { "description": "Specifies the JSON definition for the template.", "required": false } }, "path": "/docs/providers/azurerm/r/template_deployment.html", "properties": [ "name", "resource_group_name", "deployment_mode", "template_body" ] }, "azurerm_traffic_manager_endpoint": { "full_properties": { "azureEndpoints": { }, "endpoint_location": { "description": "Specifies the Azure location of the Endpoint,", "required": false }, "endpoint_status": { "description": "The status of the Endpoint, can be set to", "required": false }, "externalEndpoints": { }, "geo_mappings": { "description": "A list of Geographic Regions used to distribute traffic, such as WORLD, UK or DE. The same location can't be specified in two endpoints. See the Geographic Hierarchies documentation for more information.", "required": false }, "min_child_endpoints": { "description": "This argument specifies the minimum number", "required": false }, "name": { "description": "The name of the Traffic Manager endpoint. Changing this forces a", "required": true }, "nestedEndpoints": { }, "priority": { "description": "Specifies the priority of this Endpoint, this must be", "required": false }, "profile_name": { "description": "The name of the Traffic Manager Profile to attach", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "target": { "description": "The FQDN DNS name of the target. This argument must be", "required": false }, "target_resource_id": { "description": "The resource id of an Azure resource to", "required": false }, "typeazureEndpointsexternalEndpointsnestedEndpoints": { }, "weight": { "description": "Specifies how much traffic should be distributed to this", "required": false } }, "path": "/docs/providers/azurerm/r/traffic_manager_endpoint.html", "properties": [ "name", "resource_group_name", "profile_name", "endpoint_status", "typeazureEndpointsexternalEndpointsnestedEndpoints", "azureEndpoints", "externalEndpoints", "nestedEndpoints", "target", "target_resource_id", "weight", "priority", "endpoint_location", "min_child_endpoints", "geo_mappings" ] }, "azurerm_traffic_manager_profile": { "full_properties": { "Geographic": { "description": "Traffic is routed based on Geographic regions specified in the Endpoint.", "required": false }, "Performance": { "description": "Traffic is routed via the User's closest Endpoint", "required": false }, "Priority": { "description": "Traffic is routed to the Endpoint with the lowest priority value.", "required": false }, "Weighted": { "description": "Traffic is spread across Endpoints proportional to their weight value.", "required": false }, "dns_config": { "description": "This block specifies the DNS configuration of the", "required": true }, "monitor_config": { "description": "This block specifies the Endpoint monitoring", "required": true }, "name": { "description": "The name of the virtual network. Changing this forces a", "required": true }, "profile_status": { "description": "The status of the profile, can be set to either", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "traffic_routing_methodGeographicPerformanceWeightedPriority": { } }, "path": "/docs/providers/azurerm/r/traffic_manager_profile.html", "properties": [ "name", "resource_group_name", "profile_status", "traffic_routing_methodGeographicPerformanceWeightedPriority", "Geographic", "Performance", "Weighted", "Priority", "dns_config", "monitor_config", "tags" ] }, "azurerm_user_assigned_identity": { "full_properties": { "location": { "description": "The location/region where the user assigned identity is", "required": true }, "name": { "description": "The name of the user assigned identity. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/user_assigned_identity.html", "properties": [ "name", "resource_group_name", "location", "tags" ] }, "azurerm_virtual_machine": { "full_properties": { "location": { "description": "Specifies the Azure Region where the Virtual Machine exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the Virtual Machine. Changing this forces a new resource to be created.", "required": true }, "network_interface_ids": { "description": "A list of Network Interface ID's which should be associated with the Virtual Machine.", "required": true }, "os_profile_linux_config": { "description": "A os_profile_linux_config block.", "required": false }, "os_profile_windows_config": { "description": "A os_profile_windows_config block.", "required": false }, "resource_group_name": { "description": "Specifies the name of the Resource Group in which the Virtual Machine should exist. Changing this forces a new resource to be created.", "required": true }, "vm_size": { "description": "Specifies the size of the Virtual Machine.", "required": true } }, "path": "/docs/providers/azurerm/r/virtual_machine.html", "properties": [ "name", "resource_group_name", "location", "network_interface_ids", "os_profile_linux_config", "os_profile_windows_config", "vm_size" ] }, "azurerm_virtual_machine_data_disk_attachment": { "full_properties": { "caching": { "description": "Specifies the caching requirements for this Data Disk. Possible values include None, ReadOnly and ReadWrite.", "required": true }, "create_option": { "description": "The Create Option of the Data Disk, such as Empty or Attach. Defaults to Attach. Changing this forces a new resource to be created.", "required": false }, "lun": { "description": "The Logical Unit Number of the Data Disk, which needs to be unique within the Virtual Machine. Changing this forces a new resource to be created.", "required": true }, "managed_disk_id": { "description": "The ID of an existing Managed Disk which should be attached. Changing this forces a new resource to be created.", "required": true }, "virtual_machine_id": { "description": "The ID of the Virtual Machine to which the Data Disk should be attached. Changing this forces a new resource to be created.", "required": true }, "write_accelerator_enabled": { "description": "Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.", "required": false } }, "path": "/docs/providers/azurerm/r/virtual_machine_data_disk_attachment.html", "properties": [ "virtual_machine_id", "managed_disk_id", "lun", "caching", "create_option", "write_accelerator_enabled" ] }, "azurerm_virtual_machine_extension": { "full_properties": { "location": { "description": "The location where the extension is created. Changing", "required": true }, "name": { "description": "The name of the virtual machine extension peering. Changing", "required": true }, "publisher": { "description": "The publisher of the extension, available publishers", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "type": { "description": "The type of extension, available types for a publisher can", "required": true }, "virtual_machine_name": { "description": "The name of the virtual machine. Changing", "required": true } }, "path": "/docs/providers/azurerm/r/virtual_machine_extension.html", "properties": [ "name", "location", "resource_group_name", "virtual_machine_name", "publisher", "type" ] }, "azurerm_virtual_machine_scale_set": { "full_properties": { "location": { "description": "Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.", "required": true }, "name": { "description": "Specifies the name of the virtual machine scale set resource. Changing this forces a new resource to be created.", "required": true }, "network_profile": { "description": "A collection of network profile block as documented below.", "required": true }, "os_profile": { "description": "A Virtual Machine OS Profile block as documented below.", "required": true }, "os_profile_linux_config": { "description": "A Linux config block as documented below.", "required": false }, "os_profile_windows_config": { "description": "A Windows config block as documented below.", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to create the virtual machine scale set. Changing this forces a new resource to be created.", "required": true }, "sku": { "description": "A sku block as documented below.", "required": true }, "storage_profile_os_disk": { "description": "A storage profile os disk block as documented below", "required": true }, "upgrade_policy_mode": { "description": "Specifies the mode of an upgrade to virtual machines in the scale set. Possible values, Rolling, Manual, or Automatic. When choosing Rolling, you will need to set a health probe.", "required": true } }, "path": "/docs/providers/azurerm/r/virtual_machine_scale_set.html", "properties": [ "name", "resource_group_name", "location", "network_profile", "os_profile", "os_profile_windows_config", "os_profile_linux_config", "sku", "storage_profile_os_disk", "upgrade_policy_mode" ] }, "azurerm_virtual_network": { "full_properties": { "address_space": { "description": "The address space that is used the virtual", "required": true }, "dns_servers": { "description": "List of IP addresses of DNS servers", "required": false }, "location": { "description": "The location/region where the virtual network is", "required": true }, "name": { "description": "The name of the virtual network. Changing this forces a", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "subnet": { "description": "Can be specified multiple times to define multiple", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false } }, "path": "/docs/providers/azurerm/r/virtual_network.html", "properties": [ "name", "resource_group_name", "address_space", "location", "dns_servers", "subnet", "tags" ] }, "azurerm_virtual_network_gateway": { "full_properties": { "active_active": { "description": "If true, an active-active Virtual Network Gateway", "required": false }, "default_local_network_gateway_id": { "description": "The ID of the local network gateway", "required": false }, "enable_bgp": { "description": "If true, BGP (Border Gateway Protocol) will be enabled", "required": false }, "ip_configuration": { "description": "One or two ip_configuration blocks documented below.", "required": true }, "location": { "description": "The location/region where the Virtual Network Gateway is", "required": true }, "name": { "description": "The name of the Virtual Network Gateway. Changing the name", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "sku": { "description": "Configuration of the size and capacity of the virtual network", "required": true }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "type": { "description": "The type of the Virtual Network Gateway. Valid options are", "required": true }, "vpn_client_configuration": { "description": "A vpn_client_configuration block which", "required": false }, "vpn_type": { "description": "The routing type of the Virtual Network Gateway. Valid", "required": false } }, "path": "/docs/providers/azurerm/r/virtual_network_gateway.html", "properties": [ "name", "resource_group_name", "location", "type", "vpn_type", "enable_bgp", "active_active", "default_local_network_gateway_id", "sku", "ip_configuration", "vpn_client_configuration", "tags" ] }, "azurerm_virtual_network_gateway_connection": { "full_properties": { "authorization_key": { "description": "The authorization key associated with the", "required": false }, "enable_bgp": { "description": "If true, BGP (Border Gateway Protocol) is enabled", "required": false }, "express_route_circuit_id": { "description": "The ID of the Express Route Circuit", "required": false }, "ipsec_policy": { "description": "A ipsec_policy block which is documented below.", "required": false }, "local_network_gateway_id": { "description": "The ID of the local network gateway", "required": false }, "location": { "description": "The location/region where the connection is", "required": true }, "name": { "description": "The name of the connection. Changing the name forces a", "required": true }, "peer_virtual_network_gateway_id": { "description": "The ID of the peer virtual", "required": false }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "routing_weight": { "description": "The routing weight. Defaults to 10.", "required": false }, "shared_key": { "description": "The shared IPSec key. A key must be provided if a", "required": false }, "tags": { "description": "A mapping of tags to assign to the resource.", "required": false }, "type": { "description": "The type of connection. Valid options are IPsec", "required": true }, "use_policy_based_traffic_selectors": { "description": "If true, policy-based traffic", "required": false }, "virtual_network_gateway_id": { "description": "The ID of the Virtual Network Gateway", "required": true } }, "path": "/docs/providers/azurerm/r/virtual_network_gateway_connection.html", "properties": [ "name", "resource_group_name", "location", "type", "virtual_network_gateway_id", "authorization_key", "express_route_circuit_id", "peer_virtual_network_gateway_id", "local_network_gateway_id", "routing_weight", "shared_key", "enable_bgp", "use_policy_based_traffic_selectors", "ipsec_policy", "tags" ] }, "azurerm_virtual_network_peering": { "full_properties": { "allow_forwarded_traffic": { "description": "Controls if forwarded traffic from VMs", "required": false }, "allow_gateway_transit": { "description": "Controls gatewayLinks can be used in the", "required": false }, "allow_virtual_network_access": { "description": "Controls if the VMs in the remote", "required": false }, "name": { "description": "The name of the virtual network peering. Changing this", "required": true }, "remote_virtual_network_id": { "description": "The full Azure resource ID of the", "required": true }, "resource_group_name": { "description": "The name of the resource group in which to", "required": true }, "use_remote_gateways": { "description": "Controls if remote gateways can be used on", "required": false }, "virtual_network_name": { "description": "The name of the virtual network. Changing", "required": true } }, "path": "/docs/providers/azurerm/r/virtual_network_peering.html", "properties": [ "name", "virtual_network_name", "remote_virtual_network_id", "resource_group_name", "allow_virtual_network_access", "allow_forwarded_traffic", "allow_gateway_transit", "use_remote_gateways" ] } }