[AutoPR @azure/arm-iothub] [IotHub] Introducing networkRuleSets in IotHubProperties [2020-08-31 : preview and stable ]

sdk/iothub/arm-iothub/README.md

@@ -15,7 +15,7 @@ npm install @azure/arm-iothub
 
 ### How to use
 
-#### nodejs - Authentication, client creation and list operations as an example written in TypeScript.
+#### nodejs - client creation and list operations as an example written in TypeScript.
 
 ##### Install @azure/ms-rest-nodeauth
 
@@ -26,11 +26,10 @@ npm install @azure/ms-rest-nodeauth@"^3.0.0"
 
 ##### 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
-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 { IotHubClient, IotHubModels, IotHubMappers } from "@azure/arm-iothub";
+const msRestNodeAuth = require("@azure/ms-rest-nodeauth");
+const { IotHubClient } = require("@azure/arm-iothub");
 const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
 
 msRestNodeAuth.interactiveLogin().then((creds) => {

sdk/iothub/arm-iothub/rollup.config.js

@@ -21,8 +21,8 @@ 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.

sdk/iothub/arm-iothub/src/iotHubClient.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

sdk/iothub/arm-iothub/src/iotHubClientContext.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
@@ -44,7 +43,7 @@ export class IotHubClientContext extends msRestAzure.AzureServiceClient {
 
     super(credentials, options);
 
-    this.apiVersion = '2020-07-10-preview';
+    this.apiVersion = '2020-08-31';
     this.acceptLanguage = 'en-US';
     this.longRunningOperationRetryTimeout = 30;
     this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";

sdk/iothub/arm-iothub/src/models/certificatesMappers.ts

@@ -1,6 +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 regenerated.
@@ -15,7 +15,6 @@ export {
   CertificateVerificationDescription,
   CertificateWithNonceDescription,
   CloudToDeviceProperties,
-  EncryptionPropertiesDescription,
   EnrichmentProperties,
   ErrorDetails,
   EventHubConsumerGroupInfo,
@@ -25,11 +24,11 @@ export {
   IotHubDescription,
   IotHubLocationDescription,
   IotHubProperties,
-  IotHubPropertiesDeviceStreams,
   IotHubSkuInfo,
   IpFilterRule,
-  KeyVaultKeyProperties,
   MessagingEndpointProperties,
+  NetworkRuleSetIpRule,
+  NetworkRuleSetProperties,
   PrivateEndpoint,
   PrivateEndpointConnection,
   PrivateEndpointConnectionProperties,

sdk/iothub/arm-iothub/src/models/index.ts

@@ -1,6 +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 regenerated.
@@ -229,6 +229,43 @@ export interface IpFilterRule {
   ipMask: string;
 }
 
+/**
+ * IP Rule to be applied as part of Network Rule Set
+ */
+export interface NetworkRuleSetIpRule {
+  /**
+   * Name of the IP filter rule.
+   */
+  filterName: string;
+  /**
+   * IP Filter Action. Possible values include: 'Allow'. Default value: 'Allow'.
+   */
+  action?: NetworkRuleIPAction;
+  /**
+   * A string that contains the IP address range in CIDR notation for the rule.
+   */
+  ipMask: string;
+}
+
+/**
+ * Network Rule Set Properties of IotHub
+ */
+export interface NetworkRuleSetProperties {
+  /**
+   * Default Action for Network Rule Set. Possible values include: 'Deny', 'Allow'. Default value:
+   * 'Deny'.
+   */
+  defaultAction?: DefaultAction;
+  /**
+   * If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub
+   */
+  applyToBuiltInEventHubEndpoint: boolean;
+  /**
+   * List of IP Rules
+   */
+  ipRules: NetworkRuleSetIpRule[];
+}
+
 /**
  * The private endpoint property of a private endpoint connection
  */
@@ -551,7 +588,7 @@ export interface RouteProperties {
   /**
    * The source that the routing rule is to be applied to, such as DeviceMessages. Possible values
    * include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents', 'DeviceLifecycleEvents',
-   * 'DeviceJobLifecycleEvents', 'DigitalTwinChangeEvents'
+   * 'DeviceJobLifecycleEvents'
    */
   source: RoutingSource;
   /**
@@ -726,40 +763,6 @@ export interface CloudToDeviceProperties {
   feedback?: FeedbackProperties;
 }
 
-/**
- * The device streams properties of iothub.
- */
-export interface IotHubPropertiesDeviceStreams {
-  /**
-   * List of Device Streams Endpoints.
-   */
-  streamingEndpoints?: string[];
-}
-
-/**
- * The properties of the KeyVault key.
- */
-export interface KeyVaultKeyProperties {
-  /**
-   * The identifier of the key.
-   */
-  keyIdentifier?: string;
-}
-
-/**
- * The encryption properties for the IoT hub.
- */
-export interface EncryptionPropertiesDescription {
-  /**
-   * The source of the key.
-   */
-  keySource?: string;
-  /**
-   * The properties of the KeyVault key.
-   */
-  keyVaultProperties?: KeyVaultKeyProperties[];
-}
-
 /**
  * Public representation of one of the locations where a resource is provisioned.
  */
@@ -794,6 +797,7 @@ export interface IotHubProperties {
    * The IP filter rules.
    */
   ipFilterRules?: IpFilterRule[];
+  networkRuleSets?: NetworkRuleSetProperties;
   /**
    * Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients
    * that use a TLS version below 1.2 to be rejected.
@@ -845,19 +849,11 @@ export interface IotHubProperties {
    * IoT hub comments.
    */
   comments?: string;
-  /**
-   * The device streams properties of iothub.
-   */
-  deviceStreams?: IotHubPropertiesDeviceStreams;
   /**
    * The capabilities and features enabled for the IoT hub. Possible values include: 'None',
    * 'DeviceManagement'
    */
   features?: Capabilities;
-  /**
-   * The encryption properties for the IoT hub.
-   */
-  encryption?: EncryptionPropertiesDescription;
   /**
    * Primary and secondary location for iot hub
    * **NOTE: This property will not be serialized. It can only be populated by the server.**
@@ -1417,7 +1413,7 @@ export interface RoutingTwin {
 export interface TestAllRoutesInput {
   /**
    * Routing source. Possible values include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents',
-   * 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents', 'DigitalTwinChangeEvents'
+   * 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents'
    */
   routingSource?: RoutingSource;
   /**
@@ -1560,6 +1556,15 @@ export interface ExportDevicesRequest {
    * values include: 'keyBased', 'identityBased'
    */
   authenticationType?: AuthenticationType;
+  /**
+   * The value indicating whether configurations should be exported.
+   */
+  includeConfigurations?: boolean;
+  /**
+   * The name of the blob that will be created in the provided output blob container. This blob
+   * will contain the exported configurations for the Iot Hub.
+   */
+  configurationsBlobName?: string;
 }
 
 /**
@@ -1587,6 +1592,14 @@ export interface ImportDevicesRequest {
    * values include: 'keyBased', 'identityBased'
    */
   authenticationType?: AuthenticationType;
+  /**
+   * The value indicating whether configurations should be imported.
+   */
+  includeConfigurations?: boolean;
+  /**
+   * The blob name to be used when importing configurations from the provided input blob container.
+   */
+  configurationsBlobName?: string;
 }
 
 /**
@@ -1811,6 +1824,22 @@ export type PublicNetworkAccess = 'Enabled' | 'Disabled';
  */
 export type IpFilterActionType = 'Accept' | 'Reject';
 
+/**
+ * Defines values for DefaultAction.
+ * Possible values include: 'Deny', 'Allow'
+ * @readonly
+ * @enum {string}
+ */
+export type DefaultAction = 'Deny' | 'Allow';
+
+/**
+ * Defines values for NetworkRuleIPAction.
+ * Possible values include: 'Allow'
+ * @readonly
+ * @enum {string}
+ */
+export type NetworkRuleIPAction = 'Allow';
+
 /**
  * Defines values for PrivateLinkServiceConnectionStatus.
  * Possible values include: 'Pending', 'Approved', 'Rejected', 'Disconnected'
@@ -1830,11 +1859,11 @@ export type AuthenticationType = 'keyBased' | 'identityBased';
 /**
  * Defines values for RoutingSource.
  * Possible values include: 'Invalid', 'DeviceMessages', 'TwinChangeEvents',
- * 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents', 'DigitalTwinChangeEvents'
+ * 'DeviceLifecycleEvents', 'DeviceJobLifecycleEvents'
  * @readonly
  * @enum {string}
  */
-export type RoutingSource = 'Invalid' | 'DeviceMessages' | 'TwinChangeEvents' | 'DeviceLifecycleEvents' | 'DeviceJobLifecycleEvents' | 'DigitalTwinChangeEvents';
+export type RoutingSource = 'Invalid' | 'DeviceMessages' | 'TwinChangeEvents' | 'DeviceLifecycleEvents' | 'DeviceJobLifecycleEvents';
 
 /**
  * Defines values for Capabilities.

sdk/iothub/arm-iothub/src/models/iotHubMappers.ts

@@ -1,6 +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 regenerated.

sdk/iothub/arm-iothub/src/models/iotHubResourceMappers.ts

@@ -1,6 +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 regenerated.
@@ -14,7 +14,6 @@ export {
   CertificateWithNonceDescription,
   CloudError,
   CloudToDeviceProperties,
-  EncryptionPropertiesDescription,
   EndpointHealthData,
   EndpointHealthDataListResult,
   EnrichmentProperties,
@@ -34,7 +33,6 @@ export {
   IotHubLocationDescription,
   IotHubNameAvailabilityInfo,
   IotHubProperties,
-  IotHubPropertiesDeviceStreams,
   IotHubQuotaMetricInfo,
   IotHubQuotaMetricInfoListResult,
   IotHubSkuDescription,
@@ -43,9 +41,10 @@ export {
   IpFilterRule,
   JobResponse,
   JobResponseListResult,
-  KeyVaultKeyProperties,
   MatchedRoute,
   MessagingEndpointProperties,
+  NetworkRuleSetIpRule,
+  NetworkRuleSetProperties,
   OperationInputs,
   PrivateEndpoint,
   PrivateEndpointConnection,