Update the Nginx Typespec (#36473)

Author: ArthurMa1978

specification/nginx/Nginx.Management/ApiKeys.tsp

@@ -7,7 +7,7 @@ using Rest;
 using Http;
 using Azure.ResourceManager;
 
-namespace NGINX.NGINXPLUS;
+namespace Nginx.NginxPlus;
 
 /**
  * API key resource returned by the service.
@@ -44,7 +44,7 @@ model ApiKeyResponseProperties {
   /**
    * Expiry of the key in UTC date-time format.
    */
-  endDateTime: string;
+  endDateTime?: string;
 }
 
 /**
@@ -61,7 +61,7 @@ model ApiKeyRequestProperties {
   /**
    * Expiry of the key in UTC date-time format.
    */
-  endDateTime: string;
+  endDateTime?: string;
 }
 
 /**

specification/nginx/Nginx.Management/Certificates.tsp

@@ -6,12 +6,16 @@ import "@azure-tools/typespec-azure-resource-manager";
 using Rest;
 using Azure.ResourceManager;
 
-namespace NGINX.NGINXPLUS;
+namespace Nginx.NginxPlus;
 
 /** NginxCertificate resource */
 @parentResource(NginxDeployment)
 model Certificate is ProxyResource<NginxCertificateProperties> {
   ...ResourceNameParameter<Certificate>;
+
+  /** Gets or sets the location. */
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property"
+  location?: string;
 }
 
 /**
@@ -37,7 +41,7 @@ model NginxCertificateProperties {
   /**
    * The Key Vault secret ID. Example: `https://myvault.vault.azure.net/secrets/mysecret/1234567890abcdef1234567890abcdef`.
    */
-  keyVaultSecretId?: url;
+  keyVaultSecretId?: string;
 
   /**
    * The SHA1 thumbprint of the certificate.

specification/nginx/Nginx.Management/Configurations.tsp

@@ -7,7 +7,7 @@ using Rest;
 using Http;
 using Azure.ResourceManager;
 
-namespace NGINX.NGINXPLUS;
+namespace Nginx.NginxPlus;
 
 /**
  * Represents an Nginx configuration resource.
@@ -160,9 +160,9 @@ model NginxConfigurationRequestProperties {
 }
 
 /**
- * The request body for creating an analysis for an NGINX configuration.
+ * The request body for creating an analysis for an Nginx configuration.
  */
-@doc("The request body for creating an analysis for an NGINX configuration.")
+@doc("The request body for creating an analysis for an Nginx configuration.")
 model AnalysisCreate {
   /**
    * Configuration details for analysis.
@@ -175,7 +175,7 @@ model AnalysisCreate {
  */
 model AnalysisConfig {
   /**
-   * The root file of the NGINX config file(s). It must match one of the files' filepath.
+   * The root file of the Nginx config file(s). It must match one of the files' filepath.
    */
   rootFile?: string;
 
@@ -228,7 +228,7 @@ model AnalysisResultContent {
 }
 
 /**
- * An error object found during the analysis of an NGINX configuration.
+ * An error object found during the analysis of an Nginx configuration.
  */
 model AnalysisDiagnostic {
   /**
@@ -268,7 +268,7 @@ model AnalysisDiagnostic {
 }
 
 /**
- * A diagnostic is a message associated with an NGINX config. The Analyzer returns diagnostics with a level indicating the importance of the diagnostic with optional category.
+ * A diagnostic is a message associated with an Nginx config. The Analyzer returns diagnostics with a level indicating the importance of the diagnostic with optional category.
  */
 model DiagnosticItem {
   /**

specification/nginx/Nginx.Management/NginxDeployments.tsp

@@ -7,20 +7,29 @@ using Rest;
 using Http;
 using Azure.ResourceManager;
 
-namespace NGINX.NGINXPLUS;
+namespace Nginx.NginxPlus;
 
 /**
  * Represents an Nginx deployment resource.
  */
-model NginxDeployment is TrackedResource<NginxDeploymentProperties> {
+#suppress "@azure-tools/typespec-azure-core/no-private-usage"
+#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance"
+@Azure.ResourceManager.Private.armResourceInternal(NginxDeploymentProperties)
+@TypeSpec.Http.Private.includeInapplicableMetadataInPayload(false)
+model NginxDeployment extends Foundations.TrackedResource {
   /** The name of the Nginx deployment resource. */
   @pattern("^([a-z0-9A-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]|[a-z0-9A-Z])$")
-  @key("nginxDeploymentName")
+  @key("deploymentName")
   @segment("nginxDeployments")
   @path
   name: string;
 
   ...ManagedServiceIdentityProperty;
+
+  /** The resource-specific properties for this resource. */
+  #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property"
+  properties?: NginxDeploymentProperties;
+
   ...ResourceSkuProperty;
 }
 
@@ -168,7 +177,7 @@ model NginxDeploymentProperties {
   /**
    * Whether diagnostics support is enabled.
    */
-  enableDiagnosticsSupport: boolean;
+  enableDiagnosticsSupport?: boolean;
 
   /**
    * Logging configuration.

specification/nginx/Nginx.Management/WafPolicies.tsp

@@ -6,7 +6,7 @@ import "@azure-tools/typespec-azure-resource-manager";
 using Rest;
 using Azure.ResourceManager;
 
-namespace NGINX.NGINXPLUS;
+namespace Nginx.NginxPlus;
 
 /**
  * Represents a WAF policy resource under a given Nginx deployment.

specification/nginx/Nginx.Management/client.tsp

@@ -2,26 +2,24 @@ import "./main.tsp";
 import "@azure-tools/typespec-client-generator-core";
 
 using Azure.ClientGenerator.Core;
-using NGINX.NGINXPLUS;
+using Nginx.NginxPlus;
 
-@@clientName(NGINX.NGINXPLUS, "NginxManagementClient", "javascript");
-
-// Method name overrides
-@@clientName(Configurations.analyze, "analysis", "!csharp");
+@@clientName(Nginx.NginxPlus, "NginxManagementClient", "javascript");
 
 // Model name overrides
-@@clientName(Certificate, "NginxCertificate", "!csharp");
-@@clientName(ApiKey, "NginxDeploymentApiKeyResponse", "!csharp");
+@@clientName(Certificate, "NginxCertificate");
+@@clientName(ApiKeyRequestProperties, "NginxDeploymentApiKeyRequestProperties");
+
 @@clientName(ApiKeyResponseProperties,
   "NginxDeploymentApiKeyResponseProperties",
   "!csharp"
 );
+@@clientName(ApiKey, "NginxDeploymentApiKeyResponse", "!csharp");
 @@clientName(ApiKeyRequest, "NginxDeploymentApiKeyRequest", "!csharp");
-@@clientName(ApiKeyRequestProperties,
-  "NginxDeploymentApiKeyRequestProperties",
-  "!csharp"
-);
+@@clientName(AnalysisConfig, "AnalysisCreateConfig", "!csharp");
+@@clientName(AnalysisResultContent, "AnalysisResultData", "!csharp");
 @@clientName(Configuration, "NginxConfigurationResponse", "!csharp");
+@@clientName(DiagnosticLevel, "Level", "!csharp");
 @@clientName(NginxConfigurationProtectedFileResult,
   "NginxConfigurationProtectedFileResponse",
   "!csharp"
@@ -30,9 +28,6 @@ using NGINX.NGINXPLUS;
   "NginxConfigurationProtectedFileRequest",
   "!csharp"
 );
-@@clientName(AnalysisConfig, "AnalysisCreateConfig", "!csharp");
-@@clientName(AnalysisResultContent, "AnalysisResultData", "!csharp");
-@@clientName(DiagnosticLevel, "Level", "!csharp");
 
 // CommonTypes
 @@clientName(Azure.ResourceManager.CommonTypes.ManagedServiceIdentity,
@@ -49,7 +44,6 @@ using NGINX.NGINXPLUS;
 );
 // Sku has many more properties than ResourceSku
 @@clientName(Azure.ResourceManager.CommonTypes.Sku, "ResourceSku", "!csharp");
-
 // Anonymous model named by m4
 @@clientName(NginxAppProtect,
   "NginxDeploymentPropertiesNginxAppProtect",
@@ -75,6 +69,8 @@ using NGINX.NGINXPLUS;
   "!csharp"
 );
 
+// Method name overrides
+@@clientName(Configurations.analyze, "analysis", "!csharp");
 // Client name for list operations
 @@clientName(NginxDeployments.listBySubscription, "list", "!csharp");
 @@clientName(ApiKeys.listByDeployment, "list", "!csharp");
@@ -114,3 +110,63 @@ using NGINX.NGINXPLUS;
   "privateIpAllocationMethod",
   "java"
 );
+
+@@alternateType(Certificate.location, Azure.Core.azureLocation, "csharp");
+@@alternateType(NginxNetworkInterfaceConfiguration.subnetId,
+  Azure.Core.armResourceIdentifier,
+  "csharp"
+);
+@@alternateType(NginxPrivateIPAddress.privateIPAddress,
+  Azure.Core.ipV4Address,
+  "csharp"
+);
+@@alternateType(NginxPrivateIPAddress.subnetId,
+  Azure.Core.armResourceIdentifier,
+  "csharp"
+);
+@@alternateType(NginxCertificateProperties.keyVaultSecretCreated,
+  utcDateTime,
+  "csharp"
+);
+@@alternateType(ApiKeyResponseProperties.endDateTime, utcDateTime, "csharp");
+@@alternateType(ApiKeyRequestProperties.endDateTime, utcDateTime, "csharp");
+@@clientName(ApiKeyResponseProperties,
+  "NginxDeploymentApiKeyProperties",
+  "csharp"
+);
+@@clientName(AnalysisCreate, "NginxAnalysisContent", "csharp");
+@@clientName(AnalysisConfig, "NginxAnalysisConfig", "csharp");
+@@clientName(NginxCertificateErrorResponseBody,
+  "NginxCertificateError",
+  "csharp"
+);
+@@clientName(ActivationState, "NginxWafActivationState", "csharp");
+@@clientName(AnalysisResultContent, "NginxAnalysisResultDetails", "csharp");
+@@clientName(DiagnosticLevel, "NginxDiagnosticLevel", "csharp");
+@@clientName(Configuration, "NginxConfiguration", "csharp");
+@@clientName(NginxConfigurationResponseProperties,
+  "NginxConfigurationProperties",
+  "csharp"
+);
+@@clientName(ApiKey, "NginxDeploymentApiKey", "csharp");
+@@clientName(NginxConfigurationRequestProperties,
+  "NginxConfigurationCreateOrUpdateProperties",
+  "csharp"
+);
+
+@@clientName(AnalysisResult, "NginxAnalysisResult", "csharp");
+@@clientName(WafPolicy, "NginxDeploymentWafPolicy", "csharp");
+@@clientName(AnalysisDiagnostic, "NginxAnalysisDiagnostic", "csharp");
+@@clientName(DiagnosticItem, "NginxDiagnosticItem", "csharp");
+@@clientName(ProvisioningState, "NginxProvisioningState", "csharp");
+@@clientName(AutoScaleSettings, "NginxDeploymentAutoScaleSettings", "csharp");
+@@clientName(AutoUpgradeProfile, "NginxDeploymentAutoUpgradeProfile", "csharp");
+@@clientName(ScaleProfile, "NginxScaleProfile", "csharp");
+@@clientName(ScaleProfileCapacity, "NginxScaleProfileCapacity", "csharp");
+@@clientName(WebApplicationFirewallSettings, "NginxWafSettings", "csharp");
+@@clientName(WebApplicationFirewallStatus, "NginxWafStatus", "csharp");
+@@clientName(WebApplicationFirewallPackage, "NginxWafPackage", "csharp");
+@@clientName(WebApplicationFirewallComponentVersions,
+  "NginxWafComponentVersions",
+  "csharp"
+);

specification/nginx/Nginx.Management/examples/2025-03-01-preview/ApiKeys_CreateOrUpdate_MaximumSet_Gen.json

@@ -5,7 +5,7 @@
     "api-version": "2025-03-01-preview",
     "subscriptionId": "333F7B80-063D-40E5-975B-6E3C3CAC8296",
     "resourceGroupName": "rgopenapi",
-    "nginxDeploymentName": "myDeployment",
+    "deploymentName": "myDeployment",
     "apiKeyName": "myApiKey",
     "resource": {
       "properties": {
@@ -21,7 +21,7 @@
           "hint": "my secret API key hint",
           "endDateTime": "2025-05-28T20:01:03.647Z"
         },
-        "id": "/subscriptions/333F7B80-063D-40E5-975B-6E3C3CAC8296/resourceGroups/rgopenapi/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/apiKeys/otvmugiwezqyit",
+        "id": "/subscriptions/333F7B80-063D-40E5-975B-6E3C3CAC8296/resourceGroups/rgopenapi/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/apiKeys/otvmugiwezqyit",
         "name": "otvmugiwezqyit",
         "type": "ugslayxowhvlfgkfldbnbulh",
         "systemData": {
@@ -40,7 +40,7 @@
           "hint": "my secret API key hint",
           "endDateTime": "2025-05-28T20:01:03.647Z"
         },
-        "id": "/subscriptions/333F7B80-063D-40E5-975B-6E3C3CAC8296/resourceGroups/rgopenapi/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/apiKeys/otvmugiwezqyit",
+        "id": "/subscriptions/333F7B80-063D-40E5-975B-6E3C3CAC8296/resourceGroups/rgopenapi/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/apiKeys/otvmugiwezqyit",
         "name": "otvmugiwezqyit",
         "type": "ugslayxowhvlfgkfldbnbulh",
         "systemData": {

specification/nginx/Nginx.Management/examples/2025-03-01-preview/ApiKeys_Delete_MaximumSet_Gen.json

@@ -5,7 +5,7 @@
     "api-version": "2025-03-01-preview",
     "subscriptionId": "333F7B80-063D-40E5-975B-6E3C3CAC8296",
     "resourceGroupName": "rgopenapi",
-    "nginxDeploymentName": "myDeployment",
+    "deploymentName": "myDeployment",
     "apiKeyName": "myApiKey"
   },
   "responses": {

specification/nginx/Nginx.Management/examples/2025-03-01-preview/ApiKeys_Get_MaximumSet_Gen.json

@@ -5,7 +5,7 @@
     "api-version": "2025-03-01-preview",
     "subscriptionId": "333F7B80-063D-40E5-975B-6E3C3CAC8296",
     "resourceGroupName": "rgopenapi",
-    "nginxDeploymentName": "myDeployment",
+    "deploymentName": "myDeployment",
     "apiKeyName": "myApiKey"
   },
   "responses": {
@@ -15,7 +15,7 @@
           "hint": "my secret API key hint",
           "endDateTime": "2025-05-28T20:01:03.647Z"
         },
-        "id": "/subscriptions/333F7B80-063D-40E5-975B-6E3C3CAC8296/resourceGroups/rgopenapi/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/apiKeys/otvmugiwezqyit",
+        "id": "/subscriptions/333F7B80-063D-40E5-975B-6E3C3CAC8296/resourceGroups/rgopenapi/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/apiKeys/otvmugiwezqyit",
         "name": "otvmugiwezqyit",
         "type": "ugslayxowhvlfgkfldbnbulh",
         "systemData": {

specification/nginx/Nginx.Management/examples/2025-03-01-preview/ApiKeys_ListByDeployment_MaximumSet_Gen.json

@@ -5,7 +5,7 @@
     "api-version": "2025-03-01-preview",
     "subscriptionId": "333F7B80-063D-40E5-975B-6E3C3CAC8296",
     "resourceGroupName": "rgopenapi",
-    "nginxDeploymentName": "myDeployment"
+    "deploymentName": "myDeployment"
   },
   "responses": {
     "200": {
@@ -16,7 +16,7 @@
               "hint": "my secret API key hint",
               "endDateTime": "2025-05-28T20:01:03.647Z"
             },
-            "id": "/subscriptions/333F7B80-063D-40E5-975B-6E3C3CAC8296/resourceGroups/rgopenapi/providers/NGINX.NGINXPLUS/nginxDeployments/myDeployment/apiKeys/otvmugiwezqyit",
+            "id": "/subscriptions/333F7B80-063D-40E5-975B-6E3C3CAC8296/resourceGroups/rgopenapi/providers/Nginx.NginxPlus/nginxDeployments/myDeployment/apiKeys/otvmugiwezqyit",
             "name": "otvmugiwezqyit",
             "type": "ugslayxowhvlfgkfldbnbulh",
             "systemData": {