@azure/arm-locks 1.2.0 → 2.0.0-alpha.20211015.3

package/src/models/index.ts

@@ -1,530 +1,316 @@
 /*
- * 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.
  */
 
-import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
-import * as msRest from "@azure/ms-rest-js";
+import * as coreClient from "@azure/core-client";
 
-export { BaseResource, CloudError };
+/** Result of the request to list Microsoft.Authorization operations. It contains a list of operations and a URL link to get the next set of results. */
+export interface OperationListResult {
+  /** List of Microsoft.Authorization operations. */
+  value?: Operation[];
+  /** URL to get the next set of operation list results if there are any. */
+  nextLink?: string;
+}
 
-/**
- * Lock owner properties.
- */
-export interface ManagementLockOwner {
-  /**
-   * The application ID of the lock owner.
-   */
-  applicationId?: string;
+/** Microsoft.Authorization operation */
+export interface Operation {
+  /** Operation name: {provider}/{resource}/{operation} */
+  name?: string;
+  /** The object that represents the operation. */
+  display?: OperationDisplay;
 }
 
-/**
- * The lock information.
- */
-export interface ManagementLockObject extends BaseResource {
-  /**
-   * The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete
-   * means authorized users are able to read and modify the resources, but not delete. ReadOnly
-   * means authorized users can only read from a resource, but they can't modify or delete it.
-   * Possible values include: 'NotSpecified', 'CanNotDelete', 'ReadOnly'
-   */
-  level: LockLevel;
-  /**
-   * Notes about the lock. Maximum of 512 characters.
-   */
-  notes?: string;
-  /**
-   * The owners of the lock.
-   */
-  owners?: ManagementLockOwner[];
+/** The object that represents the operation. */
+export interface OperationDisplay {
+  /** Service provider: Microsoft.Authorization */
+  provider?: string;
+  /** Resource on which the operation is performed: Profile, endpoint, etc. */
+  resource?: string;
+  /** Operation type: Read, write, delete, etc. */
+  operation?: string;
+}
+
+/** The lock information. */
+export interface ManagementLockObject {
   /**
    * The resource ID of the lock.
-   * **NOTE: This property will not be serialized. It can only be populated by the server.**
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly id?: string;
   /**
    * The resource type of the lock - Microsoft.Authorization/locks.
-   * **NOTE: This property will not be serialized. It can only be populated by the server.**
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly type?: string;
   /**
    * The name of the lock.
-   * **NOTE: This property will not be serialized. It can only be populated by the server.**
+   * NOTE: This property will not be serialized. It can only be populated by the server.
    */
   readonly name?: string;
+  /** The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. */
+  level: LockLevel;
+  /** Notes about the lock. Maximum of 512 characters. */
+  notes?: string;
+  /** The owners of the lock. */
+  owners?: ManagementLockOwner[];
 }
 
-/**
- * The object that represents the operation.
- */
-export interface OperationDisplay {
-  /**
-   * Service provider: Microsoft.Authorization
-   */
-  provider?: string;
-  /**
-   * Resource on which the operation is performed: Profile, endpoint, etc.
-   */
-  resource?: string;
-  /**
-   * Operation type: Read, write, delete, etc.
-   */
-  operation?: string;
+/** Lock owner properties. */
+export interface ManagementLockOwner {
+  /** The application ID of the lock owner. */
+  applicationId?: string;
 }
 
-/**
- * Microsoft.Authorization operation
- */
-export interface Operation {
-  /**
-   * Operation name: {provider}/{resource}/{operation}
-   */
-  name?: string;
-  /**
-   * The object that represents the operation.
-   */
-  display?: OperationDisplay;
+/** The list of locks. */
+export interface ManagementLockListResult {
+  /** The list of locks. */
+  value?: ManagementLockObject[];
+  /** The URL to use for getting the next set of results. */
+  nextLink?: string;
 }
 
-/**
- * Optional Parameters.
- */
-export interface ManagementLocksListAtResourceGroupLevelOptionalParams extends msRest.RequestOptionsBase {
-  /**
-   * The filter to apply on the operation.
-   */
-  filter?: string;
+/** Known values of {@link LockLevel} that the service accepts. */
+export enum KnownLockLevel {
+  NotSpecified = "NotSpecified",
+  CanNotDelete = "CanNotDelete",
+  ReadOnly = "ReadOnly"
 }
 
 /**
- * Optional Parameters.
+ * Defines values for LockLevel. \
+ * {@link KnownLockLevel} can be used interchangeably with LockLevel,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **NotSpecified** \
+ * **CanNotDelete** \
+ * **ReadOnly**
  */
-export interface ManagementLocksListAtResourceLevelOptionalParams extends msRest.RequestOptionsBase {
-  /**
-   * The filter to apply on the operation.
-   */
-  filter?: string;
-}
+export type LockLevel = string;
 
-/**
- * Optional Parameters.
- */
-export interface ManagementLocksListAtSubscriptionLevelOptionalParams extends msRest.RequestOptionsBase {
-  /**
-   * The filter to apply on the operation.
-   */
-  filter?: string;
-}
+/** Optional parameters. */
+export interface AuthorizationOperationsListOptionalParams
+  extends coreClient.OperationOptions {}
 
-/**
- * Optional Parameters.
- */
-export interface ManagementLocksListByScopeOptionalParams extends msRest.RequestOptionsBase {
-  /**
-   * The filter to apply on the operation.
-   */
+/** Contains response data for the list operation. */
+export type AuthorizationOperationsListResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface AuthorizationOperationsListNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNext operation. */
+export type AuthorizationOperationsListNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface AuthorizationOperationsListNextNextOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the listNextNext operation. */
+export type AuthorizationOperationsListNextNextResponse = OperationListResult;
+
+/** Optional parameters. */
+export interface ManagementLocksCreateOrUpdateAtResourceGroupLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdateAtResourceGroupLevel operation. */
+export type ManagementLocksCreateOrUpdateAtResourceGroupLevelResponse = ManagementLockObject;
+
+/** Optional parameters. */
+export interface ManagementLocksDeleteAtResourceGroupLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface ManagementLocksGetAtResourceGroupLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the getAtResourceGroupLevel operation. */
+export type ManagementLocksGetAtResourceGroupLevelResponse = ManagementLockObject;
+
+/** Optional parameters. */
+export interface ManagementLocksCreateOrUpdateByScopeOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdateByScope operation. */
+export type ManagementLocksCreateOrUpdateByScopeResponse = ManagementLockObject;
+
+/** Optional parameters. */
+export interface ManagementLocksDeleteByScopeOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface ManagementLocksGetByScopeOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the getByScope operation. */
+export type ManagementLocksGetByScopeResponse = ManagementLockObject;
+
+/** Optional parameters. */
+export interface ManagementLocksCreateOrUpdateAtResourceLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdateAtResourceLevel operation. */
+export type ManagementLocksCreateOrUpdateAtResourceLevelResponse = ManagementLockObject;
+
+/** Optional parameters. */
+export interface ManagementLocksDeleteAtResourceLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface ManagementLocksGetAtResourceLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the getAtResourceLevel operation. */
+export type ManagementLocksGetAtResourceLevelResponse = ManagementLockObject;
+
+/** Optional parameters. */
+export interface ManagementLocksCreateOrUpdateAtSubscriptionLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the createOrUpdateAtSubscriptionLevel operation. */
+export type ManagementLocksCreateOrUpdateAtSubscriptionLevelResponse = ManagementLockObject;
+
+/** Optional parameters. */
+export interface ManagementLocksDeleteAtSubscriptionLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Optional parameters. */
+export interface ManagementLocksGetAtSubscriptionLevelOptionalParams
+  extends coreClient.OperationOptions {}
+
+/** Contains response data for the getAtSubscriptionLevel operation. */
+export type ManagementLocksGetAtSubscriptionLevelResponse = ManagementLockObject;
+
+/** Optional parameters. */
+export interface ManagementLocksListAtResourceGroupLevelOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
   filter?: string;
 }
 
-/**
- * An interface representing ManagementLockClientOptions.
- */
-export interface ManagementLockClientOptions extends AzureServiceClientOptions {
-  baseUri?: string;
-}
+/** Contains response data for the listAtResourceGroupLevel operation. */
+export type ManagementLocksListAtResourceGroupLevelResponse = ManagementLockListResult;
 
-/**
- * @interface
- * Result of the request to list Microsoft.Authorization operations. It contains a list of
- * operations and a URL link to get the next set of results.
- * @extends Array<Operation>
- */
-export interface OperationListResult extends Array<Operation> {
-  /**
-   * URL to get the next set of operation list results if there are any.
-   */
-  nextLink?: string;
+/** Optional parameters. */
+export interface ManagementLocksListAtResourceLevelOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
 }
 
-/**
- * @interface
- * The list of locks.
- * @extends Array<ManagementLockObject>
- */
-export interface ManagementLockListResult extends Array<ManagementLockObject> {
-  /**
-   * The URL to use for getting the next set of results.
-   */
-  nextLink?: string;
+/** Contains response data for the listAtResourceLevel operation. */
+export type ManagementLocksListAtResourceLevelResponse = ManagementLockListResult;
+
+/** Optional parameters. */
+export interface ManagementLocksListAtSubscriptionLevelOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
 }
 
-/**
- * Defines values for LockLevel.
- * Possible values include: 'NotSpecified', 'CanNotDelete', 'ReadOnly'
- * @readonly
- * @enum {string}
- */
-export type LockLevel = 'NotSpecified' | 'CanNotDelete' | 'ReadOnly';
+/** Contains response data for the listAtSubscriptionLevel operation. */
+export type ManagementLocksListAtSubscriptionLevelResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the list operation.
- */
-export type AuthorizationOperationsListResponse = OperationListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: OperationListResult;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListByScopeOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the listNext operation.
- */
-export type AuthorizationOperationsListNextResponse = OperationListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: OperationListResult;
-    };
-};
+/** Contains response data for the listByScope operation. */
+export type ManagementLocksListByScopeResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the createOrUpdateAtResourceGroupLevel operation.
- */
-export type ManagementLocksCreateOrUpdateAtResourceGroupLevelResponse = ManagementLockObject & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockObject;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListAtResourceGroupLevelNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the getAtResourceGroupLevel operation.
- */
-export type ManagementLocksGetAtResourceGroupLevelResponse = ManagementLockObject & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockObject;
-    };
-};
+/** Contains response data for the listAtResourceGroupLevelNext operation. */
+export type ManagementLocksListAtResourceGroupLevelNextResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the createOrUpdateByScope operation.
- */
-export type ManagementLocksCreateOrUpdateByScopeResponse = ManagementLockObject & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockObject;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListAtResourceLevelNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the getByScope operation.
- */
-export type ManagementLocksGetByScopeResponse = ManagementLockObject & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockObject;
-    };
-};
+/** Contains response data for the listAtResourceLevelNext operation. */
+export type ManagementLocksListAtResourceLevelNextResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the createOrUpdateAtResourceLevel operation.
- */
-export type ManagementLocksCreateOrUpdateAtResourceLevelResponse = ManagementLockObject & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockObject;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListAtSubscriptionLevelNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the getAtResourceLevel operation.
- */
-export type ManagementLocksGetAtResourceLevelResponse = ManagementLockObject & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockObject;
-    };
-};
+/** Contains response data for the listAtSubscriptionLevelNext operation. */
+export type ManagementLocksListAtSubscriptionLevelNextResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the createOrUpdateAtSubscriptionLevel operation.
- */
-export type ManagementLocksCreateOrUpdateAtSubscriptionLevelResponse = ManagementLockObject & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockObject;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListByScopeNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the getAtSubscriptionLevel operation.
- */
-export type ManagementLocksGetAtSubscriptionLevelResponse = ManagementLockObject & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockObject;
-    };
-};
+/** Contains response data for the listByScopeNext operation. */
+export type ManagementLocksListByScopeNextResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the listAtResourceGroupLevel operation.
- */
-export type ManagementLocksListAtResourceGroupLevelResponse = ManagementLockListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockListResult;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListAtResourceGroupLevelNextNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the listAtResourceLevel operation.
- */
-export type ManagementLocksListAtResourceLevelResponse = ManagementLockListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockListResult;
-    };
-};
+/** Contains response data for the listAtResourceGroupLevelNextNext operation. */
+export type ManagementLocksListAtResourceGroupLevelNextNextResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the listAtSubscriptionLevel operation.
- */
-export type ManagementLocksListAtSubscriptionLevelResponse = ManagementLockListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockListResult;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListAtResourceLevelNextNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the listByScope operation.
- */
-export type ManagementLocksListByScopeResponse = ManagementLockListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockListResult;
-    };
-};
+/** Contains response data for the listAtResourceLevelNextNext operation. */
+export type ManagementLocksListAtResourceLevelNextNextResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the listAtResourceGroupLevelNext operation.
- */
-export type ManagementLocksListAtResourceGroupLevelNextResponse = ManagementLockListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockListResult;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListAtSubscriptionLevelNextNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the listAtResourceLevelNext operation.
- */
-export type ManagementLocksListAtResourceLevelNextResponse = ManagementLockListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockListResult;
-    };
-};
+/** Contains response data for the listAtSubscriptionLevelNextNext operation. */
+export type ManagementLocksListAtSubscriptionLevelNextNextResponse = ManagementLockListResult;
 
-/**
- * Contains response data for the listAtSubscriptionLevelNext operation.
- */
-export type ManagementLocksListAtSubscriptionLevelNextResponse = ManagementLockListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockListResult;
-    };
-};
+/** Optional parameters. */
+export interface ManagementLocksListByScopeNextNextOptionalParams
+  extends coreClient.OperationOptions {
+  /** The filter to apply on the operation. */
+  filter?: string;
+}
 
-/**
- * Contains response data for the listByScopeNext operation.
- */
-export type ManagementLocksListByScopeNextResponse = ManagementLockListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
-
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: ManagementLockListResult;
-    };
-};
+/** Contains response data for the listByScopeNextNext operation. */
+export type ManagementLocksListByScopeNextNextResponse = ManagementLockListResult;
+
+/** Optional parameters. */
+export interface ManagementLockClientOptionalParams
+  extends coreClient.ServiceClientOptions {
+  /** server parameter */
+  $host?: string;
+  /** Api Version */
+  apiVersion?: string;
+  /** Overrides client endpoint. */
+  endpoint?: string;
+}