Skip to content

Commit

Permalink
arm-appplatform (#16139)
Browse files Browse the repository at this point in the history
  • Loading branch information
colawwj authored Jul 9, 2021
1 parent 35fc536 commit de107dd
Show file tree
Hide file tree
Showing 13 changed files with 243 additions and 29 deletions.
8 changes: 3 additions & 5 deletions sdk/appplatform/arm-appplatform/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Azure AppPlatformManagementClient SDK for JavaScript

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

### 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-appplatform @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 get services as an example written in JavaScript.

##### Sample code
Expand Down Expand Up @@ -87,7 +85,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.ArmAppplatform.AppPlatformManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
Expand Down
4 changes: 2 additions & 2 deletions sdk/appplatform/arm-appplatform/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@azure/arm-appplatform",
"author": "Microsoft Corporation",
"description": "AppPlatformManagementClient Library with typescript type definitions for node.js and browser.",
"version": "1.3.0",
"version": "1.4.0",
"dependencies": {
"@azure/ms-rest-azure-js": "^2.1.0",
"@azure/ms-rest-js": "^2.2.0",
Expand All @@ -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/appplatform/arm-appplatform",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/feature/v4/sdk/appplatform/arm-appplatform",
"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,11 +9,11 @@

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-appplatform";
const packageVersion = "1.3.0";
const packageVersion = "1.4.0";

export class AppPlatformManagementClientContext extends msRestAzure.AzureServiceClient {
credentials: msRest.ServiceClientCredentials | TokenCredential;
Expand Down Expand Up @@ -50,7 +50,7 @@ export class AppPlatformManagementClientContext extends msRestAzure.AzureService

super(credentials, options);

this.apiVersion = '2020-11-01-preview';
this.apiVersion = '2021-06-01-preview';
this.acceptLanguage = 'en-US';
this.longRunningOperationRetryTimeout = 30;
this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";
Expand Down
3 changes: 3 additions & 0 deletions sdk/appplatform/arm-appplatform/src/models/appsMappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export {
ConfigServerProperties,
ConfigServerResource,
ConfigServerSettings,
CustomContainer,
CustomDomainProperties,
CustomDomainResource,
CustomDomainValidatePayload,
Expand All @@ -32,6 +33,7 @@ export {
DeploymentSettings,
ErrorModel,
GitPatternRepository,
ImageRegistryCredential,
ManagedIdentityProperties,
MonitoringSettingProperties,
MonitoringSettingResource,
Expand All @@ -41,6 +43,7 @@ export {
ProxyResource,
RequiredTraffic,
Resource,
ResourceRequests,
ResourceUploadDefinition,
ServiceResource,
Sku,
Expand Down
3 changes: 3 additions & 0 deletions sdk/appplatform/arm-appplatform/src/models/bindingsMappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export {
ConfigServerProperties,
ConfigServerResource,
ConfigServerSettings,
CustomContainer,
CustomDomainProperties,
CustomDomainResource,
DeploymentInstance,
Expand All @@ -30,6 +31,7 @@ export {
DeploymentSettings,
ErrorModel,
GitPatternRepository,
ImageRegistryCredential,
ManagedIdentityProperties,
MonitoringSettingProperties,
MonitoringSettingResource,
Expand All @@ -39,6 +41,7 @@ export {
ProxyResource,
RequiredTraffic,
Resource,
ResourceRequests,
ServiceResource,
Sku,
TemporaryDisk,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ export {
ConfigServerProperties,
ConfigServerResource,
ConfigServerSettings,
CustomContainer,
CustomDomainProperties,
CustomDomainResource,
DeploymentInstance,
Expand All @@ -30,6 +31,7 @@ export {
DeploymentSettings,
ErrorModel,
GitPatternRepository,
ImageRegistryCredential,
ManagedIdentityProperties,
MonitoringSettingProperties,
MonitoringSettingResource,
Expand All @@ -39,6 +41,7 @@ export {
ProxyResource,
RequiredTraffic,
Resource,
ResourceRequests,
ServiceResource,
Sku,
TemporaryDisk,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export {
ConfigServerSettings,
ConfigServerSettingsErrorRecord,
ConfigServerSettingsValidateResult,
CustomContainer,
CustomDomainProperties,
CustomDomainResource,
DeploymentInstance,
Expand All @@ -31,6 +32,7 @@ export {
DeploymentSettings,
ErrorModel,
GitPatternRepository,
ImageRegistryCredential,
ManagedIdentityProperties,
MonitoringSettingProperties,
MonitoringSettingResource,
Expand All @@ -40,6 +42,7 @@ export {
ProxyResource,
RequiredTraffic,
Resource,
ResourceRequests,
ServiceResource,
Sku,
TemporaryDisk,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export {
ConfigServerProperties,
ConfigServerResource,
ConfigServerSettings,
CustomContainer,
CustomDomainProperties,
CustomDomainResource,
CustomDomainResourceCollection,
Expand All @@ -30,6 +31,7 @@ export {
DeploymentSettings,
ErrorModel,
GitPatternRepository,
ImageRegistryCredential,
ManagedIdentityProperties,
MonitoringSettingProperties,
MonitoringSettingResource,
Expand All @@ -39,6 +41,7 @@ export {
ProxyResource,
RequiredTraffic,
Resource,
ResourceRequests,
ServiceResource,
Sku,
TemporaryDisk,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export {
ConfigServerProperties,
ConfigServerResource,
ConfigServerSettings,
CustomContainer,
CustomDomainProperties,
CustomDomainResource,
DeploymentInstance,
Expand All @@ -30,6 +31,7 @@ export {
DeploymentSettings,
ErrorModel,
GitPatternRepository,
ImageRegistryCredential,
LogFileUrlResponse,
ManagedIdentityProperties,
MonitoringSettingProperties,
Expand All @@ -40,6 +42,7 @@ export {
ProxyResource,
RequiredTraffic,
Resource,
ResourceRequests,
ServiceResource,
Sku,
TemporaryDisk,
Expand Down
101 changes: 88 additions & 13 deletions sdk/appplatform/arm-appplatform/src/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@ export interface ClusterResourceProperties {
*/
export interface Sku {
/**
* Name of the Sku
* Name of the Sku. Default value: 'S0'.
*/
name?: string;
/**
* Tier of the Sku
* Tier of the Sku. Default value: 'Standard'.
*/
tier?: string;
/**
Expand Down Expand Up @@ -546,10 +546,6 @@ export interface AppResourceProperties {
* Indicate if only https is allowed.
*/
httpsOnly?: boolean;
/**
* Indicate if end to end TLS is enabled.
*/
enableEndToEndTLS?: boolean;
/**
* Date time when the resource is created
* **NOTE: This property will not be serialized. It can only be populated by the server.**
Expand All @@ -563,6 +559,10 @@ export interface AppResourceProperties {
* Persistent disk settings
*/
persistentDisk?: PersistentDisk;
/**
* Indicate if end to end TLS is enabled.
*/
enableEndToEndTLS?: boolean;
}

/**
Expand Down Expand Up @@ -798,12 +798,55 @@ export interface CustomDomainValidateResult {
message?: string;
}

/**
* Credential of the image registry
*/
export interface ImageRegistryCredential {
/**
* The username of the image registry credential
*/
username?: string;
/**
* The password of the image registry credential
*/
password?: string;
}

/**
* Custom container payload
*/
export interface CustomContainer {
/**
* The name of the registry that contains the container image
*/
server?: string;
/**
* Container image of the custom container. This should be in the form of <repository>:<tag>
* without the server name of the registry
*/
containerImage?: string;
/**
* Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this
* is not provided.
*/
command?: string[];
/**
* Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
*/
args?: string[];
/**
* Credential of the image registry
*/
imageRegistryCredential?: ImageRegistryCredential;
}

/**
* Source information for a deployment
*/
export interface UserSourceInfo {
/**
* Type of the source uploaded. Possible values include: 'Jar', 'NetCoreZip', 'Source'
* Type of the source uploaded. Possible values include: 'Jar', 'NetCoreZip', 'Source',
* 'Container'
*/
type?: UserSourceType;
/**
Expand All @@ -820,22 +863,50 @@ export interface UserSourceInfo {
* the relative path to the target module/project.
*/
artifactSelector?: string;
/**
* Custom container payload
*/
customContainer?: CustomContainer;
}

/**
* Deployment resource request payload
*/
export interface ResourceRequests {
/**
* Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic
* tier, and {500m, 1, 2, 3, 4} for Standard tier.
*/
cpu?: string;
/**
* Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi}
* for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier.
*/
memory?: string;
}

/**
* Deployment settings payload
*/
export interface DeploymentSettings {
/**
* Required CPU, basic tier should be 1, standard tier should be in range (1, 4). Default value:
* 1.
* Required CPU. This should be 1 for Basic tier, and in range [1, 4] for Standard tier. This is
* deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field
* to set the CPU size. Default value: 1.
*/
cpu?: number;
/**
* Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in
* range (1, 8). Default value: 1.
* Required Memory size in GB. This should be in range [1, 2] for Basic tier, and in range [1, 8]
* for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use
* the resourceRequests field to set the the memory size. Default value: 1.
*/
memoryInGB?: number;
/**
* The requested resource quantity for required CPU and Memory. It is recommended that using this
* field to represent the required CPU and Memory, the old field cpu and memoryInGB will be
* deprecated later.
*/
resourceRequests?: ResourceRequests;
/**
* JVM parameter
*/
Expand Down Expand Up @@ -1007,6 +1078,10 @@ export interface MetricDimension {
* Localized friendly display name of the dimension
*/
displayName?: string;
/**
* Whether this dimension should be included for the Shoebox export scenario
*/
toBeExportedForShoebox?: boolean;
}

/**
Expand Down Expand Up @@ -1499,11 +1574,11 @@ export type AppResourceProvisioningState = 'Succeeded' | 'Failed' | 'Creating' |

/**
* Defines values for UserSourceType.
* Possible values include: 'Jar', 'NetCoreZip', 'Source'
* Possible values include: 'Jar', 'NetCoreZip', 'Source', 'Container'
* @readonly
* @enum {string}
*/
export type UserSourceType = 'Jar' | 'NetCoreZip' | 'Source';
export type UserSourceType = 'Jar' | 'NetCoreZip' | 'Source' | 'Container';

/**
* Defines values for RuntimeVersion.
Expand Down
Loading

0 comments on commit de107dd

Please sign in to comment.