Azure Mgmt Weightsandbiases Dotnet

1---
2name: azure-mgmt-weightsandbiases-dotnet
3description: |
4  Azure Weights & Biases SDK for .NET. ML experiment tracking and model management via Azure Marketplace. Use for creating W&B instances, managing SSO, marketplace integration, and ML observability. Triggers: "Weights and Biases", "W&B", "WeightsAndBiases", "ML experiment tracking", "model registry", "experiment management", "wandb".
5package: Azure.ResourceManager.WeightsAndBiases
6---
7 
8# Azure.ResourceManager.WeightsAndBiases (.NET)
9 
10Azure Resource Manager SDK for deploying and managing Weights & Biases ML experiment tracking instances via Azure Marketplace.
11 
12## Installation
13 
14```bash
15dotnet add package Azure.ResourceManager.WeightsAndBiases --prerelease
16dotnet add package Azure.Identity
17```
18 
19**Current Version**: v1.0.0-beta.1 (preview)  
20**API Version**: 2024-09-18-preview
21 
22## Environment Variables
23 
24```bash
25AZURE_SUBSCRIPTION_ID=<your-subscription-id>
26AZURE_RESOURCE_GROUP=<your-resource-group>
27AZURE_WANDB_INSTANCE_NAME=<your-wandb-instance>
28```
29 
30## Authentication
31 
32```csharp
33using Azure.Identity;
34using Azure.ResourceManager;
35using Azure.ResourceManager.WeightsAndBiases;
36 
37ArmClient client = new ArmClient(new DefaultAzureCredential());
38```
39 
40## Resource Hierarchy
41 
42```
43Subscription
44└── ResourceGroup
45    └── WeightsAndBiasesInstance    # W&B deployment from Azure Marketplace
46        ├── Properties
47        │   ├── Marketplace          # Offer details, plan, publisher
48        │   ├── User                 # Admin user info
49        │   ├── PartnerProperties    # W&B-specific config (region, subdomain)
50        │   └── SingleSignOnPropertiesV2  # Entra ID SSO configuration
51        └── Identity                 # Managed identity (optional)
52```
53 
54## Core Workflows
55 
56### 1. Create Weights & Biases Instance
57 
58```csharp
59using Azure.ResourceManager.WeightsAndBiases;
60using Azure.ResourceManager.WeightsAndBiases.Models;
61 
62ResourceGroupResource resourceGroup = await client
63    .GetDefaultSubscriptionAsync()
64    .Result
65    .GetResourceGroupAsync("my-resource-group");
66 
67WeightsAndBiasesInstanceCollection instances = resourceGroup.GetWeightsAndBiasesInstances();
68 
69WeightsAndBiasesInstanceData data = new WeightsAndBiasesInstanceData(AzureLocation.EastUS)
70{
71    Properties = new WeightsAndBiasesInstanceProperties
72    {
73        // Marketplace configuration
74        Marketplace = new WeightsAndBiasesMarketplaceDetails
75        {
76            SubscriptionId = "<marketplace-subscription-id>",
77            OfferDetails = new WeightsAndBiasesOfferDetails
78            {
79                PublisherId = "wandb",
80                OfferId = "wandb-pay-as-you-go",
81                PlanId = "wandb-payg",
82                PlanName = "Pay As You Go",
83                TermId = "monthly",
84                TermUnit = "P1M"
85            }
86        },
87        // Admin user
88        User = new WeightsAndBiasesUserDetails
89        {
90            FirstName = "Admin",
91            LastName = "User",
92            EmailAddress = "admin@example.com",
93            Upn = "admin@example.com"
94        },
95        // W&B-specific configuration
96        PartnerProperties = new WeightsAndBiasesPartnerProperties
97        {
98            Region = WeightsAndBiasesRegion.EastUS,
99            Subdomain = "my-company-wandb"
100        }
101    },
102    // Optional: Enable managed identity
103    Identity = new ManagedServiceIdentity(ManagedServiceIdentityType.SystemAssigned)
104};
105 
106ArmOperation<WeightsAndBiasesInstanceResource> operation = await instances
107    .CreateOrUpdateAsync(WaitUntil.Completed, "my-wandb-instance", data);
108 
109WeightsAndBiasesInstanceResource instance = operation.Value;
110 
111Console.WriteLine($"W&B Instance created: {instance.Data.Name}");
112Console.WriteLine($"Provisioning state: {instance.Data.Properties.ProvisioningState}");
113```
114 
115### 2. Get Existing Instance
116 
117```csharp
118WeightsAndBiasesInstanceResource instance = await resourceGroup
119    .GetWeightsAndBiasesInstanceAsync("my-wandb-instance");
120 
121Console.WriteLine($"Instance: {instance.Data.Name}");
122Console.WriteLine($"Location: {instance.Data.Location}");
123Console.WriteLine($"State: {instance.Data.Properties.ProvisioningState}");
124 
125if (instance.Data.Properties.PartnerProperties != null)
126{
127    Console.WriteLine($"Region: {instance.Data.Properties.PartnerProperties.Region}");
128    Console.WriteLine($"Subdomain: {instance.Data.Properties.PartnerProperties.Subdomain}");
129}
130```
131 
132### 3. List All Instances
133 
134```csharp
135// List in resource group
136await foreach (WeightsAndBiasesInstanceResource instance in 
137    resourceGroup.GetWeightsAndBiasesInstances())
138{
139    Console.WriteLine($"Instance: {instance.Data.Name}");
140    Console.WriteLine($"  Location: {instance.Data.Location}");
141    Console.WriteLine($"  State: {instance.Data.Properties.ProvisioningState}");
142}
143 
144// List in subscription
145SubscriptionResource subscription = await client.GetDefaultSubscriptionAsync();
146await foreach (WeightsAndBiasesInstanceResource instance in 
147    subscription.GetWeightsAndBiasesInstancesAsync())
148{
149    Console.WriteLine($"{instance.Data.Name} in {instance.Id.ResourceGroupName}");
150}
151```
152 
153### 4. Configure Single Sign-On (SSO)
154 
155```csharp
156WeightsAndBiasesInstanceResource instance = await resourceGroup
157    .GetWeightsAndBiasesInstanceAsync("my-wandb-instance");
158 
159// Update with SSO configuration
160WeightsAndBiasesInstanceData updateData = instance.Data;
161 
162updateData.Properties.SingleSignOnPropertiesV2 = new WeightsAndBiasSingleSignOnPropertiesV2
163{
164    Type = WeightsAndBiasSingleSignOnType.Saml,
165    State = WeightsAndBiasSingleSignOnState.Enable,
166    EnterpriseAppId = "<entra-app-id>",
167    AadDomains = { "example.com", "contoso.com" }
168};
169 
170ArmOperation<WeightsAndBiasesInstanceResource> operation = await resourceGroup
171    .GetWeightsAndBiasesInstances()
172    .CreateOrUpdateAsync(WaitUntil.Completed, "my-wandb-instance", updateData);
173```
174 
175### 5. Update Instance
176 
177```csharp
178WeightsAndBiasesInstanceResource instance = await resourceGroup
179    .GetWeightsAndBiasesInstanceAsync("my-wandb-instance");
180 
181// Update tags
182WeightsAndBiasesInstancePatch patch = new WeightsAndBiasesInstancePatch
183{
184    Tags =
185    {
186        { "environment", "production" },
187        { "team", "ml-platform" },
188        { "costCenter", "CC-ML-001" }
189    }
190};
191 
192instance = await instance.UpdateAsync(patch);
193Console.WriteLine($"Updated instance: {instance.Data.Name}");
194```
195 
196### 6. Delete Instance
197 
198```csharp
199WeightsAndBiasesInstanceResource instance = await resourceGroup
200    .GetWeightsAndBiasesInstanceAsync("my-wandb-instance");
201 
202await instance.DeleteAsync(WaitUntil.Completed);
203Console.WriteLine("Instance deleted");
204```
205 
206### 7. Check Resource Name Availability
207 
208```csharp
209// Check if name is available before creating
210// (Implement via direct ARM call if SDK doesn't expose this)
211try
212{
213    await resourceGroup.GetWeightsAndBiasesInstanceAsync("desired-name");
214    Console.WriteLine("Name is already taken");
215}
216catch (RequestFailedException ex) when (ex.Status == 404)
217{
218    Console.WriteLine("Name is available");
219}
220```
221 
222## Key Types Reference
223 
224| Type | Purpose |
225|------|---------|
226| `WeightsAndBiasesInstanceResource` | W&B instance resource |
227| `WeightsAndBiasesInstanceData` | Instance configuration data |
228| `WeightsAndBiasesInstanceCollection` | Collection of instances |
229| `WeightsAndBiasesInstanceProperties` | Instance properties |
230| `WeightsAndBiasesMarketplaceDetails` | Marketplace subscription info |
231| `WeightsAndBiasesOfferDetails` | Marketplace offer details |
232| `WeightsAndBiasesUserDetails` | Admin user information |
233| `WeightsAndBiasesPartnerProperties` | W&B-specific configuration |
234| `WeightsAndBiasSingleSignOnPropertiesV2` | SSO configuration |
235| `WeightsAndBiasesInstancePatch` | Patch for updates |
236| `WeightsAndBiasesRegion` | Supported regions enum |
237 
238## Available Regions
239 
240| Region Enum | Azure Region |
241|-------------|--------------|
242| `WeightsAndBiasesRegion.EastUS` | East US |
243| `WeightsAndBiasesRegion.CentralUS` | Central US |
244| `WeightsAndBiasesRegion.WestUS` | West US |
245| `WeightsAndBiasesRegion.WestEurope` | West Europe |
246| `WeightsAndBiasesRegion.JapanEast` | Japan East |
247| `WeightsAndBiasesRegion.KoreaCentral` | Korea Central |
248 
249## Marketplace Offer Details
250 
251For Azure Marketplace integration:
252 
253| Property | Value |
254|----------|-------|
255| Publisher ID | `wandb` |
256| Offer ID | `wandb-pay-as-you-go` |
257| Plan ID | `wandb-payg` (Pay As You Go) |
258 
259## Best Practices
260 
2611. **Use DefaultAzureCredential** — Supports multiple auth methods automatically
2622. **Enable managed identity** — For secure access to other Azure resources
2633. **Configure SSO** — Enable Entra ID SSO for enterprise security
2644. **Tag resources** — Use tags for cost tracking and organization
2655. **Check provisioning state** — Wait for `Succeeded` before using instance
2666. **Use appropriate region** — Choose region closest to your compute
2677. **Monitor with Azure** — Use Azure Monitor for resource health
268 
269## Error Handling
270 
271```csharp
272using Azure;
273 
274try
275{
276    ArmOperation<WeightsAndBiasesInstanceResource> operation = await instances
277        .CreateOrUpdateAsync(WaitUntil.Completed, "my-wandb", data);
278}
279catch (RequestFailedException ex) when (ex.Status == 409)
280{
281    Console.WriteLine("Instance already exists or name conflict");
282}
283catch (RequestFailedException ex) when (ex.Status == 400)
284{
285    Console.WriteLine($"Invalid configuration: {ex.Message}");
286}
287catch (RequestFailedException ex)
288{
289    Console.WriteLine($"Azure error: {ex.Status} - {ex.Message}");
290}
291```
292 
293## Integration with W&B SDK
294 
295After creating the Azure resource, use the W&B Python SDK for experiment tracking:
296 
297```python
298# Install: pip install wandb
299import wandb
300 
301# Login with your W&B API key from the Azure-deployed instance
302wandb.login(host="https://my-company-wandb.wandb.ai")
303 
304# Initialize a run
305run = wandb.init(project="my-ml-project")
306 
307# Log metrics
308wandb.log({"accuracy": 0.95, "loss": 0.05})
309 
310# Finish run
311run.finish()
312```
313 
314## Related SDKs
315 
316| SDK | Purpose | Install |
317|-----|---------|---------|
318| `Azure.ResourceManager.WeightsAndBiases` | W&B instance management (this SDK) | `dotnet add package Azure.ResourceManager.WeightsAndBiases --prerelease` |
319| `Azure.ResourceManager.MachineLearning` | Azure ML workspaces | `dotnet add package Azure.ResourceManager.MachineLearning` |
320 
321## Reference Links
322 
323| Resource | URL |
324|----------|-----|
325| NuGet Package | https://www.nuget.org/packages/Azure.ResourceManager.WeightsAndBiases |
326| W&B Documentation | https://docs.wandb.ai/ |
327| Azure Marketplace | https://azuremarketplace.microsoft.com/marketplace/apps/wandb.wandb-pay-as-you-go |
328| GitHub Source | https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/weightsandbiases |
329