Skip to content

Commit

Permalink
CodeGen from PR 14934 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Improve AKS Swagger documentation (Azure#14934)

* Improve AKS Swagger documentation

* PR feedback

* Undo "breaking" changes
  • Loading branch information
SDKAuto committed Jun 23, 2021
1 parent b499bfb commit f8acb5b
Show file tree
Hide file tree
Showing 14 changed files with 948 additions and 469 deletions.
9 changes: 3 additions & 6 deletions sdk/containerservice/arm-containerservice/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Azure ContainerServiceClient SDK for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for ContainerServiceClient.
This package contains an isomorphic SDK (runs both in node.js and in browsers) for ContainerServiceClient.

### Currently supported environments

- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- Latest versions of Safari, Chrome, Edge, and Firefox.
- Latest versions of Safari, Chrome, Edge and Firefox.

### Prerequisites

Expand All @@ -21,7 +21,6 @@ Install both packages using the below command:
```bash
npm install --save @azure/arm-containerservice @azure/identity
```

> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.

Expand All @@ -37,7 +36,6 @@ If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/

In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.

#### nodejs - Authentication, client creation, and list operations as an example written in JavaScript.

##### Sample code
Expand All @@ -51,7 +49,6 @@ const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
const creds = new DefaultAzureCredential();
const client = new ContainerServiceClient(creds, subscriptionId);

client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
Expand Down Expand Up @@ -86,7 +83,7 @@ In browser applications, we recommend using the `InteractiveBrowserCredential` t
const credential = new InteractiveBrowserCredential(
{
clientId: "<client id for your Azure AD app>",
tenantId: "<optional tenant for your organization>"
tenant: "<optional tenant for your organization>"
});
const client = new Azure.ArmContainerservice.ContainerServiceClient(creds, subscriptionId);
client.operations.list().then((result) => {
Expand Down
2 changes: 1 addition & 1 deletion sdk/containerservice/arm-containerservice/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"rollup-plugin-sourcemaps": "^0.4.2",
"uglify-js": "^3.6.0"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/containerservice/arm-containerservice",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/containerservice/arm-containerservice",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@

import * as Models from "./models";
import * as msRest from "@azure/ms-rest-js";
import { TokenCredential } from "@azure/core-auth";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import { TokenCredential } from "@azure/core-auth";

const packageName = "@azure/arm-containerservice";
const packageVersion = "13.3.0";
Expand Down Expand Up @@ -50,7 +50,7 @@ export class ContainerServiceClientContext extends msRestAzure.AzureServiceClien

super(credentials, options);

this.apiVersion = '2021-03-01';
this.apiVersion = '2021-05-01';
this.acceptLanguage = 'en-US';
this.longRunningOperationRetryTimeout = 30;
this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";
Expand Down
880 changes: 565 additions & 315 deletions sdk/containerservice/arm-containerservice/src/models/index.ts

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ export {
ContainerServiceSshPublicKey,
CredentialResult,
CredentialResults,
EndpointDependency,
EndpointDetail,
ExtendedLocation,
KubeletConfig,
LinuxOSConfig,
Expand Down Expand Up @@ -52,6 +54,8 @@ export {
ManagedClusterWindowsProfile,
OSOptionProfile,
OSOptionProperty,
OutboundEnvironmentEndpoint,
OutboundEnvironmentEndpointCollection,
PowerState,
PrivateEndpoint,
PrivateEndpointConnection,
Expand Down
138 changes: 138 additions & 0 deletions sdk/containerservice/arm-containerservice/src/models/mappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -814,6 +814,12 @@ export const ManagedClusterAgentPoolProfileProperties: msRest.CompositeMapper =
name: "Boolean"
}
},
enableUltraSSD: {
serializedName: "enableUltraSSD",
type: {
name: "Boolean"
}
},
enableFIPS: {
serializedName: "enableFIPS",
type: {
Expand Down Expand Up @@ -1086,6 +1092,12 @@ export const AgentPool: msRest.CompositeMapper = {
name: "Boolean"
}
},
enableUltraSSD: {
serializedName: "properties.enableUltraSSD",
type: {
name: "Boolean"
}
},
enableFIPS: {
serializedName: "properties.enableFIPS",
type: {
Expand Down Expand Up @@ -2148,6 +2160,12 @@ export const ManagedClusterAPIServerAccessProfile: msRest.CompositeMapper = {
type: {
name: "String"
}
},
enablePrivateClusterPublicFQDN: {
serializedName: "enablePrivateClusterPublicFQDN",
type: {
name: "Boolean"
}
}
}
}
Expand Down Expand Up @@ -3152,6 +3170,96 @@ export const OSOptionProfile: msRest.CompositeMapper = {
}
};

export const EndpointDetail: msRest.CompositeMapper = {
serializedName: "EndpointDetail",
type: {
name: "Composite",
className: "EndpointDetail",
modelProperties: {
ipAddress: {
serializedName: "ipAddress",
type: {
name: "String"
}
},
port: {
serializedName: "port",
type: {
name: "Number"
}
},
protocol: {
serializedName: "protocol",
type: {
name: "String"
}
},
description: {
serializedName: "description",
type: {
name: "String"
}
}
}
}
};

export const EndpointDependency: msRest.CompositeMapper = {
serializedName: "EndpointDependency",
type: {
name: "Composite",
className: "EndpointDependency",
modelProperties: {
domainName: {
serializedName: "domainName",
type: {
name: "String"
}
},
endpointDetails: {
serializedName: "endpointDetails",
type: {
name: "Sequence",
element: {
type: {
name: "Composite",
className: "EndpointDetail"
}
}
}
}
}
}
};

export const OutboundEnvironmentEndpoint: msRest.CompositeMapper = {
serializedName: "OutboundEnvironmentEndpoint",
type: {
name: "Composite",
className: "OutboundEnvironmentEndpoint",
modelProperties: {
category: {
serializedName: "category",
type: {
name: "String"
}
},
endpoints: {
serializedName: "endpoints",
type: {
name: "Sequence",
element: {
type: {
name: "Composite",
className: "EndpointDependency"
}
}
}
}
}
}
};

export const OperationListResult: msRest.CompositeMapper = {
serializedName: "OperationListResult",
type: {
Expand Down Expand Up @@ -3204,6 +3312,36 @@ export const ManagedClusterListResult: msRest.CompositeMapper = {
}
};

export const OutboundEnvironmentEndpointCollection: msRest.CompositeMapper = {
serializedName: "OutboundEnvironmentEndpointCollection",
type: {
name: "Composite",
className: "OutboundEnvironmentEndpointCollection",
modelProperties: {
value: {
required: true,
serializedName: "",
type: {
name: "Sequence",
element: {
type: {
name: "Composite",
className: "OutboundEnvironmentEndpoint"
}
}
}
},
nextLink: {
readOnly: true,
serializedName: "nextLink",
type: {
name: "String"
}
}
}
}
};

export const MaintenanceConfigurationListResult: msRest.CompositeMapper = {
serializedName: "MaintenanceConfigurationListResult",
type: {
Expand Down
12 changes: 12 additions & 0 deletions sdk/containerservice/arm-containerservice/src/models/parameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,18 @@ export const roleName: msRest.OperationURLParameter = {
}
}
};
export const serverFqdn: msRest.OperationQueryParameter = {
parameterPath: [
"options",
"serverFqdn"
],
mapper: {
serializedName: "server-fqdn",
type: {
name: "String"
}
}
};
export const subscriptionId: msRest.OperationURLParameter = {
parameterPath: "subscriptionId",
mapper: {
Expand Down
Loading

0 comments on commit f8acb5b

Please sign in to comment.