Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 29 additions & 8 deletions sdk/nginx/arm-nginx/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,36 @@
# Release History

## 4.0.0-beta.1 (2024-03-18)

**Features**

## 3.0.1 (Unreleased)

### Features Added

### Breaking Changes

### Bugs Fixed
- Added operation Configurations.analysis
- Added Interface AnalysisCreate
- Added Interface AnalysisCreateConfig
- Added Interface AnalysisDiagnostic
- Added Interface AnalysisResult
- Added Interface AnalysisResultData
- Added Interface AutoUpgradeProfile
- Added Interface ConfigurationsAnalysisOptionalParams
- Added Interface ErrorAdditionalInfo
- Added Interface ErrorDetail
- Added Interface NginxCertificateErrorResponseBody
- Added Interface ScaleProfile
- Added Interface ScaleProfileCapacity
- Added Type Alias ConfigurationsAnalysisResponse
- Interface NginxCertificateProperties has a new optional parameter certificateError
- Interface NginxCertificateProperties has a new optional parameter keyVaultSecretCreated
- Interface NginxCertificateProperties has a new optional parameter keyVaultSecretVersion
- Interface NginxCertificateProperties has a new optional parameter sha1Thumbprint
- Interface NginxDeploymentProperties has a new optional parameter autoUpgradeProfile
- Interface NginxDeploymentScalingProperties has a new optional parameter profiles
- Interface NginxDeploymentUpdateProperties has a new optional parameter autoUpgradeProfile

### Other Changes
**Breaking Changes**

- Type of parameter error of interface ResourceProviderDefaultErrorResponse is changed from ErrorResponseBody to ErrorDetail


## 3.0.0 (2023-11-09)

**Features**
Expand Down
2 changes: 1 addition & 1 deletion sdk/nginx/arm-nginx/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2023 Microsoft
Copyright (c) 2024 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion sdk/nginx/arm-nginx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This package contains an isomorphic SDK (runs both in Node.js and in browsers) f

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/nginx/arm-nginx) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-nginx) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-nginx) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-nginx?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
Expand Down
8 changes: 4 additions & 4 deletions sdk/nginx/arm-nginx/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "ed84b11847785792767b0b84cc6f98f4ea08ca77",
"commit": "9fb75a3c4ca9b753271bd6db2e42e5f98366cbae",
"readme": "specification/nginx/resource-manager/readme.md",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\nginx\\resource-manager\\readme.md --use=@autorest/typescript@6.0.12 --generate-sample=true",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\nginx\\resource-manager\\readme.md --use=@autorest/typescript@6.0.17 --generate-sample=true",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.7.2",
"use": "@autorest/typescript@6.0.12"
"release_tool": "@azure-tools/js-sdk-release-tools@2.7.4",
"use": "@autorest/typescript@6.0.17"
}
2 changes: 1 addition & 1 deletion sdk/nginx/arm-nginx/assets.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "js",
"TagPrefix": "js/nginx/arm-nginx",
"Tag": "js/nginx/arm-nginx_94207fccaa"
"Tag": "js/nginx/arm-nginx_ef5d73eeb4"
}
9 changes: 4 additions & 5 deletions sdk/nginx/arm-nginx/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for NginxManagementClient.",
"version": "3.0.1",
"version": "4.0.0-beta.1",
"engines": {
"node": ">=18.0.0"
},
Expand All @@ -12,8 +12,8 @@
"@azure/abort-controller": "^1.0.0",
"@azure/core-paging": "^1.2.0",
"@azure/core-client": "^1.7.0",
"@azure/core-auth": "^1.3.0",
"@azure/core-rest-pipeline": "^1.12.0",
"@azure/core-auth": "^1.6.0",
"@azure/core-rest-pipeline": "^1.14.0",
"tslib": "^2.2.0"
},
"keywords": [
Expand Down Expand Up @@ -78,7 +78,6 @@
"pack": "npm pack 2>&1",
"extract-api": "api-extractor run --local",
"lint": "echo skipped",
"audit": "echo skipped",
"clean": "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
"build:node": "echo skipped",
"build:browser": "echo skipped",
Expand Down Expand Up @@ -116,4 +115,4 @@
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-nginx?view=azure-node-preview"
}
}
}
120 changes: 105 additions & 15 deletions sdk/nginx/arm-nginx/review/arm-nginx.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,57 @@ import { OperationState } from '@azure/core-lro';
import { PagedAsyncIterableIterator } from '@azure/core-paging';
import { SimplePollerLike } from '@azure/core-lro';

// @public
export interface AnalysisCreate {
// (undocumented)
config: AnalysisCreateConfig;
}

// @public (undocumented)
export interface AnalysisCreateConfig {
// (undocumented)
files?: NginxConfigurationFile[];
// (undocumented)
package?: NginxConfigurationPackage;
// (undocumented)
protectedFiles?: NginxConfigurationFile[];
rootFile?: string;
}

// @public
export interface AnalysisDiagnostic {
// (undocumented)
description: string;
// (undocumented)
directive: string;
file: string;
id?: string;
// (undocumented)
line: number;
// (undocumented)
message: string;
// (undocumented)
rule: string;
}

// @public
export interface AnalysisResult {
// (undocumented)
data?: AnalysisResultData;
status: string;
}

// @public (undocumented)
export interface AnalysisResultData {
// (undocumented)
errors?: AnalysisDiagnostic[];
}

// @public
export interface AutoUpgradeProfile {
upgradeChannel: string;
}

// @public
export interface Certificates {
beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, certificateName: string, options?: CertificatesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CertificatesCreateOrUpdateResponse>, CertificatesCreateOrUpdateResponse>>;
Expand Down Expand Up @@ -59,6 +110,7 @@ export type CertificatesListResponse = NginxCertificateListResponse;

// @public
export interface Configurations {
analysis(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsAnalysisOptionalParams): Promise<ConfigurationsAnalysisResponse>;
beginCreateOrUpdate(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ConfigurationsCreateOrUpdateResponse>, ConfigurationsCreateOrUpdateResponse>>;
beginCreateOrUpdateAndWait(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsCreateOrUpdateOptionalParams): Promise<ConfigurationsCreateOrUpdateResponse>;
beginDelete(resourceGroupName: string, deploymentName: string, configurationName: string, options?: ConfigurationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
Expand All @@ -67,6 +119,14 @@ export interface Configurations {
list(resourceGroupName: string, deploymentName: string, options?: ConfigurationsListOptionalParams): PagedAsyncIterableIterator<NginxConfiguration>;
}

// @public
export interface ConfigurationsAnalysisOptionalParams extends coreClient.OperationOptions {
body?: AnalysisCreate;
}

// @public
export type ConfigurationsAnalysisResponse = AnalysisResult;

// @public
export interface ConfigurationsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
body?: NginxConfiguration;
Expand Down Expand Up @@ -183,16 +243,19 @@ export interface DeploymentsUpdateOptionalParams extends coreClient.OperationOpt
// @public
export type DeploymentsUpdateResponse = NginxDeployment;

// @public (undocumented)
export interface ErrorResponseBody {
// (undocumented)
code?: string;
// (undocumented)
details?: ErrorResponseBody[];
// (undocumented)
message?: string;
// (undocumented)
target?: string;
// @public
export interface ErrorAdditionalInfo {
readonly info?: Record<string, unknown>;
readonly type?: string;
}

// @public
export interface ErrorDetail {
readonly additionalInfo?: ErrorAdditionalInfo[];
readonly code?: string;
readonly details?: ErrorDetail[];
readonly message?: string;
readonly target?: string;
}

// @public
Expand Down Expand Up @@ -259,6 +322,14 @@ export interface NginxCertificate {
readonly type?: string;
}

// @public (undocumented)
export interface NginxCertificateErrorResponseBody {
// (undocumented)
code?: string;
// (undocumented)
message?: string;
}

// @public (undocumented)
export interface NginxCertificateListResponse {
// (undocumented)
Expand All @@ -269,13 +340,18 @@ export interface NginxCertificateListResponse {

// @public (undocumented)
export interface NginxCertificateProperties {
// (undocumented)
certificateError?: NginxCertificateErrorResponseBody;
// (undocumented)
certificateVirtualPath?: string;
readonly keyVaultSecretCreated?: Date;
// (undocumented)
keyVaultSecretId?: string;
readonly keyVaultSecretVersion?: string;
// (undocumented)
keyVirtualPath?: string;
readonly provisioningState?: ProvisioningState;
readonly sha1Thumbprint?: string;
}

// @public (undocumented)
Expand Down Expand Up @@ -354,6 +430,7 @@ export interface NginxDeploymentListResponse {

// @public (undocumented)
export interface NginxDeploymentProperties {
autoUpgradeProfile?: AutoUpgradeProfile;
// (undocumented)
enableDiagnosticsSupport?: boolean;
readonly ipAddress?: string;
Expand All @@ -364,16 +441,17 @@ export interface NginxDeploymentProperties {
networkProfile?: NginxNetworkProfile;
readonly nginxVersion?: string;
readonly provisioningState?: ProvisioningState;
// (undocumented)
scalingProperties?: NginxDeploymentScalingProperties;
// (undocumented)
userProfile?: NginxDeploymentUserProfile;
}

// @public (undocumented)
// @public
export interface NginxDeploymentScalingProperties {
// (undocumented)
capacity?: number;
// (undocumented)
profiles?: ScaleProfile[];
}

// @public (undocumented)
Expand All @@ -393,11 +471,11 @@ export interface NginxDeploymentUpdateParameters {

// @public (undocumented)
export interface NginxDeploymentUpdateProperties {
autoUpgradeProfile?: AutoUpgradeProfile;
// (undocumented)
enableDiagnosticsSupport?: boolean;
// (undocumented)
logging?: NginxLogging;
// (undocumented)
scalingProperties?: NginxDeploymentScalingProperties;
// (undocumented)
userProfile?: NginxDeploymentUserProfile;
Expand Down Expand Up @@ -534,15 +612,27 @@ export type ProvisioningState = string;

// @public (undocumented)
export interface ResourceProviderDefaultErrorResponse {
// (undocumented)
error?: ErrorResponseBody;
error?: ErrorDetail;
}

// @public (undocumented)
export interface ResourceSku {
name: string;
}

// @public
export interface ScaleProfile {
capacity: ScaleProfileCapacity;
// (undocumented)
name: string;
}

// @public
export interface ScaleProfileCapacity {
max: number;
min: number;
}

// @public
export interface SystemData {
createdAt?: Date;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import { NginxManagementClient } from "@azure/arm-nginx";
import {
NginxCertificate,
CertificatesCreateOrUpdateOptionalParams,
NginxManagementClient,
} from "@azure/arm-nginx";
import { DefaultAzureCredential } from "@azure/identity";
import * as dotenv from "dotenv";

Expand All @@ -18,7 +22,7 @@ dotenv.config();
* This sample demonstrates how to Create or update the NGINX certificates for given NGINX deployment
*
* @summary Create or update the NGINX certificates for given NGINX deployment
* x-ms-original-file: specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-04-01/examples/Certificates_CreateOrUpdate.json
* x-ms-original-file: specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-01-01-preview/examples/Certificates_CreateOrUpdate.json
*/
async function certificatesCreateOrUpdate() {
const subscriptionId =
Expand All @@ -28,12 +32,21 @@ async function certificatesCreateOrUpdate() {
process.env["NGINX_RESOURCE_GROUP"] || "myResourceGroup";
const deploymentName = "myDeployment";
const certificateName = "default";
const body: NginxCertificate = {
properties: {
certificateVirtualPath: "/src/cert/somePath.cert",
keyVaultSecretId: "https://someKV.vault.azure.com/someSecretID",
keyVirtualPath: "/src/cert/somekey.key",
},
};
const options: CertificatesCreateOrUpdateOptionalParams = { body };
const credential = new DefaultAzureCredential();
const client = new NginxManagementClient(credential, subscriptionId);
const result = await client.certificates.beginCreateOrUpdateAndWait(
resourceGroupName,
deploymentName,
certificateName
certificateName,
options,
);
console.log(result);
}
Expand Down
4 changes: 2 additions & 2 deletions sdk/nginx/arm-nginx/samples-dev/certificatesDeleteSample.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dotenv.config();
* This sample demonstrates how to Deletes a certificate from the NGINX deployment
*
* @summary Deletes a certificate from the NGINX deployment
* x-ms-original-file: specification/nginx/resource-manager/NGINX.NGINXPLUS/stable/2023-04-01/examples/Certificates_Delete.json
* x-ms-original-file: specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-01-01-preview/examples/Certificates_Delete.json
*/
async function certificatesDelete() {
const subscriptionId =
Expand All @@ -33,7 +33,7 @@ async function certificatesDelete() {
const result = await client.certificates.beginDeleteAndWait(
resourceGroupName,
deploymentName,
certificateName
certificateName,
);
console.log(result);
}
Expand Down
Loading