Merge pull request #238939 from spelluru/asavnet0523

Stream Analytics - VNET

Author: Jill Grant

articles/stream-analytics/TOC.yml

@@ -354,7 +354,7 @@
       href: cicd-autoscale.md
   - name: Visual Studio
     items:
-    - name: Migrate ASA projects to VSCode
+    - name: Migrate Stream Analytics projects to VS Code
       href: migrate-to-vscode.md
     - name: Quickstart
       href: stream-analytics-quick-create-vs.md
@@ -436,6 +436,8 @@
       href: app-insights-export-sql-stream-analytics.md
   - name: Scale with ML functions
     href: stream-analytics-scale-with-machine-learning-functions.md
+  - name: Run job in your virtual network
+    href: run-job-in-virtual-network.md
 - name: Stream Analytics Query Language
   items:
     - name: Stream Analytics Query Language overview

articles/stream-analytics/media/run-job-in-virtual-network/networking-page.png

@@ -0,0 +1,126 @@
+---
+title: Run your Stream Analytics in Azure virtual network
+description: This article describes how to run an Azure Stream Analytics job in an Azure virtual network.
+
+ms.service: stream-analytics
+ms.topic: how-to
+ms.date: 05/23/2023
+---
+
+# Run your Azure Stream Analytics job in an Azure Virtual Network (Public preview) 
+This article describes how to run your Azure Stream Analytics (ASA) job in an Azure virtual network. 
+
+## Overview 
+Virtual network (VNet) support enables you to lock down access to Azure Stream Analytics to your virtual network infrastructure. This capability provides you with the benefits of network isolation and can be accomplished by [deploying a containerized instance of your ASA job inside your Virtual Network](../virtual-network/virtual-network-for-azure-services.md). Your VNet injected ASA job can then privately access your resources within the virtual network via: 
+
+- [Private endpoints](../private-link/private-endpoint-overview.md), which connect your VNet injected ASA job to your data sources over private links powered by Azure Private Link.   
+- [Service endpoints](../virtual-network/virtual-network-service-endpoints-overview.md), which connect your data sources to your VNet injected ASA job. 
+- [Service tags](../virtual-network/service-tags-overview.md), which allow or deny traffic to Azure Stream Analytics. 
+
+## Availability 
+Currently, this capability is only available in select regions.  If you're interested in enabling VNet integration in your region, fill out this [form](https://forms.office.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbRzFwASREnlZFvs9gztPNuTdUMU5INk5VT05ETkRBTTdSMk9BQ0w3OEZDQi4u).    
+
+## Requirements for VNet integration support 
+
+- A **General purpose V2 (GPV2) Storage account** is required for VNET injected ASA jobs.   
+    - VNet injected ASA jobs require access to metadata such as checkpoints to be stored in Azure tables for operational purposes.   
+    - If you already have a GPV2 account provisioned with your ASA job, no extra steps are required.   
+    - Users with higher scale jobs with Premium storage are still required to provide a GPV2 storage account.   
+    - If you wish to protect storage accounts from public IP based access, consider configuring it using Managed Identity and Trusted Services as well. 
+    
+        For more information on storage accounts, see [Storage account overview](../storage/common/storage-account-overview.md) and [Create a storage account](../storage/common/storage-account-create.md?tabs=azure-portal.md).  
+- An existing **Azure Virtual Network** or [create one](../virtual-network/quick-create-portal.md). 
+
+    > [!IMPORTANT]
+    > ASA VNET injected jobs use an internal container injection technology provided by Azure networking.  At this time, Azure Networking recommends that all customers set up Azure NAT Gateway for security and reliability.   
+    > 
+    > Azure NAT Gateway is a fully managed and highly resilient Network Address Translation (NAT) service.  Azure NAT Gateway simplifies outbound Internet connectivity for virtual networks.  When configured on a subnet, all outbound connectivity uses the NAT gateway's static public IP addresses.
+
+    :::image type="content" source="./media/run-job-in-virtual-network/vnet-nat.png" alt-text="Diagram showing the architecture of the virtual network.":::
+    
+    To learn about setup and pricing, see [Azure NAT Gateway](../nat-gateway/nat-overview.md). 
+
+## Subnet Requirements 
+Virtual network integration depends on a dedicated subnet. When you create a subnet, the Azure subnet consumes five IPs from the start.  
+
+You must take into consideration the IP range associated with your delegated subnet as you think about future needs required to support your ASA workload. Because subnet size can't be changed after assignment, use a subnet that's large enough to accommodate whatever scale your job(s) might reach. 
+
+The scale operation affects the real, available supported instances for a given subnet size.  
+
+### Considerations for estimating IP ranges 
+
+- Make sure the subnet range doesn't collide with ASA’s subnet range.  Avoid IP range 10.0.0.0 to 10.0.255.255 as it's used by ASA. 
+- Reserve: 
+    - 5 IP addresses for Azure Networking 
+    - 1 IP address is required to facilitate features such as sample data, test connection and metadata discovery for jobs associated with this subnet. 
+    - 2 IP addresses are required for every 6 SU or 1 SU V2 (ASA’s V2 pricing structure is launching July 1, 2023, see [here](https://aka.ms/AzureStreamAnalyticsisLaunchingaNewCompetitivePricingModel) for details)  
+
+When you indicate VNET integration with your Azure Stream Analytics job, Azure portal will automatically delegate the subnet to the ASA service.  Azure portal will undelegate the subnet in the following scenarios: 
+
+- You inform us that VNET integration is no longer needed for the [last job](#last-job) associated with specified subnet via the ASA portal (see ‘how to’ section). 
+- You delete the [last job](#last-job) associated with the specified subnet. 
+
+### Last job 
+Several ASA jobs may utilize the same subnet.  The last job here refers to no other jobs utilizing the specified subnet.  When the last job has been deleted or removed by associated, Azure Stream Analytics releases the subnet as a resource, which was delegated to ASA as a service. Allow several minutes for this action to be completed. 
+
+## Set up VNET integration  
+
+### Azure portal
+1. From the Azure portal, navigate to **Networking** from menu bar and select **Run this job in virtual network**.  This step informs us that your job must work with a VNET: 
+1. Configure the settings as prompted and select **Save**. 
+
+    :::image type="content" source="./media/run-job-in-virtual-network/networking-page.png" alt-text="Screenshot of the Networking page for a Stream Analytics job.":::
+ 
+## VS Code
+
+1. In Visual Studio Code, reference the subnet within your ASA job.  This step tells your job that it must work with a subnet. 
+1. In the `JobConfig.json`, set up your `VirtualNetworkConfiguration` as shown in the following image.
+
+    :::image type="content" source="./media/run-job-in-virtual-network/virtual-network-configuration.png" alt-text="Screenshot of the sample virtual network configuration." lightbox="./media/run-job-in-virtual-network/virtual-network-configuration.png":::
+    
+
+## Set up an associated storage account  
+1. On the **Stream Analytics job** page, select **Storage account settings** under **Configure** on the left menu.
+1. On the **Storage account settings** page, select **Add storage account**.
+1. Follow instructions to configure your storage account settings.
+
+    :::image type="content" source="./media/run-job-in-virtual-network/storage-account-settings.png" alt-text="Screenshot of the Storage account settings page of a Stream Analytics job." :::
+
+    
+> [!IMPORTANT]
+> - To authenticate with connection string, you must disable the storage account firewall settings. 
+> - To authenticate with Managed Identity, you must add your Stream Analytics job to the storage account's access control list with the Storage Blob Data Contributor role. If you do not give your job access, the job will not be able to perform any operations. For more information on how to grant access, see Use Azure RBAC to assign a managed identity access to another resource. 
+
+## Permissions 
+You must have at least the following Role-based access control permissions on the subnet or at a higher level to configure virtual network integration through Azure portal, CLI or when setting the virtualNetworkSubnetId site property directly: 
+
+| Action | Description |
+| ------ | ------------ | 
+| `Microsoft.Network/virtualNetworks/read` | Read the virtual network definition | 
+| `Microsoft.Network/virtualNetworks/subnets/read` | Read a virtual network subnet definition |
+| `Microsoft.Network/virtualNetworks/subnets/join/action` | Joins a virtual network |
+| `Microsoft.Network/virtualNetworks/subnets/write` | Optional.  Required if you need to perform subnet delegation |
+
+
+If the virtual network is in a different subscription than your ASA job, you must ensure that the subscription with the virtual network is registered for the `Microsoft.Web` resource provider. You can explicitly register the provider by following [this documentation](../azure-resource-manager/management/resource-providers-and-types.md#register-resource-provider), but it's automatically registered when creating the job in a subscription. 
+
+## Limitations 
+
+- VNET jobs require a minimum of 1 SU V2 (new pricing model) or 6 SUs (current) 
+- Make sure the subnet range doesn't collide with ASA subnet range (that is, don't use subnet range 10.0.0.0/16). 
+- ASA job(s) and the virtual network must be in the same region. 
+- The delegated subnet can only be used by Azure Stream Analytics. 
+- You can't delete a virtual network when it's integrated with ASA. You must disassociate or remove the last job* on the delegated subnet.  
+- We don't support DNS refreshes currently.  If DNS configurations of your VNET are changed, you must redeploy all ASA jobs in that VNET (subnets will also need to be disassociated from all jobs and reconfigured).  For more information, see [Name resolution for resources in Azure virtual networks](../virtual-network/virtual-networks-name-resolution-for-vms-and-role-instances.md?tabs=redhat) for more information.   
+
+## Access on-premises resources 
+No extra configuration is required for the virtual network integration feature to reach through your virtual network to on-premises resources. You simply need to connect your virtual network to on-premises resources by using ExpressRoute or a site-to-site VPN. 
+
+## Pricing details 
+Outside of basic requirements listed in this document, virtual network integration has no extra charge for use beyond the Azure Stream Analytics pricing charges. 
+
+## Troubleshooting 
+The feature is easy to set up, but that doesn't mean your experience is problem free. If you encounter problems accessing your desired endpoint, contact Microsoft Support. 
+
+> [!NOTE]
+> For direct feedback on this capability, reach out to [[email protected]](mailto:[email protected]).