Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…iliency-Library-v2 into AppInsights-APRL-38373
  • Loading branch information
Soniya Mittal committed Dec 19, 2024
2 parents 042d851 + 93584ea commit 1459b08
Show file tree
Hide file tree
Showing 32 changed files with 1,809 additions and 1,307 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ jobs:
# Upload the results to GitHub's code scanning dashboard (optional).
# Commenting out will disable upload of results to your repo's Code Scanning dashboard
- name: "Upload to code-scanning"
uses: github/codeql-action/upload-sarif@aa578102511db1f4524ed59b8cc2bae4f6e88195 # v3.27.6
uses: github/codeql-action/upload-sarif@df409f7d9260372bd5f19e5b04e83cb3c43714ae # v3.27.9
with:
sarif_file: results.sarif
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// under-development
37 changes: 36 additions & 1 deletion azure-resources/ApiManagement/service/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

- description: Azure API Management platform version should be stv2
aprlGuid: e35cf148-8eee-49d1-a1c9-956160f99e0b
recommendationTypeId: e5f60ef8-3fcc-4fb5-bee7-7aaeb44c1509
recommendationTypeId: null
recommendationControl: HighAvailability
recommendationImpact: High
recommendationResourceType: Microsoft.ApiManagement/service
Expand Down Expand Up @@ -71,3 +71,38 @@
learnMoreLink:
- name: Setting up auto-scale for Azure API Management
url: "https://learn.microsoft.com/azure/api-management/api-management-howto-autoscale"

- description: Configure API management service in multiple Azure regions
aprlGuid: af4f88cb-35e8-4371-b29e-3a32b1d2f40a
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: High
recommendationResourceType: Microsoft.ApiManagement/service
recommendationMetadataState: Active
longDescription: |
API Management multi-region deployment will help to reduce request latency perceived by geographically distributed API consumers and improves service availability if one region goes offline.
potentialBenefits: Improve latency and provides business continuity
pgVerified: true
automationAvailable: false
tags: null
learnMoreLink:
- name: Deploy API Management instance to multiple Azure regions
url: "https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-deploy-multi-region"
- description: Enable caching to improve performance in Azure API Management
aprlGuid: badd9a1f-222a-498d-ab84-1f14892b1c1b
recommendationTypeId: null
recommendationControl: HighAvailability
recommendationImpact: Medium
recommendationResourceType: Microsoft.ApiManagement/service
recommendationMetadataState: Active
longDescription: |
Response caching can significantly reduce latency for API callers and backend load for API providers.
potentialBenefits: Ensures service continuity and high availability
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Add caching to improve performance in Azure API Management
url: "https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-cache"
- name: Use an external cache in Azure API Management
url: "https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-cache-external"
2 changes: 1 addition & 1 deletion azure-resources/Cdn/profiles/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

- description: Use the latest API version and SDK version
aprlGuid: 52bc9a7b-23c8-bc4c-9d2a-7bc43b50104a
recommendationTypeId: e607041e-3194-42ad-9994-b6ea5ec12f5e
recommendationTypeId: null
recommendationControl: Scalability
recommendationImpact: Medium
recommendationResourceType: Microsoft.Cdn/profiles
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
32 changes: 32 additions & 0 deletions azure-resources/CognitiveServices/accounts/recommendations.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
- description: Ensure AOAI models are deployed using Global deployment
aprlGuid: 081fc8a4-b2d9-405b-b351-334e621016f5
recommendationTypeId: null
recommendationControl: HighAvailability
recommendationImpact: High
recommendationResourceType: Microsoft.CognitiveServices/Accounts
recommendationMetadataState: Active
longDescription: Global deployments leverage Azure's global infrastructure to route customer traffic to the best available data center for the customer’s inference requests. This ensures highest initial throughput limits and best model availability while still providing our uptime SLA and low latency.
potentialBenefits: Low latency, best model availability, business continuity
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Learn More
url: "https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/deployment-types#global-provisioned"

- description: Deploy a PAYG instance of the model with provisioned throughput to manage overflow effectively
aprlGuid: 0c193899-da60-4a52-b4a0-77d75ac8c5c5
recommendationTypeId: null
Expand Down Expand Up @@ -49,3 +65,19 @@
- name: Learn More
url: "https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/deployment-types#data-zone-standard"

- description: Deploy AOAI Service in multiple regions using Standard and/or Provisioned deployments
aprlGuid: 61187af4-7d36-4b48-b16e-de78bef143a0
recommendationTypeId: null
recommendationControl: HighAvailability
recommendationImpact: High
recommendationResourceType: Microsoft.CognitiveServices/Accounts
recommendationMetadataState: Active
longDescription: |
If your service needs to always be available, design AOAI Service to either failover into another region or split the workload between two or more regions. Applications requiring high degrees of resiliency should consider this to strengthen their model infrastructure.
potentialBenefits: Ensures business continuity during regional outages.
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Learn More
url: "https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/business-continuity-disaster-recovery"
4 changes: 2 additions & 2 deletions azure-resources/Compute/virtualMachines/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@

- description: Enable Accelerated Networking (AccelNet)
aprlGuid: dfedbeb1-1519-fc47-86a5-52f96cf07105
recommendationTypeId: 3a3c1a2a-8597-4d3a-981a-0a24a0ee9de4
recommendationTypeId: null
recommendationControl: Scalability
recommendationImpact: Medium
recommendationResourceType: Microsoft.Compute/virtualMachines
Expand Down Expand Up @@ -214,7 +214,7 @@

- description: IP Forwarding should only be enabled for Network Virtual Appliances
aprlGuid: 41a22a5e-5e08-9647-92d0-2ffe9ef1bdad
recommendationTypeId: c3b51c94-588b-426b-a892-24696f9e54cc
recommendationTypeId: null
recommendationControl: Security
recommendationImpact: Medium
recommendationResourceType: Microsoft.Compute/virtualMachines
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@

- description: Configure continuous backup mode
aprlGuid: e544520b-8505-7841-9e77-1f1974ee86ec
recommendationTypeId: 52fef986-5897-4359-8b92-0f22749f0d73
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: High
recommendationResourceType: Microsoft.DocumentDB/databaseAccounts
Expand Down
6 changes: 3 additions & 3 deletions azure-resources/KeyVault/vaults/recommendations.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- description: Key vaults should have soft delete enabled
aprlGuid: 1cca00d2-d9ab-8e42-a788-5d40f49405cb
recommendationTypeId: 78211c00-15a9-336e-17c4-0b48613dadf4
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: High
recommendationResourceType: Microsoft.KeyVault/vaults
Expand All @@ -17,7 +17,7 @@

- description: Key vaults should have purge protection enabled
aprlGuid: 70fcfe6d-00e9-5544-a63a-fff42b9f2edb
recommendationTypeId: 4ed62ae4-5072-f9e7-8d94-51c76c48159a
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: Medium
recommendationResourceType: Microsoft.KeyVault/vaults
Expand Down Expand Up @@ -68,7 +68,7 @@

- description: Diagnostic logs in Key Vault should be enabled
aprlGuid: 1dc0821d-4f14-7644-bab4-ba208ff5f7fa
recommendationTypeId: 88bbc99c-e5af-ddd7-6105-6150b2bfa519
recommendationTypeId: null
recommendationControl: MonitoringAndAlerting
recommendationImpact: Low
recommendationResourceType: Microsoft.KeyVault/vaults
Expand Down
2 changes: 1 addition & 1 deletion azure-resources/MachineLearningServices/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: MachineLearningServices
geekdocCollapseSection: true
geekdocHidden: true
geekdocHidden: false
---
7 changes: 7 additions & 0 deletions azure-resources/MachineLearningServices/registries/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: registries
geekdocCollapseSection: true
geekdocHidden: false
---

{{< azure-resources-recommendationlist name="azure-resources-recommendationlist" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
- description: Create the Azure machine learning registry in multiple regions
aprlGuid: 611c7c96-ac55-4ddf-909e-9eb70fd048b7
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: High
recommendationResourceType: Microsoft.MachineLearningServices/registries
recommendationMetadataState: Active
longDescription: |
Azure Machine Learning registries enables to create and use assets (models, env, components, and datasets) in different workspaces. Registries support multi-region replication for low latency access to assets, allowing to use them in workspaces located in different Azure regions.
potentialBenefits: Improves performance and reliability
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Manage Azure Machine Learning registries
url: "https://learn.microsoft.com/en-us/azure/machine-learning/how-to-manage-registries?view=azureml-api-2&tabs=cli"
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: workspaces
geekdocCollapseSection: true
geekdocHidden: true
geekdocHidden: false
---

{{< azure-resources-recommendationlist name="azure-resources-recommendationlist" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
// cannot-be-validated-with-arg
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
- description: Plan for a multi-regional deployment of Azure Machine Learning and associated resources
aprlGuid: a86ed26a-59d9-47bd-b440-6bc71b843978
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: High
recommendationResourceType: Microsoft.MachineLearningServices/workspaces
recommendationMetadataState: Active
longDescription: |
Ensure you have a recovery strategy defined. Check regional availability and paired regions. Machine Learning doesn't have auto failover. Therefore, you must design a strategy that encompasses the workspace and all its dependencies, such as Key Vault, Azure Storage, and Container Registry.
potentialBenefits: Provides multi-region disaster recovery strategy
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Plan for multi-regional deployment
url: "https://learn.microsoft.com/en-us/azure/machine-learning/how-to-high-availability-machine-learning?view=azureml-api-2"

- description: Deploy Azure Machine learning workspace in secondary region
aprlGuid: 675d249a-9486-45e3-8e89-863f5802782d
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: High
recommendationResourceType: Microsoft.MachineLearningServices/workspaces
recommendationMetadataState: Active
longDescription: |
If your primary workspace is unavailable, switch to the secondary workspace to continue work. Azure Machine Learning doesn't auto-submit jobs to the secondary workspace during an outage. Update your code configuration to point to the new workspace resource.
potentialBenefits: Provides recovery from regional outages
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Failover for business continuity and disaster recovery
url: "https://learn.microsoft.com/en-us/azure/machine-learning/how-to-high-availability-machine-learning?view=azureml-api-2"

- description: Ensure to create Machine Learning Compute resources in secondary region
aprlGuid: 13794a63-8d95-47ce-acbd-5925ede5b208
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: High
recommendationResourceType: Microsoft.MachineLearningServices/workspaces
recommendationMetadataState: Active
longDescription: |
Create compute resources for training a Machine Learning model in selected regions. Ensure both regions have sufficient compute quota for dynamic scaling. Customers must configure HA across zones for attached compute resources like AKS, Azure Databricks, Container Instances.
potentialBenefits: High availability and disaster recovery
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Failover for business continuity and disaster recovery
url: "https://learn.microsoft.com/en-us/azure/machine-learning/how-to-high-availability-machine-learning?view=azureml-api-2"
- name: Compute targets in Azure Machine Learning
url: "https://learn.microsoft.com/en-us/azure/machine-learning/concept-compute-target?view=azureml-api-2"

- description: Selecting regions for BCDR, ensure that both regions offer adequate compute quotas
aprlGuid: 6e4f0fd1-1853-4b94-9736-6d6d239d2694
recommendationTypeId: null
recommendationControl: DisasterRecovery
recommendationImpact: High
recommendationResourceType: Microsoft.MachineLearningServices/workspaces
recommendationMetadataState: Active
longDescription: |
When selecting regions for BCDR, ensure that both regions offer adequate compute quotas to meet your requirements in the same SKU. This ensures that you can failover to the secondary region without any issues.
potentialBenefits: Provide enough compute resources to the secondary region
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Manage resource quotas
url: "https://learn.microsoft.com/en-us/azure/machine-learning/how-to-manage-quotas?view=azureml-api-2"

- description: Choose SKUs with longer terms and avoid those nearing retirement
aprlGuid: 6e2af91f-477d-46a5-b8ce-6cd1b8176550
recommendationTypeId: null
recommendationControl: ServiceUpgradeAndRetirement
recommendationImpact: Medium
recommendationResourceType: Microsoft.MachineLearningServices/workspaces
recommendationMetadataState: Active
longDescription: |
When choosing SKUs, opt for those that support longer terms and steer clear of any SKUs that are nearing retirement. This ensures that you can continue to use the SKU for a longer period of time.
potentialBenefits: supportability, longer term support
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: What are compute targets in Azure Machine Learning
url: "https://learn.microsoft.com/en-us/azure/machine-learning/concept-compute-target?view=azureml-api-2#supported-vm-series-and-sizes"

- description: Avoid NC and NC_Promo series Azure VMs for machine learning quotas; migrate to newer versions
aprlGuid: cf2569bb-1cf2-46ce-8885-d742dc6f4a4c
recommendationTypeId: null
recommendationControl: ServiceUpgradeAndRetirement
recommendationImpact: High
recommendationResourceType: Microsoft.MachineLearningServices/workspaces
recommendationMetadataState: Active
longDescription: |
Avoid selecting NC and NC_Promo series Azure virtual machines for machine learning VM quotas and make sure to migrate to newer versions.
potentialBenefits: Avoid service disruption, longer term support
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: NC sizes series
url: "https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/gpu-accelerated/nc-series?tabs=sizebasic"
- name: Migration Guide for GPU Compute Workloads in Azure
url: "https://learn.microsoft.com/en-us/azure/virtual-machines/n-series-migration"

- description: Make Azure Machine Learning quota requests through the Azure Machine Learning Studio
aprlGuid: 48ea6480-6263-40ba-8937-326d790e63f6
recommendationTypeId: null
recommendationControl: OtherBestPractices
recommendationImpact: High
recommendationResourceType: Microsoft.MachineLearningServices/workspaces
recommendationMetadataState: Active
longDescription: |
Requests for additional Azure Machine Learning quota should be made through the Azure Machine Learning Studio instead of the subscription level in the Azure portal.
potentialBenefits: Scalability,capacity planning
pgVerified: false
automationAvailable: false
tags: null
learnMoreLink:
- name: Manage and increase quotas and limits for resources with Azure Machine Learning
url: "https://learn.microsoft.com/en-us/azure/machine-learning/how-to-manage-quotas?view=azureml-api-2"
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@

- description: Migrate to Application Gateway v2
aprlGuid: 7893f0b3-8622-1d47-beed-4b50a19f7895
recommendationTypeId: 0e19257e-dcef-4d00-8de1-5fe1ae0fd948
recommendationTypeId: null
recommendationControl: Scalability
recommendationImpact: High
recommendationResourceType: Microsoft.Network/applicationGateways
Expand Down Expand Up @@ -158,7 +158,7 @@

- description: Ensure Application Gateway Subnet is using a /24 subnet mask
aprlGuid: 8364fd0a-7c0e-e240-9d95-4bf965aec243
recommendationTypeId: ef4da732-f541-4109-bc0e-465c68b6c7eb
recommendationTypeId: null
recommendationControl: OtherBestPractices
recommendationImpact: High
recommendationResourceType: Microsoft.Network/applicationGateways
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

- description: Migrate from classic alerts to built-in Azure Monitor alerts for Azure Recovery Services Vaults
aprlGuid: 2912472d-0198-4bdc-aa90-37f145790edc
recommendationTypeId: 06578866-1877-41e6-9d22-3ea5122e8048
recommendationTypeId: null
recommendationControl: MonitoringAndAlerting
recommendationImpact: Medium
recommendationResourceType: Microsoft.RecoveryServices/vaults
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

- description: Use premium performance block blob storage for high performance workloads
aprlGuid: 5587ef77-7a05-a74d-9c6e-449547a12f27
recommendationTypeId: c6b94711-f1f5-4e7e-9c89-c17ed4190969
recommendationTypeId: null
recommendationControl: Scalability
recommendationImpact: Medium
recommendationResourceType: Microsoft.Storage/storageAccounts
Expand Down
2 changes: 1 addition & 1 deletion azure-resources/Web/sites/recommendations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@

- description: Deploy to a staging slot
aprlGuid: a1d91661-32d4-430b-b3b6-5adeb0975df7
recommendationTypeId: 1d3b5a51-62d4-4b77-96f6-40ed0a3aa21f
recommendationTypeId: null
recommendationControl: Governance
recommendationImpact: Low
recommendationResourceType: Microsoft.Web/sites
Expand Down
Loading

0 comments on commit 1459b08

Please sign in to comment.