@azure/arm-paloaltonetworksngfw 1.0.0-beta.1 → 1.0.0

package/src/operations/firewallStatus.ts

@@ -0,0 +1,243 @@
+/*
+ * 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.
+ */
+
+import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
+import { setContinuationToken } from "../pagingHelper";
+import { FirewallStatus } from "../operationsInterfaces";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers";
+import * as Parameters from "../models/parameters";
+import { PaloAltoNetworksCloudngfw } from "../paloAltoNetworksCloudngfw";
+import {
+  FirewallStatusResource,
+  FirewallStatusListByFirewallsNextOptionalParams,
+  FirewallStatusListByFirewallsOptionalParams,
+  FirewallStatusListByFirewallsResponse,
+  FirewallStatusGetOptionalParams,
+  FirewallStatusGetResponse,
+  FirewallStatusListByFirewallsNextResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Class containing FirewallStatus operations. */
+export class FirewallStatusImpl implements FirewallStatus {
+  private readonly client: PaloAltoNetworksCloudngfw;
+
+  /**
+   * Initialize a new instance of the class FirewallStatus class.
+   * @param client Reference to the service client
+   */
+  constructor(client: PaloAltoNetworksCloudngfw) {
+    this.client = client;
+  }
+
+  /**
+   * List FirewallStatusResource resources by Firewalls
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param firewallName Firewall resource name
+   * @param options The options parameters.
+   */
+  public listByFirewalls(
+    resourceGroupName: string,
+    firewallName: string,
+    options?: FirewallStatusListByFirewallsOptionalParams
+  ): PagedAsyncIterableIterator<FirewallStatusResource> {
+    const iter = this.listByFirewallsPagingAll(
+      resourceGroupName,
+      firewallName,
+      options
+    );
+    return {
+      next() {
+        return iter.next();
+      },
+      [Symbol.asyncIterator]() {
+        return this;
+      },
+      byPage: (settings?: PageSettings) => {
+        if (settings?.maxPageSize) {
+          throw new Error("maxPageSize is not supported by this operation.");
+        }
+        return this.listByFirewallsPagingPage(
+          resourceGroupName,
+          firewallName,
+          options,
+          settings
+        );
+      }
+    };
+  }
+
+  private async *listByFirewallsPagingPage(
+    resourceGroupName: string,
+    firewallName: string,
+    options?: FirewallStatusListByFirewallsOptionalParams,
+    settings?: PageSettings
+  ): AsyncIterableIterator<FirewallStatusResource[]> {
+    let result: FirewallStatusListByFirewallsResponse;
+    let continuationToken = settings?.continuationToken;
+    if (!continuationToken) {
+      result = await this._listByFirewalls(
+        resourceGroupName,
+        firewallName,
+        options
+      );
+      let page = result.value || [];
+      continuationToken = result.nextLink;
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+    while (continuationToken) {
+      result = await this._listByFirewallsNext(
+        resourceGroupName,
+        firewallName,
+        continuationToken,
+        options
+      );
+      continuationToken = result.nextLink;
+      let page = result.value || [];
+      setContinuationToken(page, continuationToken);
+      yield page;
+    }
+  }
+
+  private async *listByFirewallsPagingAll(
+    resourceGroupName: string,
+    firewallName: string,
+    options?: FirewallStatusListByFirewallsOptionalParams
+  ): AsyncIterableIterator<FirewallStatusResource> {
+    for await (const page of this.listByFirewallsPagingPage(
+      resourceGroupName,
+      firewallName,
+      options
+    )) {
+      yield* page;
+    }
+  }
+
+  /**
+   * List FirewallStatusResource resources by Firewalls
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param firewallName Firewall resource name
+   * @param options The options parameters.
+   */
+  private _listByFirewalls(
+    resourceGroupName: string,
+    firewallName: string,
+    options?: FirewallStatusListByFirewallsOptionalParams
+  ): Promise<FirewallStatusListByFirewallsResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, firewallName, options },
+      listByFirewallsOperationSpec
+    );
+  }
+
+  /**
+   * Get a FirewallStatusResource
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param firewallName Firewall resource name
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    firewallName: string,
+    options?: FirewallStatusGetOptionalParams
+  ): Promise<FirewallStatusGetResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, firewallName, options },
+      getOperationSpec
+    );
+  }
+
+  /**
+   * ListByFirewallsNext
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param firewallName Firewall resource name
+   * @param nextLink The nextLink from the previous successful call to the ListByFirewalls method.
+   * @param options The options parameters.
+   */
+  private _listByFirewallsNext(
+    resourceGroupName: string,
+    firewallName: string,
+    nextLink: string,
+    options?: FirewallStatusListByFirewallsNextOptionalParams
+  ): Promise<FirewallStatusListByFirewallsNextResponse> {
+    return this.client.sendOperationRequest(
+      { resourceGroupName, firewallName, nextLink, options },
+      listByFirewallsNextOperationSpec
+    );
+  }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+
+const listByFirewallsOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/statuses",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.FirewallStatusResourceListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.firewallName1
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const getOperationSpec: coreClient.OperationSpec = {
+  path:
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/statuses/default",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.FirewallStatusResource
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  queryParameters: [Parameters.apiVersion],
+  urlParameters: [
+    Parameters.$host,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.firewallName1
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};
+const listByFirewallsNextOperationSpec: coreClient.OperationSpec = {
+  path: "{nextLink}",
+  httpMethod: "GET",
+  responses: {
+    200: {
+      bodyMapper: Mappers.FirewallStatusResourceListResult
+    },
+    default: {
+      bodyMapper: Mappers.ErrorResponse
+    }
+  },
+  urlParameters: [
+    Parameters.$host,
+    Parameters.nextLink,
+    Parameters.subscriptionId,
+    Parameters.resourceGroupName,
+    Parameters.firewallName1
+  ],
+  headerParameters: [Parameters.accept],
+  serializer
+};

package/src/operations/index.ts

@@ -15,6 +15,7 @@ export * from "./preRules";
 export * from "./operations";
 export * from "./firewalls";
 export * from "./localRulestacks";
+export * from "./firewallStatus";
 export * from "./certificateObjectLocalRulestack";
 export * from "./fqdnListLocalRulestack";
 export * from "./localRules";

package/src/operationsInterfaces/firewallStatus.ts

@@ -0,0 +1,42 @@
+/*
+ * 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.
+ */
+
+import { PagedAsyncIterableIterator } from "@azure/core-paging";
+import {
+  FirewallStatusResource,
+  FirewallStatusListByFirewallsOptionalParams,
+  FirewallStatusGetOptionalParams,
+  FirewallStatusGetResponse
+} from "../models";
+
+/// <reference lib="esnext.asynciterable" />
+/** Interface representing a FirewallStatus. */
+export interface FirewallStatus {
+  /**
+   * List FirewallStatusResource resources by Firewalls
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param firewallName Firewall resource name
+   * @param options The options parameters.
+   */
+  listByFirewalls(
+    resourceGroupName: string,
+    firewallName: string,
+    options?: FirewallStatusListByFirewallsOptionalParams
+  ): PagedAsyncIterableIterator<FirewallStatusResource>;
+  /**
+   * Get a FirewallStatusResource
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
+   * @param firewallName Firewall resource name
+   * @param options The options parameters.
+   */
+  get(
+    resourceGroupName: string,
+    firewallName: string,
+    options?: FirewallStatusGetOptionalParams
+  ): Promise<FirewallStatusGetResponse>;
+}

package/src/operationsInterfaces/index.ts

@@ -15,6 +15,7 @@ export * from "./preRules";
 export * from "./operations";
 export * from "./firewalls";
 export * from "./localRulestacks";
+export * from "./firewallStatus";
 export * from "./certificateObjectLocalRulestack";
 export * from "./fqdnListLocalRulestack";
 export * from "./localRules";

package/src/paloAltoNetworksCloudngfw.ts

@@ -24,6 +24,7 @@ import {
   OperationsImpl,
   FirewallsImpl,
   LocalRulestacksImpl,
+  FirewallStatusImpl,
   CertificateObjectLocalRulestackImpl,
   FqdnListLocalRulestackImpl,
   LocalRulesImpl,
@@ -39,6 +40,7 @@ import {
   Operations,
   Firewalls,
   LocalRulestacks,
+  FirewallStatus,
   CertificateObjectLocalRulestack,
   FqdnListLocalRulestack,
   LocalRules,
@@ -49,7 +51,7 @@ import { PaloAltoNetworksCloudngfwOptionalParams } from "./models";
 export class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient {
   $host: string;
   apiVersion: string;
-  subscriptionId: string;
+  subscriptionId?: string;
 
   /**
    * Initializes a new instance of the PaloAltoNetworksCloudngfw class.
@@ -61,12 +63,26 @@ export class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient {
     credentials: coreAuth.TokenCredential,
     subscriptionId: string,
     options?: PaloAltoNetworksCloudngfwOptionalParams
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    options?: PaloAltoNetworksCloudngfwOptionalParams
+  );
+  constructor(
+    credentials: coreAuth.TokenCredential,
+    subscriptionIdOrOptions?: PaloAltoNetworksCloudngfwOptionalParams | string,
+    options?: PaloAltoNetworksCloudngfwOptionalParams
   ) {
     if (credentials === undefined) {
       throw new Error("'credentials' cannot be null");
     }
-    if (subscriptionId === undefined) {
-      throw new Error("'subscriptionId' cannot be null");
+
+    let subscriptionId: string | undefined;
+
+    if (typeof subscriptionIdOrOptions === "string") {
+      subscriptionId = subscriptionIdOrOptions;
+    } else if (typeof subscriptionIdOrOptions === "object") {
+      options = subscriptionIdOrOptions;
     }
 
     // Initializing default values for options
@@ -78,7 +94,7 @@ export class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-paloaltonetworksngfw/1.0.0-beta.1`;
+    const packageDetails = `azsdk-js-arm-paloaltonetworksngfw/1.0.0`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -131,7 +147,7 @@ export class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2022-08-29-preview";
+    this.apiVersion = options.apiVersion || "2022-08-29";
     this.globalRulestack = new GlobalRulestackImpl(this);
     this.certificateObjectGlobalRulestack = new CertificateObjectGlobalRulestackImpl(
       this
@@ -143,6 +159,7 @@ export class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient {
     this.operations = new OperationsImpl(this);
     this.firewalls = new FirewallsImpl(this);
     this.localRulestacks = new LocalRulestacksImpl(this);
+    this.firewallStatus = new FirewallStatusImpl(this);
     this.certificateObjectLocalRulestack = new CertificateObjectLocalRulestackImpl(
       this
     );
@@ -189,6 +206,7 @@ export class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient {
   operations: Operations;
   firewalls: Firewalls;
   localRulestacks: LocalRulestacks;
+  firewallStatus: FirewallStatus;
   certificateObjectLocalRulestack: CertificateObjectLocalRulestack;
   fqdnListLocalRulestack: FqdnListLocalRulestack;
   localRules: LocalRules;

package/types/arm-paloaltonetworksngfw.d.ts

@@ -802,6 +802,82 @@ export declare interface FirewallsSaveLogProfileOptionalParams extends coreClien
     logSettings?: LogSettings;
 }
 
+/** Interface representing a FirewallStatus. */
+export declare interface FirewallStatus {
+    /**
+     * List FirewallStatusResource resources by Firewalls
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param firewallName Firewall resource name
+     * @param options The options parameters.
+     */
+    listByFirewalls(resourceGroupName: string, firewallName: string, options?: FirewallStatusListByFirewallsOptionalParams): PagedAsyncIterableIterator<FirewallStatusResource>;
+    /**
+     * Get a FirewallStatusResource
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param firewallName Firewall resource name
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, firewallName: string, options?: FirewallStatusGetOptionalParams): Promise<FirewallStatusGetResponse>;
+}
+
+/** Optional parameters. */
+export declare interface FirewallStatusGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type FirewallStatusGetResponse = FirewallStatusResource;
+
+/** Optional parameters. */
+export declare interface FirewallStatusListByFirewallsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByFirewallsNext operation. */
+export declare type FirewallStatusListByFirewallsNextResponse = FirewallStatusResourceListResult;
+
+/** Optional parameters. */
+export declare interface FirewallStatusListByFirewallsOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByFirewalls operation. */
+export declare type FirewallStatusListByFirewallsResponse = FirewallStatusResourceListResult;
+
+/** Firewall Status */
+export declare interface FirewallStatusResource extends ProxyResource {
+    /**
+     * Panorama Managed: Default is False. Default will be CloudSec managed
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly isPanoramaManaged?: BooleanEnum;
+    /**
+     * Current status of the Firewall
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly healthStatus?: HealthStatus;
+    /**
+     * Detail description of current health of the Firewall
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly healthReason?: string;
+    /**
+     * Panorama Status
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly panoramaStatus?: PanoramaStatus;
+    /**
+     * Provisioning state of the resource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: ReadOnlyProvisioningState;
+}
+
+/** The response of a FirewallStatusResource list operation. */
+export declare interface FirewallStatusResourceListResult {
+    /** The items on this page */
+    value: FirewallStatusResource[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+
 /** Optional parameters. */
 export declare interface FirewallsUpdateOptionalParams extends coreClient.OperationOptions {
 }
@@ -1363,6 +1439,18 @@ export declare interface GlobalRulestackUpdateOptionalParams extends coreClient.
 /** Contains response data for the update operation. */
 export declare type GlobalRulestackUpdateResponse = GlobalRulestackResource;
 
+/**
+ * Defines values for HealthStatus. \
+ * {@link KnownHealthStatus} can be used interchangeably with HealthStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **GREEN** \
+ * **YELLOW** \
+ * **RED** \
+ * **INITIALIZING**
+ */
+export declare type HealthStatus = string;
+
 /** IP Address */
 export declare interface IPAddress {
     /** Resource Id */
@@ -1477,6 +1565,18 @@ export declare enum KnownEnabledDNSType {
     Azure = "AZURE"
 }
 
+/** Known values of {@link HealthStatus} that the service accepts. */
+export declare enum KnownHealthStatus {
+    /** Green */
+    Green = "GREEN",
+    /** Yellow */
+    Yellow = "YELLOW",
+    /** RED */
+    RED = "RED",
+    /** Initializing */
+    Initializing = "INITIALIZING"
+}
+
 /** Known values of {@link LogOption} that the service accepts. */
 export declare enum KnownLogOption {
     /** SameDestination */
@@ -1577,6 +1677,16 @@ export declare enum KnownProvisioningState {
     NotSpecified = "NotSpecified"
 }
 
+/** Known values of {@link ReadOnlyProvisioningState} that the service accepts. */
+export declare enum KnownReadOnlyProvisioningState {
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Failed */
+    Failed = "Failed",
+    /** Deleted */
+    Deleted = "Deleted"
+}
+
 /** Known values of {@link ScopeType} that the service accepts. */
 export declare enum KnownScopeType {
     /** Local */
@@ -1601,6 +1711,14 @@ export declare enum KnownSecurityServicesTypeEnum {
     DnsSubscription = "dnsSubscription"
 }
 
+/** Known values of {@link ServerStatus} that the service accepts. */
+export declare enum KnownServerStatus {
+    /** UP */
+    UP = "UP",
+    /** Down */
+    Down = "DOWN"
+}
+
 /** Known values of {@link StateEnum} that the service accepts. */
 export declare enum KnownStateEnum {
     /** Disabled */
@@ -2416,7 +2534,7 @@ export declare type Origin = string;
 export declare class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient {
     $host: string;
     apiVersion: string;
-    subscriptionId: string;
+    subscriptionId?: string;
     /**
      * Initializes a new instance of the PaloAltoNetworksCloudngfw class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
@@ -2424,6 +2542,7 @@ export declare class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: PaloAltoNetworksCloudngfwOptionalParams);
+    constructor(credentials: coreAuth.TokenCredential, options?: PaloAltoNetworksCloudngfwOptionalParams);
     /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
     private addCustomApiVersionPolicy;
     globalRulestack: GlobalRulestack;
@@ -2435,6 +2554,7 @@ export declare class PaloAltoNetworksCloudngfw extends coreClient.ServiceClient
     operations: Operations;
     firewalls: Firewalls;
     localRulestacks: LocalRulestacks;
+    firewallStatus: FirewallStatus;
     certificateObjectLocalRulestack: CertificateObjectLocalRulestack;
     fqdnListLocalRulestack: FqdnListLocalRulestack;
     localRules: LocalRules;
@@ -2492,6 +2612,20 @@ export declare interface PanoramaConfig {
     readonly hostName?: string;
 }
 
+/** Panorama connectivity information */
+export declare interface PanoramaStatus {
+    /**
+     * Primary Panorama connection status
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly panoramaServerStatus?: ServerStatus;
+    /**
+     * Secondary Panorama connection status
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly panoramaServer2Status?: ServerStatus;
+}
+
 /** Billing plan information. */
 export declare interface PlanData {
     /** different usage type like PAYG/COMMITTED */
@@ -3150,6 +3284,17 @@ export declare type ProvisioningState = string;
 export declare interface ProxyResource extends Resource {
 }
 
+/**
+ * Defines values for ReadOnlyProvisioningState. \
+ * {@link KnownReadOnlyProvisioningState} can be used interchangeably with ReadOnlyProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Succeeded** \
+ * **Failed** \
+ * **Deleted**
+ */
+export declare type ReadOnlyProvisioningState = string;
+
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
 export declare interface Resource {
     /**
@@ -3285,6 +3430,16 @@ export declare interface SecurityServicesTypeList {
     entry: NameDescriptionObject[];
 }
 
+/**
+ * Defines values for ServerStatus. \
+ * {@link KnownServerStatus} can be used interchangeably with ServerStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **UP** \
+ * **DOWN**
+ */
+export declare type ServerStatus = string;
+
 /** Address properties */
 export declare interface SourceAddr {
     /** special value 'any' */

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.6"
+      "packageVersion": "7.36.0"
     }
   ]
 }