diff --git a/sdk/notificationhubs/arm-notificationhubs/LICENSE.txt b/sdk/notificationhubs/arm-notificationhubs/LICENSE.txt index a70e8cf66038..2d3163745319 100644 --- a/sdk/notificationhubs/arm-notificationhubs/LICENSE.txt +++ b/sdk/notificationhubs/arm-notificationhubs/LICENSE.txt @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2018 Microsoft +Copyright (c) 2021 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 diff --git a/sdk/notificationhubs/arm-notificationhubs/README.md b/sdk/notificationhubs/arm-notificationhubs/README.md index a532f90ee1d2..fb6981b7040b 100644 --- a/sdk/notificationhubs/arm-notificationhubs/README.md +++ b/sdk/notificationhubs/arm-notificationhubs/README.md @@ -1,89 +1,97 @@ ## Azure NotificationHubsManagementClient SDK for JavaScript -This package contains an isomorphic SDK for NotificationHubsManagementClient. +This package contains an isomorphic SDK (runs both in node.js and in browsers) for NotificationHubsManagementClient. ### 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-notificationhubs` 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 --save @azure/arm-notificationhubs @azure/identity ``` -npm install @azure/arm-notificationhubs -``` +> **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 - Authentication, client creation and list operations 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 - -``` -npm 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. +#### nodejs - Authentication, client creation, and list operations as an example written in JavaScript. ##### Sample code -```ts -import * as msRest from "@azure/ms-rest-js"; -import * as msRestAzure from "@azure/ms-rest-azure-js"; -import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; -import { NotificationHubsManagementClient, NotificationHubsManagementModels, NotificationHubsManagementMappers } from "@azure/arm-notificationhubs"; +```javascript +const { DefaultAzureCredential } = require("@azure/identity"); +const { NotificationHubsManagementClient } = require("@azure/arm-notificationhubs"); const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; -msRestNodeAuth.interactiveLogin().then((creds) => { - const client = new NotificationHubsManagementClient(creds, subscriptionId); - client.operations.list().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 NotificationHubsManagementClient(creds, subscriptionId); +client.operations.list().then((result) => { + console.log("The result is:"); + console.log(result); }).catch((err) => { + console.log("An error occurred:"); console.error(err); }); ``` -#### browser - Authentication, client creation and list operations as an example written in JavaScript. +#### browser - Authentication, client creation, and list operations as an example written in JavaScript. -##### Install @azure/ms-rest-browserauth - -``` -npm 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. ##### Sample code -See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. - - index.html + ```html @azure/arm-notificationhubs sample - - + @@ -95,5 +103,4 @@ See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) - -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fnotificationhubs%2Farm-notificationhubs%2FREADME.png) +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/notificationhubs/arm-notificationhubs/README.png) diff --git a/sdk/notificationhubs/arm-notificationhubs/package.json b/sdk/notificationhubs/arm-notificationhubs/package.json index 0f31c8842534..641bc4af2a81 100644 --- a/sdk/notificationhubs/arm-notificationhubs/package.json +++ b/sdk/notificationhubs/arm-notificationhubs/package.json @@ -4,9 +4,10 @@ "description": "NotificationHubsManagementClient Library with typescript type definitions for node.js and browser.", "version": "1.2.0", "dependencies": { - "@azure/ms-rest-azure-js": "^1.1.0", - "@azure/ms-rest-js": "^1.1.0", - "tslib": "^1.9.3" + "@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" }, "keywords": [ "node", @@ -20,18 +21,19 @@ "module": "./esm/notificationHubsManagementClient.js", "types": "./esm/notificationHubsManagementClient.d.ts", "devDependencies": { - "typescript": "^3.1.1", - "rollup": "^0.66.2", - "rollup-plugin-node-resolve": "^3.4.0", - "uglify-js": "^3.4.9" + "typescript": "^3.6.0", + "rollup": "^1.18.0", + "rollup-plugin-node-resolve": "^5.2.0", + "rollup-plugin-sourcemaps": "^0.4.2", + "uglify-js": "^3.6.0" }, - "homepage": "https://github.com/azure/azure-sdk-for-js/tree/main/sdk/notificationhubs/arm-notificationhubs", + "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/notificationhubs/arm-notificationhubs", "repository": { "type": "git", - "url": "https://github.com/azure/azure-sdk-for-js.git" + "url": "https://github.com/Azure/azure-sdk-for-js.git" }, "bugs": { - "url": "https://github.com/azure/azure-sdk-for-js/issues" + "url": "https://github.com/Azure/azure-sdk-for-js/issues" }, "files": [ "dist/**/*.js", @@ -43,6 +45,7 @@ "esm/**/*.d.ts", "esm/**/*.d.ts.map", "src/**/*.ts", + "README.md", "rollup.config.js", "tsconfig.json" ], diff --git a/sdk/notificationhubs/arm-notificationhubs/rollup.config.js b/sdk/notificationhubs/arm-notificationhubs/rollup.config.js index 9b1ab0e7eed3..7eb2f9517466 100644 --- a/sdk/notificationhubs/arm-notificationhubs/rollup.config.js +++ b/sdk/notificationhubs/arm-notificationhubs/rollup.config.js @@ -1,10 +1,16 @@ +import rollup from "rollup"; import nodeResolve from "rollup-plugin-node-resolve"; +import sourcemaps from "rollup-plugin-sourcemaps"; + /** - * @type {import('rollup').RollupFileOptions} + * @type {rollup.RollupFileOptions} */ const config = { - input: './esm/notificationHubsManagementClient.js', - external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"], + input: "./esm/notificationHubsManagementClient.js", + external: [ + "@azure/ms-rest-js", + "@azure/ms-rest-azure-js" + ], output: { file: "./dist/arm-notificationhubs.js", format: "umd", @@ -15,17 +21,17 @@ const config = { "@azure/ms-rest-azure-js": "msRestAzure" }, banner: `/* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */` }, plugins: [ - nodeResolve({ module: true }) + nodeResolve({ mainFields: ['module', 'main'] }), + sourcemaps() ] }; + export default config; diff --git a/sdk/notificationhubs/arm-notificationhubs/src/models/index.ts b/sdk/notificationhubs/arm-notificationhubs/src/models/index.ts index fb9ee9c84803..36e125303d5c 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/models/index.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/models/index.ts @@ -1,11 +1,9 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js"; @@ -13,1046 +11,849 @@ import * as msRest from "@azure/ms-rest-js"; export { BaseResource, CloudError }; - /** - * @interface - * An interface representing OperationDisplay. * The object that represents the operation. - * */ export interface OperationDisplay { /** - * @member {string} [provider] Service provider: Microsoft.NotificationHubs - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Service provider: Microsoft.NotificationHubs + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly provider?: string; /** - * @member {string} [resource] Resource on which the operation is performed: - * Invoice, etc. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Resource on which the operation is performed: Invoice, etc. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly resource?: string; /** - * @member {string} [operation] Operation type: Read, write, delete, etc. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Operation type: Read, write, delete, etc. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly operation?: string; } /** - * @interface - * An interface representing Operation. * A NotificationHubs REST API operation - * */ export interface Operation { /** - * @member {string} [name] Operation name: {provider}/{resource}/{operation} - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Operation name: {provider}/{resource}/{operation} + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly name?: string; /** - * @member {OperationDisplay} [display] The object that represents the - * operation. + * The object that represents the operation. */ display?: OperationDisplay; } /** - * @interface - * An interface representing ErrorResponse. - * Error reponse indicates NotificationHubs service is not able to process the - * incoming request. The reason is provided in the error message. - * + * Error response indicates NotificationHubs service is not able to process the incoming request. + * The reason is provided in the error message. */ export interface ErrorResponse { /** - * @member {string} [code] Error code. + * Error code. */ code?: string; /** - * @member {string} [message] Error message indicating why the operation - * failed. + * Error message indicating why the operation failed. */ message?: string; } /** - * @interface - * An interface representing Sku. * The Sku description for a namespace - * */ export interface Sku { /** - * @member {SkuName} name Name of the notification hub sku. Possible values - * include: 'Free', 'Basic', 'Standard' + * Name of the notification hub sku. Possible values include: 'Free', 'Basic', 'Standard' */ name: SkuName; /** - * @member {string} [tier] The tier of particular sku + * The tier of particular sku */ tier?: string; /** - * @member {string} [size] The Sku size + * The Sku size */ size?: string; /** - * @member {string} [family] The Sku Family + * The Sku Family */ family?: string; /** - * @member {number} [capacity] The capacity of the resource + * The capacity of the resource */ capacity?: number; } /** - * @interface - * An interface representing CheckAvailabilityParameters. - * Parameters supplied to the Check Name Availability for Namespace and - * NotificationHubs. - * + * Parameters supplied to the Check Name Availability for Namespace and NotificationHubs. */ export interface CheckAvailabilityParameters { /** - * @member {string} [id] Resource Id - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Resource Id + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly id?: string; /** - * @member {string} name Resource name + * Resource name */ name: string; /** - * @member {string} [type] Resource type - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Resource type + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly type?: string; /** - * @member {string} [location] Resource location + * Resource location */ location?: string; /** - * @member {{ [propertyName: string]: string }} [tags] Resource tags + * Resource tags */ tags?: { [propertyName: string]: string }; /** - * @member {Sku} [sku] The sku of the created namespace + * The sku of the created namespace */ sku?: Sku; /** - * @member {boolean} [isAvailiable] True if the name is available and can be - * used to create new Namespace/NotificationHub. Otherwise false. + * True if the name is available and can be used to create new Namespace/NotificationHub. + * Otherwise false. */ isAvailiable?: boolean; } /** - * @interface * An interface representing Resource. - * @extends BaseResource */ export interface Resource extends BaseResource { /** - * @member {string} [id] Resource Id - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Resource Id + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly id?: string; /** - * @member {string} [name] Resource name - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Resource name + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly name?: string; /** - * @member {string} [type] Resource type - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Resource type + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly type?: string; /** - * @member {string} [location] Resource location + * Resource location */ location?: string; /** - * @member {{ [propertyName: string]: string }} [tags] Resource tags + * Resource tags */ tags?: { [propertyName: string]: string }; /** - * @member {Sku} [sku] The sku of the created namespace + * The sku of the created namespace */ sku?: Sku; } /** - * @interface - * An interface representing CheckAvailabilityResult. - * Description of a CheckAvailibility resource. - * - * @extends Resource + * Description of a CheckAvailability resource. */ export interface CheckAvailabilityResult extends Resource { /** - * @member {boolean} [isAvailiable] True if the name is available and can be - * used to create new Namespace/NotificationHub. Otherwise false. + * True if the name is available and can be used to create new Namespace/NotificationHub. + * Otherwise false. */ isAvailiable?: boolean; } /** - * @interface - * An interface representing NamespaceCreateOrUpdateParameters. * Parameters supplied to the CreateOrUpdate Namespace operation. - * - * @extends Resource */ export interface NamespaceCreateOrUpdateParameters extends Resource { /** - * @member {string} [namespaceCreateOrUpdateParametersName] The name of the - * namespace. + * The name of the namespace. */ namespaceCreateOrUpdateParametersName?: string; /** - * @member {string} [provisioningState] Provisioning state of the Namespace. + * Provisioning state of the Namespace. */ provisioningState?: string; /** - * @member {string} [region] Specifies the targeted region in which the - * namespace should be created. It can be any of the following values: - * Australia EastAustralia SoutheastCentral USEast USEast US 2West USNorth - * Central USSouth Central USEast AsiaSoutheast AsiaBrazil SouthJapan - * EastJapan WestNorth EuropeWest Europe + * Specifies the targeted region in which the namespace should be created. It can be any of the + * following values: Australia East, Australia Southeast, Central US, East US, East US 2, West + * US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, + * Japan West, North Europe, West Europe */ region?: string; /** - * @member {string} [metricId] Identifier for Azure Insights metrics - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Identifier for Azure Insights metrics + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly metricId?: string; /** - * @member {string} [status] Status of the namespace. It can be any of these - * values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting + * Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = + * Suspended4 = Deleting */ status?: string; /** - * @member {Date} [createdAt] The time the namespace was created. + * The time the namespace was created. */ createdAt?: Date; /** - * @member {Date} [updatedAt] The time the namespace was updated. + * The time the namespace was updated. */ updatedAt?: Date; /** - * @member {string} [serviceBusEndpoint] Endpoint you can use to perform - * NotificationHub operations. + * Endpoint you can use to perform NotificationHub operations. */ serviceBusEndpoint?: string; /** - * @member {string} [subscriptionId] The Id of the Azure subscription - * associated with the namespace. + * The Id of the Azure subscription associated with the namespace. */ subscriptionId?: string; /** - * @member {string} [scaleUnit] ScaleUnit where the namespace gets created + * ScaleUnit where the namespace gets created */ scaleUnit?: string; /** - * @member {boolean} [enabled] Whether or not the namespace is currently - * enabled. + * Whether or not the namespace is currently enabled. */ enabled?: boolean; /** - * @member {boolean} [critical] Whether or not the namespace is set as - * Critical. + * Whether or not the namespace is set as Critical. */ critical?: boolean; /** - * @member {string} [dataCenter] Data center for the namespace + * Data center for the namespace */ dataCenter?: string; /** - * @member {NamespaceType} [namespaceType] The namespace type. Possible - * values include: 'Messaging', 'NotificationHub' + * The namespace type. Possible values include: 'Messaging', 'NotificationHub' */ namespaceType?: NamespaceType; } /** - * @interface - * An interface representing NamespacePatchParameters. * Parameters supplied to the Patch Namespace operation. - * */ export interface NamespacePatchParameters { /** - * @member {{ [propertyName: string]: string }} [tags] Resource tags + * Resource tags */ tags?: { [propertyName: string]: string }; /** - * @member {Sku} [sku] The sku of the created namespace + * The sku of the created namespace */ sku?: Sku; } /** - * @interface - * An interface representing NamespaceResource. * Description of a Namespace resource. - * - * @extends Resource */ export interface NamespaceResource extends Resource { /** - * @member {string} [namespaceResourceName] The name of the namespace. + * The name of the namespace. */ namespaceResourceName?: string; /** - * @member {string} [provisioningState] Provisioning state of the Namespace. + * Provisioning state of the Namespace. */ provisioningState?: string; /** - * @member {string} [region] Specifies the targeted region in which the - * namespace should be created. It can be any of the following values: - * Australia EastAustralia SoutheastCentral USEast USEast US 2West USNorth - * Central USSouth Central USEast AsiaSoutheast AsiaBrazil SouthJapan - * EastJapan WestNorth EuropeWest Europe + * Specifies the targeted region in which the namespace should be created. It can be any of the + * following values: Australia East, Australia Southeast, Central US, East US, East US 2, West + * US, North Central US, South Central US, East Asia, Southeast Asia, Brazil South, Japan East, + * Japan West, North Europe, West Europe */ region?: string; /** - * @member {string} [metricId] Identifier for Azure Insights metrics - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * Identifier for Azure Insights metrics + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly metricId?: string; /** - * @member {string} [status] Status of the namespace. It can be any of these - * values:1 = Created/Active2 = Creating3 = Suspended4 = Deleting + * Status of the namespace. It can be any of these values:1 = Created/Active2 = Creating3 = + * Suspended4 = Deleting */ status?: string; /** - * @member {Date} [createdAt] The time the namespace was created. + * The time the namespace was created. */ createdAt?: Date; /** - * @member {Date} [updatedAt] The time the namespace was updated. + * The time the namespace was updated. */ updatedAt?: Date; /** - * @member {string} [serviceBusEndpoint] Endpoint you can use to perform - * NotificationHub operations. + * Endpoint you can use to perform NotificationHub operations. */ serviceBusEndpoint?: string; /** - * @member {string} [subscriptionId] The Id of the Azure subscription - * associated with the namespace. + * The Id of the Azure subscription associated with the namespace. */ subscriptionId?: string; /** - * @member {string} [scaleUnit] ScaleUnit where the namespace gets created + * ScaleUnit where the namespace gets created */ scaleUnit?: string; /** - * @member {boolean} [enabled] Whether or not the namespace is currently - * enabled. + * Whether or not the namespace is currently enabled. */ enabled?: boolean; /** - * @member {boolean} [critical] Whether or not the namespace is set as - * Critical. + * Whether or not the namespace is set as Critical. */ critical?: boolean; /** - * @member {string} [dataCenter] Data center for the namespace + * Data center for the namespace */ dataCenter?: string; /** - * @member {NamespaceType} [namespaceType] The namespace type. Possible - * values include: 'Messaging', 'NotificationHub' + * The namespace type. Possible values include: 'Messaging', 'NotificationHub' */ namespaceType?: NamespaceType; } /** - * @interface - * An interface representing SharedAccessAuthorizationRuleProperties. * SharedAccessAuthorizationRule properties. - * */ export interface SharedAccessAuthorizationRuleProperties { /** - * @member {AccessRights[]} [rights] The rights associated with the rule. + * The rights associated with the rule. */ rights?: AccessRights[]; /** - * @member {string} [primaryKey] A base64-encoded 256-bit primary key for - * signing and validating the SAS token. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A base64-encoded 256-bit primary key for signing and validating the SAS token. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly primaryKey?: string; /** - * @member {string} [secondaryKey] A base64-encoded 256-bit primary key for - * signing and validating the SAS token. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A base64-encoded 256-bit primary key for signing and validating the SAS token. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly secondaryKey?: string; /** - * @member {string} [keyName] A string that describes the authorization rule. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A string that describes the authorization rule. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly keyName?: string; /** - * @member {string} [claimType] A string that describes the claim type - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A string that describes the claim type + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly claimType?: string; /** - * @member {string} [claimValue] A string that describes the claim value - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A string that describes the claim value + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly claimValue?: string; /** - * @member {string} [modifiedTime] The last modified time for this rule - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The last modified time for this rule + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly modifiedTime?: string; /** - * @member {string} [createdTime] The created time for this rule - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The created time for this rule + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly createdTime?: string; /** - * @member {number} [revision] The revision number for the rule - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The revision number for the rule + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly revision?: number; } /** - * @interface - * An interface representing SharedAccessAuthorizationRuleCreateOrUpdateParameters. * Parameters supplied to the CreateOrUpdate Namespace AuthorizationRules. - * */ export interface SharedAccessAuthorizationRuleCreateOrUpdateParameters { /** - * @member {SharedAccessAuthorizationRuleProperties} properties Properties of - * the Namespace AuthorizationRules. + * Properties of the Namespace AuthorizationRules. */ properties: SharedAccessAuthorizationRuleProperties; } /** - * @interface - * An interface representing SharedAccessAuthorizationRuleResource. * Description of a Namespace AuthorizationRules. - * - * @extends Resource */ export interface SharedAccessAuthorizationRuleResource extends Resource { /** - * @member {AccessRights[]} [rights] The rights associated with the rule. + * The rights associated with the rule. */ rights?: AccessRights[]; /** - * @member {string} [primaryKey] A base64-encoded 256-bit primary key for - * signing and validating the SAS token. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A base64-encoded 256-bit primary key for signing and validating the SAS token. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly primaryKey?: string; /** - * @member {string} [secondaryKey] A base64-encoded 256-bit primary key for - * signing and validating the SAS token. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A base64-encoded 256-bit primary key for signing and validating the SAS token. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly secondaryKey?: string; /** - * @member {string} [keyName] A string that describes the authorization rule. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A string that describes the authorization rule. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly keyName?: string; /** - * @member {string} [claimType] A string that describes the claim type - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A string that describes the claim type + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly claimType?: string; /** - * @member {string} [claimValue] A string that describes the claim value - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * A string that describes the claim value + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly claimValue?: string; /** - * @member {string} [modifiedTime] The last modified time for this rule - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The last modified time for this rule + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly modifiedTime?: string; /** - * @member {string} [createdTime] The created time for this rule - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The created time for this rule + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly createdTime?: string; /** - * @member {number} [revision] The revision number for the rule - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * The revision number for the rule + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly revision?: number; } /** - * @interface - * An interface representing ResourceListKeys. * Namespace/NotificationHub Connection String - * */ export interface ResourceListKeys { /** - * @member {string} [primaryConnectionString] PrimaryConnectionString of the - * AuthorizationRule. + * PrimaryConnectionString of the AuthorizationRule. */ primaryConnectionString?: string; /** - * @member {string} [secondaryConnectionString] SecondaryConnectionString of - * the created AuthorizationRule + * SecondaryConnectionString of the created AuthorizationRule */ secondaryConnectionString?: string; /** - * @member {string} [primaryKey] PrimaryKey of the created AuthorizationRule. + * PrimaryKey of the created AuthorizationRule. */ primaryKey?: string; /** - * @member {string} [secondaryKey] SecondaryKey of the created - * AuthorizationRule + * SecondaryKey of the created AuthorizationRule */ secondaryKey?: string; /** - * @member {string} [keyName] KeyName of the created AuthorizationRule + * KeyName of the created AuthorizationRule */ keyName?: string; } /** - * @interface - * An interface representing PolicykeyResource. * Namespace/NotificationHub Regenerate Keys - * */ export interface PolicykeyResource { /** - * @member {string} [policyKey] Name of the key that has to be regenerated - * for the Namespace/Notification Hub Authorization Rule. The value can be - * Primary Key/Secondary Key. + * Name of the key that has to be regenerated for the Namespace/Notification Hub Authorization + * Rule. The value can be Primary Key/Secondary Key. */ policyKey?: string; } /** - * @interface - * An interface representing ApnsCredential. * Description of a NotificationHub ApnsCredential. - * */ export interface ApnsCredential { /** - * @member {string} [apnsCertificate] The APNS certificate. + * The APNS certificate. Specify if using Certificate Authentication Mode. */ apnsCertificate?: string; /** - * @member {string} [certificateKey] The certificate key. + * The APNS certificate password if it exists. */ certificateKey?: string; /** - * @member {string} [endpoint] The endpoint of this credential. + * The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox + * specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and + * Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox + * specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication + * Mode and Production specify 'https://api.push.apple.com:443/3/device'. */ endpoint?: string; /** - * @member {string} [thumbprint] The Apns certificate Thumbprint + * The APNS certificate thumbprint. Specify if using Certificate Authentication Mode. */ thumbprint?: string; /** - * @member {string} [keyId] A 10-character key identifier (kid) key, obtained - * from your developer account + * A 10-character key identifier (kid) key, obtained from your developer account. Specify if + * using Token Authentication Mode. */ keyId?: string; /** - * @member {string} [appName] The name of the application + * The name of the application or BundleId. Specify if using Token Authentication Mode. */ appName?: string; /** - * @member {string} [appId] The issuer (iss) registered claim key, whose - * value is your 10-character Team ID, obtained from your developer account + * The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your + * developer account. Specify if using Token Authentication Mode. */ appId?: string; /** - * @member {string} [token] Provider Authentication Token, obtained through - * your developer account + * Provider Authentication Token, obtained through your developer account. Specify if using Token + * Authentication Mode. */ token?: string; } /** - * @interface - * An interface representing WnsCredential. * Description of a NotificationHub WnsCredential. - * */ export interface WnsCredential { /** - * @member {string} [packageSid] The package ID for this credential. + * The package ID for this credential. */ packageSid?: string; /** - * @member {string} [secretKey] The secret key. + * The secret key. */ secretKey?: string; /** - * @member {string} [windowsLiveEndpoint] The Windows Live endpoint. + * The Windows Live endpoint. */ windowsLiveEndpoint?: string; } /** - * @interface - * An interface representing GcmCredential. * Description of a NotificationHub GcmCredential. - * */ export interface GcmCredential { /** - * @member {string} [gcmEndpoint] The GCM endpoint. + * The FCM legacy endpoint. Default value is 'https://fcm.googleapis.com/fcm/send' */ gcmEndpoint?: string; /** - * @member {string} [googleApiKey] The Google API key. + * The Google API key. */ googleApiKey?: string; } /** - * @interface - * An interface representing MpnsCredential. * Description of a NotificationHub MpnsCredential. - * */ export interface MpnsCredential { /** - * @member {string} [mpnsCertificate] The MPNS certificate. + * The MPNS certificate. */ mpnsCertificate?: string; /** - * @member {string} [certificateKey] The certificate key for this credential. + * The certificate key for this credential. */ certificateKey?: string; /** - * @member {string} [thumbprint] The Mpns certificate Thumbprint + * The MPNS certificate Thumbprint */ thumbprint?: string; } /** - * @interface - * An interface representing AdmCredential. * Description of a NotificationHub AdmCredential. - * */ export interface AdmCredential { /** - * @member {string} [clientId] The client identifier. + * The client identifier. */ clientId?: string; /** - * @member {string} [clientSecret] The credential secret access key. + * The credential secret access key. */ clientSecret?: string; /** - * @member {string} [authTokenUrl] The URL of the authorization token. + * The URL of the authorization token. */ authTokenUrl?: string; } /** - * @interface - * An interface representing BaiduCredential. * Description of a NotificationHub BaiduCredential. - * */ export interface BaiduCredential { /** - * @member {string} [baiduApiKey] Baidu Api Key. + * Baidu Api Key. */ baiduApiKey?: string; /** - * @member {string} [baiduEndPoint] Baidu Endpoint. + * Baidu Endpoint. */ baiduEndPoint?: string; /** - * @member {string} [baiduSecretKey] Baidu Secret Key + * Baidu Secret Key */ baiduSecretKey?: string; } /** - * @interface - * An interface representing NotificationHubCreateOrUpdateParameters. * Parameters supplied to the CreateOrUpdate NotificationHub operation. - * - * @extends Resource */ export interface NotificationHubCreateOrUpdateParameters extends Resource { /** - * @member {string} [notificationHubCreateOrUpdateParametersName] The - * NotificationHub name. + * The NotificationHub name. */ notificationHubCreateOrUpdateParametersName?: string; /** - * @member {string} [registrationTtl] The RegistrationTtl of the created - * NotificationHub + * The RegistrationTtl of the created NotificationHub */ registrationTtl?: string; /** - * @member {SharedAccessAuthorizationRuleProperties[]} [authorizationRules] * The AuthorizationRules of the created NotificationHub */ authorizationRules?: SharedAccessAuthorizationRuleProperties[]; /** - * @member {ApnsCredential} [apnsCredential] The ApnsCredential of the - * created NotificationHub + * The ApnsCredential of the created NotificationHub */ apnsCredential?: ApnsCredential; /** - * @member {WnsCredential} [wnsCredential] The WnsCredential of the created - * NotificationHub + * The WnsCredential of the created NotificationHub */ wnsCredential?: WnsCredential; /** - * @member {GcmCredential} [gcmCredential] The GcmCredential of the created - * NotificationHub + * The GcmCredential of the created NotificationHub */ gcmCredential?: GcmCredential; /** - * @member {MpnsCredential} [mpnsCredential] The MpnsCredential of the - * created NotificationHub + * The MpnsCredential of the created NotificationHub */ mpnsCredential?: MpnsCredential; /** - * @member {AdmCredential} [admCredential] The AdmCredential of the created - * NotificationHub + * The AdmCredential of the created NotificationHub */ admCredential?: AdmCredential; /** - * @member {BaiduCredential} [baiduCredential] The BaiduCredential of the - * created NotificationHub + * The BaiduCredential of the created NotificationHub */ baiduCredential?: BaiduCredential; } /** - * @interface - * An interface representing NotificationHubPatchParameters. * Parameters supplied to the patch NotificationHub operation. - * - * @extends Resource */ export interface NotificationHubPatchParameters extends Resource { /** - * @member {string} [notificationHubPatchParametersName] The NotificationHub - * name. + * The NotificationHub name. */ notificationHubPatchParametersName?: string; /** - * @member {string} [registrationTtl] The RegistrationTtl of the created - * NotificationHub + * The RegistrationTtl of the created NotificationHub */ registrationTtl?: string; /** - * @member {SharedAccessAuthorizationRuleProperties[]} [authorizationRules] * The AuthorizationRules of the created NotificationHub */ authorizationRules?: SharedAccessAuthorizationRuleProperties[]; /** - * @member {ApnsCredential} [apnsCredential] The ApnsCredential of the - * created NotificationHub + * The ApnsCredential of the created NotificationHub */ apnsCredential?: ApnsCredential; /** - * @member {WnsCredential} [wnsCredential] The WnsCredential of the created - * NotificationHub + * The WnsCredential of the created NotificationHub */ wnsCredential?: WnsCredential; /** - * @member {GcmCredential} [gcmCredential] The GcmCredential of the created - * NotificationHub + * The GcmCredential of the created NotificationHub */ gcmCredential?: GcmCredential; /** - * @member {MpnsCredential} [mpnsCredential] The MpnsCredential of the - * created NotificationHub + * The MpnsCredential of the created NotificationHub */ mpnsCredential?: MpnsCredential; /** - * @member {AdmCredential} [admCredential] The AdmCredential of the created - * NotificationHub + * The AdmCredential of the created NotificationHub */ admCredential?: AdmCredential; /** - * @member {BaiduCredential} [baiduCredential] The BaiduCredential of the - * created NotificationHub + * The BaiduCredential of the created NotificationHub */ baiduCredential?: BaiduCredential; } /** - * @interface - * An interface representing NotificationHubResource. * Description of a NotificationHub Resource. - * - * @extends Resource */ export interface NotificationHubResource extends Resource { /** - * @member {string} [notificationHubResourceName] The NotificationHub name. + * The NotificationHub name. */ notificationHubResourceName?: string; /** - * @member {string} [registrationTtl] The RegistrationTtl of the created - * NotificationHub + * The RegistrationTtl of the created NotificationHub */ registrationTtl?: string; /** - * @member {SharedAccessAuthorizationRuleProperties[]} [authorizationRules] * The AuthorizationRules of the created NotificationHub */ authorizationRules?: SharedAccessAuthorizationRuleProperties[]; /** - * @member {ApnsCredential} [apnsCredential] The ApnsCredential of the - * created NotificationHub + * The ApnsCredential of the created NotificationHub */ apnsCredential?: ApnsCredential; /** - * @member {WnsCredential} [wnsCredential] The WnsCredential of the created - * NotificationHub + * The WnsCredential of the created NotificationHub */ wnsCredential?: WnsCredential; /** - * @member {GcmCredential} [gcmCredential] The GcmCredential of the created - * NotificationHub + * The GcmCredential of the created NotificationHub */ gcmCredential?: GcmCredential; /** - * @member {MpnsCredential} [mpnsCredential] The MpnsCredential of the - * created NotificationHub + * The MpnsCredential of the created NotificationHub */ mpnsCredential?: MpnsCredential; /** - * @member {AdmCredential} [admCredential] The AdmCredential of the created - * NotificationHub + * The AdmCredential of the created NotificationHub */ admCredential?: AdmCredential; /** - * @member {BaiduCredential} [baiduCredential] The BaiduCredential of the - * created NotificationHub + * The BaiduCredential of the created NotificationHub */ baiduCredential?: BaiduCredential; } /** - * @interface - * An interface representing DebugSendResponse. * Description of a NotificationHub Resource. - * - * @extends Resource */ export interface DebugSendResponse extends Resource { /** - * @member {number} [success] successful send + * successful send */ success?: number; /** - * @member {number} [failure] send failure + * send failure */ failure?: number; /** - * @member {any} [results] actual failure description + * actual failure description */ results?: any; } /** - * @interface - * An interface representing PnsCredentialsResource. * Description of a NotificationHub PNS Credentials. - * - * @extends Resource */ export interface PnsCredentialsResource extends Resource { /** - * @member {ApnsCredential} [apnsCredential] The ApnsCredential of the - * created NotificationHub + * The ApnsCredential of the created NotificationHub */ apnsCredential?: ApnsCredential; /** - * @member {WnsCredential} [wnsCredential] The WnsCredential of the created - * NotificationHub + * The WnsCredential of the created NotificationHub */ wnsCredential?: WnsCredential; /** - * @member {GcmCredential} [gcmCredential] The GcmCredential of the created - * NotificationHub + * The GcmCredential of the created NotificationHub */ gcmCredential?: GcmCredential; /** - * @member {MpnsCredential} [mpnsCredential] The MpnsCredential of the - * created NotificationHub + * The MpnsCredential of the created NotificationHub */ mpnsCredential?: MpnsCredential; /** - * @member {AdmCredential} [admCredential] The AdmCredential of the created - * NotificationHub + * The AdmCredential of the created NotificationHub */ admCredential?: AdmCredential; /** - * @member {BaiduCredential} [baiduCredential] The BaiduCredential of the - * created NotificationHub + * The BaiduCredential of the created NotificationHub */ baiduCredential?: BaiduCredential; } /** - * @interface * An interface representing SubResource. - * @extends BaseResource */ export interface SubResource extends BaseResource { /** - * @member {string} [id] Resource Id + * Resource Id */ id?: string; } /** - * @interface - * An interface representing NotificationHubsPatchOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface NotificationHubsPatchOptionalParams extends msRest.RequestOptionsBase { /** - * @member {NotificationHubPatchParameters} [parameters] Parameters supplied - * to patch a NotificationHub Resource. + * Parameters supplied to patch a NotificationHub Resource. */ parameters?: NotificationHubPatchParameters; } /** - * @interface - * An interface representing NotificationHubsDebugSendOptionalParams. * Optional Parameters. - * - * @extends RequestOptionsBase */ export interface NotificationHubsDebugSendOptionalParams extends msRest.RequestOptionsBase { /** - * @member {any} [parameters] Debug send parameters + * Debug send parameters */ parameters?: any; } /** - * @interface * An interface representing NotificationHubsManagementClientOptions. - * @extends AzureServiceClientOptions */ export interface NotificationHubsManagementClientOptions extends AzureServiceClientOptions { - /** - * @member {string} [baseUri] - */ baseUri?: string; } - /** * @interface - * An interface representing the OperationListResult. - * Result of the request to list NotificationHubs operations. It contains a - * list of operations and a URL link to get the next set of results. - * + * Result of the request to list NotificationHubs operations. It contains a list of operations and + * a URL link to get the next set of results. * @extends Array */ export interface OperationListResult extends Array { /** - * @member {string} [nextLink] URL to get the next set of operation list - * results if there are any. - * **NOTE: This property will not be serialized. It can only be populated by - * the server.** + * URL to get the next set of operation list results if there are any. + * **NOTE: This property will not be serialized. It can only be populated by the server.** */ readonly nextLink?: string; } /** * @interface - * An interface representing the NamespaceListResult. * The response of the List Namespace operation. - * * @extends Array */ export interface NamespaceListResult extends Array { /** - * @member {string} [nextLink] Link to the next set of results. Not empty if - * Value contains incomplete list of Namespaces + * Link to the next set of results. Not empty if Value contains incomplete list of Namespaces */ nextLink?: string; } /** * @interface - * An interface representing the SharedAccessAuthorizationRuleListResult. * The response of the List Namespace operation. - * * @extends Array */ export interface SharedAccessAuthorizationRuleListResult extends Array { /** - * @member {string} [nextLink] Link to the next set of results. Not empty if - * Value contains incomplete list of AuthorizationRules + * Link to the next set of results. Not empty if Value contains incomplete list of + * AuthorizationRules */ nextLink?: string; } /** * @interface - * An interface representing the NotificationHubListResult. * The response of the List NotificationHub operation. - * * @extends Array */ export interface NotificationHubListResult extends Array { /** - * @member {string} [nextLink] Link to the next set of results. Not empty if - * Value contains incomplete list of NotificationHub + * Link to the next set of results. Not empty if Value contains incomplete list of + * NotificationHub */ nextLink?: string; } @@ -1093,6 +894,7 @@ export type OperationsListResponse = OperationListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1112,6 +914,7 @@ export type OperationsListNextResponse = OperationListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1131,6 +934,7 @@ export type NamespacesCheckAvailabilityResponse = CheckAvailabilityResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1150,6 +954,7 @@ export type NamespacesCreateOrUpdateResponse = NamespaceResource & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1169,6 +974,7 @@ export type NamespacesPatchResponse = NamespaceResource & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1188,6 +994,7 @@ export type NamespacesGetResponse = NamespaceResource & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1207,6 +1014,7 @@ export type NamespacesCreateOrUpdateAuthorizationRuleResponse = SharedAccessAuth * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1226,6 +1034,7 @@ export type NamespacesGetAuthorizationRuleResponse = SharedAccessAuthorizationRu * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1245,6 +1054,7 @@ export type NamespacesListResponse = NamespaceListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1264,6 +1074,7 @@ export type NamespacesListAllResponse = NamespaceListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1283,6 +1094,7 @@ export type NamespacesListAuthorizationRulesResponse = SharedAccessAuthorization * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1302,6 +1114,7 @@ export type NamespacesListKeysResponse = SharedAccessAuthorizationRuleListResult * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1321,6 +1134,7 @@ export type NamespacesRegenerateKeysResponse = ResourceListKeys & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1340,6 +1154,7 @@ export type NamespacesListNextResponse = NamespaceListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1359,6 +1174,7 @@ export type NamespacesListAllNextResponse = NamespaceListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1378,6 +1194,7 @@ export type NamespacesListAuthorizationRulesNextResponse = SharedAccessAuthoriza * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1397,6 +1214,7 @@ export type NotificationHubsCheckNotificationHubAvailabilityResponse = CheckAvai * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1416,6 +1234,7 @@ export type NotificationHubsCreateOrUpdateResponse = NotificationHubResource & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1435,6 +1254,7 @@ export type NotificationHubsPatchResponse = NotificationHubResource & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1454,6 +1274,7 @@ export type NotificationHubsGetResponse = NotificationHubResource & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1473,6 +1294,7 @@ export type NotificationHubsDebugSendResponse = DebugSendResponse & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1492,6 +1314,7 @@ export type NotificationHubsCreateOrUpdateAuthorizationRuleResponse = SharedAcce * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1511,6 +1334,7 @@ export type NotificationHubsGetAuthorizationRuleResponse = SharedAccessAuthoriza * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1530,6 +1354,7 @@ export type NotificationHubsListResponse = NotificationHubListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1549,6 +1374,7 @@ export type NotificationHubsListAuthorizationRulesResponse = SharedAccessAuthori * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1568,6 +1394,7 @@ export type NotificationHubsListKeysResponse = ResourceListKeys & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1587,6 +1414,7 @@ export type NotificationHubsRegenerateKeysResponse = ResourceListKeys & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1606,6 +1434,7 @@ export type NotificationHubsGetPnsCredentialsResponse = PnsCredentialsResource & * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1625,6 +1454,7 @@ export type NotificationHubsListNextResponse = NotificationHubListResult & { * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ @@ -1644,6 +1474,7 @@ export type NotificationHubsListAuthorizationRulesNextResponse = SharedAccessAut * The response body as text (string format) */ bodyAsText: string; + /** * The response body as parsed JSON or XML */ diff --git a/sdk/notificationhubs/arm-notificationhubs/src/models/mappers.ts b/sdk/notificationhubs/arm-notificationhubs/src/models/mappers.ts index 3a81c85876bf..0059d4511a06 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/models/mappers.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/models/mappers.ts @@ -1,11 +1,9 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ import { CloudErrorMapper, BaseResourceMapper } from "@azure/ms-rest-azure-js"; diff --git a/sdk/notificationhubs/arm-notificationhubs/src/models/namespacesMappers.ts b/sdk/notificationhubs/arm-notificationhubs/src/models/namespacesMappers.ts index 749e52cee34b..5a735a4a3c5f 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/models/namespacesMappers.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/models/namespacesMappers.ts @@ -1,41 +1,38 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { + AdmCredential, + ApnsCredential, + BaiduCredential, + BaseResource, CheckAvailabilityParameters, - Sku, CheckAvailabilityResult, - Resource, - BaseResource, CloudError, + DebugSendResponse, + GcmCredential, + MpnsCredential, NamespaceCreateOrUpdateParameters, - NamespaceResource, - NamespacePatchParameters, - SharedAccessAuthorizationRuleCreateOrUpdateParameters, - SharedAccessAuthorizationRuleProperties, - SharedAccessAuthorizationRuleResource, NamespaceListResult, - SharedAccessAuthorizationRuleListResult, - PolicykeyResource, - ResourceListKeys, + NamespacePatchParameters, + NamespaceResource, NotificationHubCreateOrUpdateParameters, - ApnsCredential, - WnsCredential, - GcmCredential, - MpnsCredential, - AdmCredential, - BaiduCredential, NotificationHubPatchParameters, NotificationHubResource, - DebugSendResponse, PnsCredentialsResource, - SubResource + PolicykeyResource, + Resource, + ResourceListKeys, + SharedAccessAuthorizationRuleCreateOrUpdateParameters, + SharedAccessAuthorizationRuleListResult, + SharedAccessAuthorizationRuleProperties, + SharedAccessAuthorizationRuleResource, + Sku, + SubResource, + WnsCredential } from "../models/mappers"; - diff --git a/sdk/notificationhubs/arm-notificationhubs/src/models/notificationHubsMappers.ts b/sdk/notificationhubs/arm-notificationhubs/src/models/notificationHubsMappers.ts index 39e8bdce8982..599a198d8205 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/models/notificationHubsMappers.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/models/notificationHubsMappers.ts @@ -1,40 +1,37 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { + AdmCredential, + ApnsCredential, + BaiduCredential, + BaseResource, CheckAvailabilityParameters, - Sku, CheckAvailabilityResult, - Resource, - BaseResource, CloudError, - NotificationHubCreateOrUpdateParameters, - SharedAccessAuthorizationRuleProperties, - ApnsCredential, - WnsCredential, + DebugSendResponse, GcmCredential, MpnsCredential, - AdmCredential, - BaiduCredential, - NotificationHubResource, + NamespaceCreateOrUpdateParameters, + NamespaceResource, + NotificationHubCreateOrUpdateParameters, + NotificationHubListResult, NotificationHubPatchParameters, - DebugSendResponse, + NotificationHubResource, + PnsCredentialsResource, + PolicykeyResource, + Resource, + ResourceListKeys, SharedAccessAuthorizationRuleCreateOrUpdateParameters, - SharedAccessAuthorizationRuleResource, - NotificationHubListResult, SharedAccessAuthorizationRuleListResult, - ResourceListKeys, - PolicykeyResource, - PnsCredentialsResource, - NamespaceCreateOrUpdateParameters, - NamespaceResource, - SubResource + SharedAccessAuthorizationRuleProperties, + SharedAccessAuthorizationRuleResource, + Sku, + SubResource, + WnsCredential } from "../models/mappers"; - diff --git a/sdk/notificationhubs/arm-notificationhubs/src/models/operationsMappers.ts b/sdk/notificationhubs/arm-notificationhubs/src/models/operationsMappers.ts index 715467ec9522..3e8e33c6f2bd 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/models/operationsMappers.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/models/operationsMappers.ts @@ -1,17 +1,14 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. - * Changes may cause incorrect behavior and will be lost if the code is - * regenerated. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */ export { - OperationListResult, + ErrorResponse, Operation, OperationDisplay, - ErrorResponse + OperationListResult } from "../models/mappers"; - diff --git a/sdk/notificationhubs/arm-notificationhubs/src/models/parameters.ts b/sdk/notificationhubs/arm-notificationhubs/src/models/parameters.ts index cde0e6753b97..1bdcf100d62b 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/models/parameters.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/models/parameters.ts @@ -1,7 +1,6 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is diff --git a/sdk/notificationhubs/arm-notificationhubs/src/notificationHubsManagementClient.ts b/sdk/notificationhubs/arm-notificationhubs/src/notificationHubsManagementClient.ts index 75528c3e49ed..774f02e1b45a 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/notificationHubsManagementClient.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/notificationHubsManagementClient.ts @@ -1,7 +1,6 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is @@ -9,6 +8,7 @@ */ import * as msRest from "@azure/ms-rest-js"; +import { TokenCredential } from "@azure/core-auth"; import * as Models from "./models"; import * as Mappers from "./models/mappers"; import * as operations from "./operations"; @@ -23,12 +23,17 @@ class NotificationHubsManagementClient extends NotificationHubsManagementClientC /** * Initializes a new instance of the NotificationHubsManagementClient 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 credentials which uniquely identify Microsoft Azure * subscription. The subscription ID forms part of the URI for every service call. * @param [options] The parameter options */ - constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.NotificationHubsManagementClientOptions) { + constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.NotificationHubsManagementClientOptions) { super(credentials, subscriptionId, options); this.operations = new operations.Operations(this); this.namespaces = new operations.Namespaces(this); diff --git a/sdk/notificationhubs/arm-notificationhubs/src/notificationHubsManagementClientContext.ts b/sdk/notificationhubs/arm-notificationhubs/src/notificationHubsManagementClientContext.ts index 3b6d5b8e08bf..0a6195144d82 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/notificationHubsManagementClientContext.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/notificationHubsManagementClientContext.ts @@ -1,7 +1,6 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is @@ -11,23 +10,29 @@ import * as Models from "./models"; import * as msRest from "@azure/ms-rest-js"; import * as msRestAzure from "@azure/ms-rest-azure-js"; +import { TokenCredential } from "@azure/core-auth"; const packageName = "@azure/arm-notificationhubs"; -const packageVersion = "0.1.0"; +const packageVersion = "1.2.0"; export class NotificationHubsManagementClientContext extends msRestAzure.AzureServiceClient { - credentials: msRest.ServiceClientCredentials; + credentials: msRest.ServiceClientCredentials | TokenCredential; subscriptionId: string; apiVersion?: string; /** * Initializes a new instance of the NotificationHubsManagementClient 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 credentials which uniquely identify Microsoft Azure * subscription. The subscription ID forms part of the URI for every service call. * @param [options] The parameter options */ - constructor(credentials: msRest.ServiceClientCredentials, subscriptionId: string, options?: Models.NotificationHubsManagementClientOptions) { + constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.NotificationHubsManagementClientOptions) { if (credentials == undefined) { throw new Error('\'credentials\' cannot be null.'); } @@ -38,7 +43,7 @@ export class NotificationHubsManagementClientContext extends msRestAzure.AzureSe if (!options) { options = {}; } - if(!options.userAgent) { + if (!options.userAgent) { const defaultUserAgent = msRestAzure.getDefaultUserAgentValue(); options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`; } @@ -53,10 +58,10 @@ export class NotificationHubsManagementClientContext extends msRestAzure.AzureSe this.credentials = credentials; this.subscriptionId = subscriptionId; - if(options.acceptLanguage !== null && options.acceptLanguage !== undefined) { + if (options.acceptLanguage !== null && options.acceptLanguage !== undefined) { this.acceptLanguage = options.acceptLanguage; } - if(options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) { + if (options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) { this.longRunningOperationRetryTimeout = options.longRunningOperationRetryTimeout; } } diff --git a/sdk/notificationhubs/arm-notificationhubs/src/operations/index.ts b/sdk/notificationhubs/arm-notificationhubs/src/operations/index.ts index 29fb0db9e430..b7518b002ec5 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/operations/index.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/operations/index.ts @@ -1,7 +1,6 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is diff --git a/sdk/notificationhubs/arm-notificationhubs/src/operations/namespaces.ts b/sdk/notificationhubs/arm-notificationhubs/src/operations/namespaces.ts index ef2f9d33fdb5..a20305c5ddf7 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/operations/namespaces.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/operations/namespaces.ts @@ -1,7 +1,6 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is @@ -178,7 +177,7 @@ export class Namespaces { * Creates an authorization rule for a namespace * @param resourceGroupName The name of the resource group. * @param namespaceName The namespace name. - * @param authorizationRuleName Aauthorization Rule Name. + * @param authorizationRuleName Authorization Rule Name. * @param parameters The shared access authorization rule. * @param [options] The optional parameters * @returns Promise @@ -187,7 +186,7 @@ export class Namespaces { /** * @param resourceGroupName The name of the resource group. * @param namespaceName The namespace name. - * @param authorizationRuleName Aauthorization Rule Name. + * @param authorizationRuleName Authorization Rule Name. * @param parameters The shared access authorization rule. * @param callback The callback */ @@ -195,7 +194,7 @@ export class Namespaces { /** * @param resourceGroupName The name of the resource group. * @param namespaceName The namespace name. - * @param authorizationRuleName Aauthorization Rule Name. + * @param authorizationRuleName Authorization Rule Name. * @param parameters The shared access authorization rule. * @param options The optional parameters * @param callback The callback @@ -930,6 +929,9 @@ const listNextOperationSpec: msRest.OperationSpec = { urlParameters: [ Parameters.nextPageLink ], + queryParameters: [ + Parameters.apiVersion + ], headerParameters: [ Parameters.acceptLanguage ], @@ -951,6 +953,9 @@ const listAllNextOperationSpec: msRest.OperationSpec = { urlParameters: [ Parameters.nextPageLink ], + queryParameters: [ + Parameters.apiVersion + ], headerParameters: [ Parameters.acceptLanguage ], @@ -972,6 +977,9 @@ const listAuthorizationRulesNextOperationSpec: msRest.OperationSpec = { urlParameters: [ Parameters.nextPageLink ], + queryParameters: [ + Parameters.apiVersion + ], headerParameters: [ Parameters.acceptLanguage ], diff --git a/sdk/notificationhubs/arm-notificationhubs/src/operations/notificationHubs.ts b/sdk/notificationhubs/arm-notificationhubs/src/operations/notificationHubs.ts index 6cfdfbfdd1c7..5dd4296e4e3f 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/operations/notificationHubs.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/operations/notificationHubs.ts @@ -1,7 +1,6 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is @@ -1044,6 +1043,9 @@ const listNextOperationSpec: msRest.OperationSpec = { urlParameters: [ Parameters.nextPageLink ], + queryParameters: [ + Parameters.apiVersion + ], headerParameters: [ Parameters.acceptLanguage ], @@ -1065,6 +1067,9 @@ const listAuthorizationRulesNextOperationSpec: msRest.OperationSpec = { urlParameters: [ Parameters.nextPageLink ], + queryParameters: [ + Parameters.apiVersion + ], headerParameters: [ Parameters.acceptLanguage ], diff --git a/sdk/notificationhubs/arm-notificationhubs/src/operations/operations.ts b/sdk/notificationhubs/arm-notificationhubs/src/operations/operations.ts index c46f0d893d88..b1ab068480db 100644 --- a/sdk/notificationhubs/arm-notificationhubs/src/operations/operations.ts +++ b/sdk/notificationhubs/arm-notificationhubs/src/operations/operations.ts @@ -1,7 +1,6 @@ /* - * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * Copyright (c) Microsoft Corporation. + * Licensed under the MIT License. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is @@ -108,6 +107,9 @@ const listNextOperationSpec: msRest.OperationSpec = { urlParameters: [ Parameters.nextPageLink ], + queryParameters: [ + Parameters.apiVersion + ], headerParameters: [ Parameters.acceptLanguage ], diff --git a/sdk/notificationhubs/arm-notificationhubs/tsconfig.json b/sdk/notificationhubs/arm-notificationhubs/tsconfig.json index 87bbf5b5fa49..422b584abd5e 100644 --- a/sdk/notificationhubs/arm-notificationhubs/tsconfig.json +++ b/sdk/notificationhubs/arm-notificationhubs/tsconfig.json @@ -9,7 +9,7 @@ "esModuleInterop": true, "allowSyntheticDefaultImports": true, "forceConsistentCasingInFileNames": true, - "lib": ["es6"], + "lib": ["es6", "dom"], "declaration": true, "outDir": "./esm", "importHelpers": true