[Knowledge] deployment-guide: ## Advisory Notes — Stage 1: Managed Identity - **[Stabilit...

Open
#75 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
azure, csharp, node.js, python, terraform

Research direction

Start by reviewing the Build advisory review context and create knowledge/services/deployment-guide.md. Cover the eight required sections, including Terraform and Bicep patterns, application examples in Python, C#, and Node.js, and the managed identity stability and security notes; the work is done when every listed section is present and addresses the requested Stage 1 guidance.

Written by the indexing model from the issue text.

Description

Knowledge Contribution

Type: New service
File: knowledge/services/deployment-guide.md
Status: NEW FILE — this knowledge file does not exist yet and must be created

Context

Advisory Notes — Stage 1: Managed Identity

  • [Stability] The identity module uses API version 2023-07-31-preview; preview APIs may introduce breaking changes or be retired — consider pinning to the GA version 2023-01-31 for production deployments.

  • [Security] Deployment outputs (client ID, principal ID) are written to a local JSON file with no access controls; in CI/CD pipelines, prefer storing these in a Key Vault or using deployment output references directly to avoid credent

Rationale

Advisory Notes — Stage 1: Managed Identity

  • [Stability] The identity module uses API version 2023-07-31-preview; preview APIs may introduce breaking changes or be retired — consider pinning to the GA version 2023-01-31 for production deployments.

  • [Security] Deployment outputs (client ID, principal ID) are written to a local JSON file with no access controls; in CI/CD pipelines, prefer storing these in a Key Vault or using deployment output references directly to avoid credent

Content to Add
## Advisory Notes — Stage 1: Managed Identity

- **[Stability]** The identity module uses API version `2023-07-31-preview`; preview APIs may introduce breaking changes or be retired — consider pinning
Source

Build advisory review

Required Knowledge File Sections

The new knowledge file MUST include ALL of these sections:

  1. Description (one-line summary)
  2. When to Use (scenarios and selection criteria)
  3. POC Defaults (default SKU, tier, configuration)
  4. Terraform Patterns (azapi_resource with RBAC)
  5. Bicep Patterns (ARM template resources)
  6. Application Code (Python, C#, Node.js — where applicable)
  7. Common Pitfalls (deployment failures, misconfigurations)
  8. Production Backlog Items (what changes for production)
Dominant language
Python
Stars
41
Forks
10
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/az-prototype

All issues in Azure/az-prototype

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.