New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@azure/arm-appplatform
Advanced tools
@azure/arm-appplatform - npm Package Compare versions
Comparing version 1.2.0 to 1.3.0
| import * as msRest from "@azure/ms-rest-js"; | ||
| import { TokenCredential } from "@azure/core-auth"; | ||
| import * as Models from "./models"; | ||
@@ -20,3 +21,8 @@ import * as Mappers from "./models/mappers"; | ||
| * Initializes a new instance of the AppPlatformManagementClient class. | ||
| * @param credentials Credentials needed for the client to connect to Azure. | ||
| * @param credentials Credentials needed for the client to connect to Azure. Credentials | ||
| * implementing the TokenCredential interface from the @azure/identity package are recommended. For | ||
| * more information about these credentials, see | ||
| * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the | ||
| * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and | ||
| * @azure/ms-rest-browserauth are also supported. | ||
| * @param subscriptionId Gets subscription ID which uniquely identify the Microsoft Azure | ||
@@ -26,3 +32,3 @@ * subscription. The subscription ID forms part of the URI for every service call. | ||
| */ | ||
| constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.AppPlatformManagementClientOptions); | ||
| constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AppPlatformManagementClientOptions); | ||
| } | ||
@@ -29,0 +35,0 @@ export { AppPlatformManagementClient, AppPlatformManagementClientContext, Models as AppPlatformManagementModels, Mappers as AppPlatformManagementMappers }; |
@@ -18,3 +18,8 @@ /* | ||
| * Initializes a new instance of the AppPlatformManagementClient class. | ||
| * @param credentials Credentials needed for the client to connect to Azure. | ||
| * @param credentials Credentials needed for the client to connect to Azure. Credentials | ||
| * implementing the TokenCredential interface from the @azure/identity package are recommended. For | ||
| * more information about these credentials, see | ||
| * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the | ||
| * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and | ||
| * @azure/ms-rest-browserauth are also supported. | ||
| * @param subscriptionId Gets subscription ID which uniquely identify the Microsoft Azure | ||
@@ -21,0 +26,0 @@ * subscription. The subscription ID forms part of the URI for every service call. |
| 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"; | ||
| export declare class AppPlatformManagementClientContext extends msRestAzure.AzureServiceClient { | ||
| credentials: msRest.ServiceClientCredentials; | ||
| credentials: msRest.ServiceClientCredentials | TokenCredential; | ||
| apiVersion?: string; | ||
@@ -10,3 +11,8 @@ subscriptionId: string; | ||
| * Initializes a new instance of the AppPlatformManagementClient class. | ||
| * @param credentials Credentials needed for the client to connect to Azure. | ||
| * @param credentials Credentials needed for the client to connect to Azure. Credentials | ||
| * implementing the TokenCredential interface from the @azure/identity package are recommended. For | ||
| * more information about these credentials, see | ||
| * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the | ||
| * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and | ||
| * @azure/ms-rest-browserauth are also supported. | ||
| * @param subscriptionId Gets subscription ID which uniquely identify the Microsoft Azure | ||
@@ -16,4 +22,4 @@ * subscription. The subscription ID forms part of the URI for every service call. | ||
| */ | ||
| constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.AppPlatformManagementClientOptions); | ||
| constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AppPlatformManagementClientOptions); | ||
| } | ||
| //# sourceMappingURL=appPlatformManagementClientContext.d.ts.map |
@@ -12,3 +12,3 @@ /* | ||
| var packageName = "@azure/arm-appplatform"; | ||
| var packageVersion = "1.2.0"; | ||
| var packageVersion = "1.3.0"; | ||
| var AppPlatformManagementClientContext = /** @class */ (function (_super) { | ||
@@ -18,3 +18,8 @@ __extends(AppPlatformManagementClientContext, _super); | ||
| * Initializes a new instance of the AppPlatformManagementClient class. | ||
| * @param credentials Credentials needed for the client to connect to Azure. | ||
| * @param credentials Credentials needed for the client to connect to Azure. Credentials | ||
| * implementing the TokenCredential interface from the @azure/identity package are recommended. For | ||
| * more information about these credentials, see | ||
| * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the | ||
| * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and | ||
| * @azure/ms-rest-browserauth are also supported. | ||
| * @param subscriptionId Gets subscription ID which uniquely identify the Microsoft Azure | ||
@@ -21,0 +26,0 @@ * subscription. The subscription ID forms part of the URI for every service call. |
@@ -5,6 +5,7 @@ { | ||
| "description": "AppPlatformManagementClient Library with typescript type definitions for node.js and browser.", | ||
| "version": "1.2.0", | ||
| "version": "1.3.0", | ||
| "dependencies": { | ||
| "@azure/ms-rest-azure-js": "^2.0.1", | ||
| "@azure/ms-rest-js": "^2.0.4", | ||
| "@azure/ms-rest-azure-js": "^2.1.0", | ||
| "@azure/ms-rest-js": "^2.2.0", | ||
| "@azure/core-auth": "^1.1.4", | ||
| "tslib": "^1.10.0" | ||
@@ -24,3 +25,3 @@ }, | ||
| "devDependencies": { | ||
| "typescript": "^3.5.3", | ||
| "typescript": "^3.6.0", | ||
| "rollup": "^1.18.0", | ||
@@ -27,0 +28,0 @@ "rollup-plugin-node-resolve": "^5.2.0", |
108
README.md
| ## Azure AppPlatformManagementClient SDK for JavaScript | ||
| This package contains an isomorphic SDK for AppPlatformManagementClient. | ||
| This package contains an isomorphic SDK (runs both in Node.js and in browsers) for AppPlatformManagementClient. | ||
| ### Currently supported environments | ||
| - Node.js version 6.x.x or higher | ||
| - Browser JavaScript | ||
| - [LTS versions of Node.js](https://nodejs.org/about/releases/) | ||
| - Latest versions of Safari, Chrome, Edge, and Firefox. | ||
| ### How to Install | ||
| ### Prerequisites | ||
| You must have an [Azure subscription](https://azure.microsoft.com/free/). | ||
| ### How to install | ||
| To use this SDK in your project, you will need to install two packages. | ||
| - `@azure/arm-appplatform` that contains the client. | ||
| - `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory. | ||
| Install both packages using the below command: | ||
| ```bash | ||
| npm install @azure/arm-appplatform | ||
| 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. | ||
| ### How to use | ||
| #### nodejs - client creation and get services as an example written in TypeScript. | ||
| - If you are writing a client side browser application, | ||
| - Follow the instructions in the section on Authenticating client side browser applications in [Azure Identity examples](https://aka.ms/azsdk/js/identity/examples) to register your application in the Microsoft identity platform and set the right permissions. | ||
| - Copy the client ID and tenant ID from the Overview section of your app registration in Azure portal and use it in the browser sample below. | ||
| - If you are writing a server side application, | ||
| - [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples) | ||
| - Complete the set up steps required by the credential if any. | ||
| - Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below. | ||
| ##### Install @azure/ms-rest-nodeauth | ||
| 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. | ||
| - Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`. | ||
| ```bash | ||
| npm install @azure/ms-rest-nodeauth@"^3.0.0" | ||
| ``` | ||
| #### nodejs - Authentication, client creation, and get services as an example written in JavaScript. | ||
| ##### Sample code | ||
| While the below sample uses the interactive login, other authentication options can be found in the [README.md file of @azure/ms-rest-nodeauth](https://www.npmjs.com/package/@azure/ms-rest-nodeauth) package | ||
| ```typescript | ||
| const msRestNodeAuth = require("@azure/ms-rest-nodeauth"); | ||
| ```javascript | ||
| const { DefaultAzureCredential } = require("@azure/identity"); | ||
| const { AppPlatformManagementClient } = require("@azure/arm-appplatform"); | ||
| const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; | ||
| msRestNodeAuth.interactiveLogin().then((creds) => { | ||
| const client = new AppPlatformManagementClient(creds, subscriptionId); | ||
| const resourceGroupName = "testresourceGroupName"; | ||
| const serviceName = "testserviceName"; | ||
| client.services.get(resourceGroupName, serviceName).then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }); | ||
| // Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples | ||
| // Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead. | ||
| const creds = new DefaultAzureCredential(); | ||
| const client = new AppPlatformManagementClient(creds, subscriptionId); | ||
| const resourceGroupName = "testresourceGroupName"; | ||
| const serviceName = "testserviceName"; | ||
| client.services.get(resourceGroupName, serviceName).then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }).catch((err) => { | ||
| console.log("An error occurred:"); | ||
| console.error(err); | ||
@@ -48,15 +65,12 @@ }); | ||
| #### browser - Authentication, client creation and get services as an example written in JavaScript. | ||
| #### browser - Authentication, client creation, and get services as an example written in JavaScript. | ||
| ##### Install @azure/ms-rest-browserauth | ||
| In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser. | ||
| - See [Single-page application: App registration guide](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) to configure your app registration for the browser. | ||
| - Note down the client Id from the previous step and use it in the browser sample below. | ||
| ```bash | ||
| npm install @azure/ms-rest-browserauth | ||
| ``` | ||
| ##### Sample code | ||
| See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. | ||
| - index.html | ||
| - index.html | ||
| ```html | ||
@@ -67,27 +81,23 @@ <!DOCTYPE html> | ||
| <title>@azure/arm-appplatform sample</title> | ||
| <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script> | ||
| <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script> | ||
| <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script> | ||
| <script src="node_modules/@azure/identity/dist/index.js"></script> | ||
| <script src="node_modules/@azure/arm-appplatform/dist/arm-appplatform.js"></script> | ||
| <script type="text/javascript"> | ||
| const subscriptionId = "<Subscription_Id>"; | ||
| const authManager = new msAuth.AuthManager({ | ||
| // Create credentials using the `@azure/identity` package. | ||
| // Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead. | ||
| const credential = new InteractiveBrowserCredential( | ||
| { | ||
| clientId: "<client id for your Azure AD app>", | ||
| tenant: "<optional tenant for your organization>" | ||
| tenantId: "<optional tenant for your organization>" | ||
| }); | ||
| authManager.finalizeLogin().then((res) => { | ||
| if (!res.isLoggedIn) { | ||
| // may cause redirects | ||
| authManager.login(); | ||
| } | ||
| const client = new Azure.ArmAppplatform.AppPlatformManagementClient(res.creds, subscriptionId); | ||
| const resourceGroupName = "testresourceGroupName"; | ||
| const serviceName = "testserviceName"; | ||
| client.services.get(resourceGroupName, serviceName).then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }).catch((err) => { | ||
| console.log("An error occurred:"); | ||
| console.error(err); | ||
| }); | ||
| const client = new Azure.ArmAppplatform.AppPlatformManagementClient(creds, subscriptionId); | ||
| const resourceGroupName = "testresourceGroupName"; | ||
| const serviceName = "testserviceName"; | ||
| client.services.get(resourceGroupName, serviceName).then((result) => { | ||
| console.log("The result is:"); | ||
| console.log(result); | ||
| }).catch((err) => { | ||
| console.log("An error occurred:"); | ||
| console.error(err); | ||
| }); | ||
@@ -94,0 +104,0 @@ </script> |
@@ -11,2 +11,3 @@ /* | ||
| import * as msRest from "@azure/ms-rest-js"; | ||
| import { TokenCredential } from "@azure/core-auth"; | ||
| import * as Models from "./models"; | ||
@@ -34,3 +35,8 @@ import * as Mappers from "./models/mappers"; | ||
| * Initializes a new instance of the AppPlatformManagementClient class. | ||
| * @param credentials Credentials needed for the client to connect to Azure. | ||
| * @param credentials Credentials needed for the client to connect to Azure. Credentials | ||
| * implementing the TokenCredential interface from the @azure/identity package are recommended. For | ||
| * more information about these credentials, see | ||
| * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the | ||
| * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and | ||
| * @azure/ms-rest-browserauth are also supported. | ||
| * @param subscriptionId Gets subscription ID which uniquely identify the Microsoft Azure | ||
@@ -40,3 +46,3 @@ * subscription. The subscription ID forms part of the URI for every service call. | ||
| */ | ||
| constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.AppPlatformManagementClientOptions) { | ||
| constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AppPlatformManagementClientOptions) { | ||
| super(credentials, subscriptionId, options); | ||
@@ -43,0 +49,0 @@ this.services = new operations.Services(this); |
@@ -12,9 +12,10 @@ /* | ||
| import * as msRest from "@azure/ms-rest-js"; | ||
| import { TokenCredential } from "@azure/core-auth"; | ||
| import * as msRestAzure from "@azure/ms-rest-azure-js"; | ||
| const packageName = "@azure/arm-appplatform"; | ||
| const packageVersion = "1.2.0"; | ||
| const packageVersion = "1.3.0"; | ||
| export class AppPlatformManagementClientContext extends msRestAzure.AzureServiceClient { | ||
| credentials: msRest.ServiceClientCredentials; | ||
| credentials: msRest.ServiceClientCredentials | TokenCredential; | ||
| apiVersion?: string; | ||
@@ -25,3 +26,8 @@ subscriptionId: string; | ||
| * Initializes a new instance of the AppPlatformManagementClient class. | ||
| * @param credentials Credentials needed for the client to connect to Azure. | ||
| * @param credentials Credentials needed for the client to connect to Azure. Credentials | ||
| * implementing the TokenCredential interface from the @azure/identity package are recommended. For | ||
| * more information about these credentials, see | ||
| * {@link https://www.npmjs.com/package/@azure/identity}. Credentials implementing the | ||
| * ServiceClientCredentials interface from the older packages @azure/ms-rest-nodeauth and | ||
| * @azure/ms-rest-browserauth are also supported. | ||
| * @param subscriptionId Gets subscription ID which uniquely identify the Microsoft Azure | ||
@@ -31,3 +37,3 @@ * subscription. The subscription ID forms part of the URI for every service call. | ||
| */ | ||
| constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.AppPlatformManagementClientOptions) { | ||
| constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.AppPlatformManagementClientOptions) { | ||
| if (credentials == undefined) { | ||
@@ -34,0 +40,0 @@ throw new Error('\'credentials\' cannot be null.'); |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
No alert changes
Improved metrics
- Total package byte prevSize
1619148
0.43%- Lines of code
26028
0.17%- Number of lines in readme file
113
9.71%Worsened metrics
- Dependency count
4
33.33%Dependency changes
+ Added
@azure/core-auth@^1.1.4Updated
@azure/ms-rest-js@^2.2.0