Azure / Azure/az-prototype

[Knowledge] private-endpoint-kv: ## Advisory Notes — Stage 1: Managed Identity - **[Stabilit...

Open
#69 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
41
Forks
10
PR merge metrics
No merged PRs in 30d

Description

## Knowledge Contribution

**Type:** New service
**File:** `knowledge/services/private-endpoint-kv.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)

Contributor guide

No contributing guide indexed for this repository

Research direction

Create knowledge/services/private-endpoint-kv.md and begin by reviewing the Build advisory review notes, especially the managed identity API version and deployment-output security guidance. Cover all eight required sections, including Terraform azapi_resource with RBAC, Bicep resources, and applicable Python, C#, and Node.js patterns; the work is done when the new service knowledge file is complete and addresses each listed requirement.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, python, terraform
Domain
cloud, documentation, security
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.