Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various improvements from feedback from .NET SDK review #31198

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+26 −4
Open

Various improvements from feedback from .NET SDK review #31198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
628f223
Various improvements from feedback from .NET SDK review
gerrytan Oct 24, 2024
5aac6ad
@@clientName for ExportResult.skippedResources
gerrytan Oct 24, 2024
41aa434
Revert spec model change, implement as client.tsp override instead
gerrytan Oct 24, 2024
d16ae26
Rename ExportResource in csharp
gerrytan Oct 24, 2024
6843a6f
Added Terraform suffix to other Export... model names
gerrytan Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions specification/terraform/Microsoft.AzureTerraform.Management/client.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@ import "@azure-tools/typespec-client-generator-core";
import "./main.tsp";

using Azure.ClientGenerator.Core;
using Azure.ResourceManager;
using Microsoft.AzureTerraform;

@@clientName(BaseExportModel, "CommonExportProperties", "csharp");
// Name ending with "Resource" is reserved for ARM resource in .NET SDK
// Refer to https://github.com/Azure/azure-sdk-for-net/blob/4dacd22df0cf904b11cb3b1389aa566c552fdd0f/common/ManagementTestShared/Redesign/InheritanceCheckTests.cs#L23
@@clientName(ExportQuery, "ExportQueryTerraform", "csharp");
@@clientName(ExportResource, "ExportResourceTerraform", "csharp");
@@clientName(ExportResourceGroup, "ExportResourceGroupTerraform", "csharp");
@@clientName(ExportResult, "TerraformExportResult", "csharp");
@@clientName(ExportResult.skippedResources, "SkippedResourceIds", "csharp");
@@clientName(ResourceProvisioningState,
"TerraformResourceProvisioningState",
"csharp"
);
@@clientName(targetProvider, "TargetTerraformProvider", "csharp");
@@clientName(targetProvider.azapi, "AzApi", "csharp");
@@clientName(targetProvider.azurerm, "AzureRM", "csharp");
@@clientName(Terraform.exportTerraform, "ExportTerraform", "csharp");
6 changes: 4 additions & 2 deletions specification/terraform/Microsoft.AzureTerraform.Management/models.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import "@typespec/rest";
import "@typespec/http";
import "@azure-tools/typespec-azure-core";
import "@azure-tools/typespec-azure-resource-manager";

using TypeSpec.Rest;
using TypeSpec.Http;
using Azure.Core;
using Azure.ResourceManager;
using Azure.ResourceManager.Foundations;
using OpenAPI;
Expand Down Expand Up @@ -65,7 +67,7 @@ model ExportQuery extends BaseExportModel {
@doc("Export parameter for individual resources.")
model ExportResource extends BaseExportModel {
@doc("The id of the resource to be exported")
resourceIds: string[];
resourceIds: armResourceIdentifier[];

@doc("The Terraform resource name. Only works when `resourceIds` contains only one item.")
resourceName?: string = "res-0";
Expand Down Expand Up @@ -101,7 +103,7 @@ model ExportResult {
configuration?: string;

@doc("A list of Azure resources which are not exported to Terraform due to there is no corresponding resources in Terraform")
skippedResources?: string[];
skippedResources?: armResourceIdentifier[];

@doc("A list of errors derived during exporting each resource")
@extension("x-ms-identifiers", [])
Expand Down
8 changes: 6 additions & 2 deletions ...erraform/resource-manager/Microsoft.AzureTerraform/preview/2023-07-01-preview/export.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,9 @@
"type": "array",
"description": "The id of the resource to be exported",
"items": {
"type": "string"
"type": "string",
"format": "arm-id",
"description": "A type definition that refers the id to an Azure Resource Manager resource."
}
},
"resourceName": {
Expand Down Expand Up @@ -337,7 +339,9 @@
"type": "array",
"description": "A list of Azure resources which are not exported to Terraform due to there is no corresponding resources in Terraform",
"items": {
"type": "string"
"type": "string",
"format": "arm-id",
"description": "A type definition that refers the id to an Azure Resource Manager resource."
}
},
"errors": {
Expand Down