@azure/arm-hardwaresecuritymodules 1.0.0

package/types/arm-hardwaresecuritymodules.d.ts

@@ -0,0 +1,524 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+/** The API entity reference. */
+export declare interface ApiEntityReference {
+    /** The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */
+    id?: string;
+}
+
+export declare class AzureDedicatedHSMResourceProvider extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    subscriptionId: string;
+    /**
+     * Initializes a new instance of the AzureDedicatedHSMResourceProvider class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param subscriptionId 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: coreAuth.TokenCredential, subscriptionId: string, options?: AzureDedicatedHSMResourceProviderOptionalParams);
+    operations: Operations;
+    dedicatedHsmOperations: DedicatedHsmOperations;
+}
+
+/** Optional parameters. */
+export declare interface AzureDedicatedHSMResourceProviderOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** Resource information with extended details. */
+export declare type DedicatedHsm = Resource & {
+    /**
+     * Metadata pertaining to creation and last modification of the resource
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly systemData?: SystemData;
+    /** Specifies the network interfaces of the dedicated hsm. */
+    networkProfile?: NetworkProfile;
+    /** Specifies the management network interfaces of the dedicated hsm. */
+    managementNetworkProfile?: NetworkProfile;
+    /** This field will be used when RP does not support Availability zones. */
+    stampId?: string;
+    /**
+     * Resource Status Message.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly statusMessage?: string;
+    /**
+     * Provisioning state.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly provisioningState?: JsonWebKeyType;
+};
+
+/** Optional parameters. */
+export declare interface DedicatedHsmCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type DedicatedHsmCreateOrUpdateResponse = DedicatedHsm;
+
+/** Optional parameters. */
+export declare interface DedicatedHsmDeleteOptionalParams extends coreClient.OperationOptions {
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** The error exception. */
+export declare interface DedicatedHsmError {
+    /**
+     * The error detail of the operation if any.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly error?: ErrorModel;
+}
+
+/** Optional parameters. */
+export declare interface DedicatedHsmGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type DedicatedHsmGetResponse = DedicatedHsm;
+
+/** Optional parameters. */
+export declare interface DedicatedHsmListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+    /** Maximum number of results to return. */
+    top?: number;
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export declare type DedicatedHsmListByResourceGroupNextResponse = DedicatedHsmListResult;
+
+/** Optional parameters. */
+export declare interface DedicatedHsmListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+    /** Maximum number of results to return. */
+    top?: number;
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type DedicatedHsmListByResourceGroupResponse = DedicatedHsmListResult;
+
+/** Optional parameters. */
+export declare interface DedicatedHsmListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
+    /** Maximum number of results to return. */
+    top?: number;
+}
+
+/** Contains response data for the listBySubscriptionNext operation. */
+export declare type DedicatedHsmListBySubscriptionNextResponse = DedicatedHsmListResult;
+
+/** Optional parameters. */
+export declare interface DedicatedHsmListBySubscriptionOptionalParams extends coreClient.OperationOptions {
+    /** Maximum number of results to return. */
+    top?: number;
+}
+
+/** Contains response data for the listBySubscription operation. */
+export declare type DedicatedHsmListBySubscriptionResponse = DedicatedHsmListResult;
+
+/** Optional parameters. */
+export declare interface DedicatedHsmListOutboundNetworkDependenciesEndpointsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation. */
+export declare type DedicatedHsmListOutboundNetworkDependenciesEndpointsNextResponse = OutboundEnvironmentEndpointCollection;
+
+/** Optional parameters. */
+export declare interface DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listOutboundNetworkDependenciesEndpoints operation. */
+export declare type DedicatedHsmListOutboundNetworkDependenciesEndpointsResponse = OutboundEnvironmentEndpointCollection;
+
+/** List of dedicated HSMs */
+export declare interface DedicatedHsmListResult {
+    /** The list of dedicated HSMs. */
+    value?: DedicatedHsm[];
+    /** The URL to get the next set of dedicated hsms. */
+    nextLink?: string;
+}
+
+/** REST API operation */
+export declare interface DedicatedHsmOperation {
+    /** The name of the Dedicated HSM Resource Provider Operation. */
+    name?: string;
+    /**
+     * Gets or sets a value indicating whether it is a data plane action
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly isDataAction?: string;
+    /** The display string. */
+    display?: DedicatedHsmOperationDisplay;
+}
+
+/** The display string. */
+export declare interface DedicatedHsmOperationDisplay {
+    /** The Resource Provider of the operation */
+    provider?: string;
+    /** Resource on which the operation is performed. */
+    resource?: string;
+    /** Operation type: Read, write, delete, etc. */
+    operation?: string;
+    /** The object that represents the operation. */
+    description?: string;
+}
+
+/** Result of the request to list Dedicated HSM Provider operations. It contains a list of operations. */
+export declare interface DedicatedHsmOperationListResult {
+    /** List of Dedicated HSM Resource Provider operations. */
+    value?: DedicatedHsmOperation[];
+}
+
+/** Interface representing a DedicatedHsmOperations. */
+export declare interface DedicatedHsmOperations {
+    /**
+     * The List operation gets information about the dedicated hsms associated with the subscription and
+     * within the specified resource group.
+     * @param resourceGroupName The name of the Resource Group to which the dedicated HSM belongs.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: DedicatedHsmListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DedicatedHsm>;
+    /**
+     * The List operation gets information about the dedicated HSMs associated with the subscription.
+     * @param options The options parameters.
+     */
+    listBySubscription(options?: DedicatedHsmListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DedicatedHsm>;
+    /**
+     * Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified
+     * dedicated hsm resource. The operation returns properties of each egress endpoint.
+     * @param resourceGroupName The name of the Resource Group to which the dedicated hsm belongs.
+     * @param name The name of the dedicated HSM.
+     * @param options The options parameters.
+     */
+    listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, name: string, options?: DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>;
+    /**
+     * Create or Update a dedicated HSM in the specified subscription.
+     * @param resourceGroupName The name of the Resource Group to which the resource belongs.
+     * @param name Name of the dedicated Hsm
+     * @param parameters Parameters to create or update the dedicated hsm
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdate(resourceGroupName: string, name: string, parameters: DedicatedHsm, options?: DedicatedHsmCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedHsmCreateOrUpdateResponse>, DedicatedHsmCreateOrUpdateResponse>>;
+    /**
+     * Create or Update a dedicated HSM in the specified subscription.
+     * @param resourceGroupName The name of the Resource Group to which the resource belongs.
+     * @param name Name of the dedicated Hsm
+     * @param parameters Parameters to create or update the dedicated hsm
+     * @param options The options parameters.
+     */
+    beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, parameters: DedicatedHsm, options?: DedicatedHsmCreateOrUpdateOptionalParams): Promise<DedicatedHsmCreateOrUpdateResponse>;
+    /**
+     * Update a dedicated HSM in the specified subscription.
+     * @param resourceGroupName The name of the Resource Group to which the server belongs.
+     * @param name Name of the dedicated HSM
+     * @param options The options parameters.
+     */
+    beginUpdate(resourceGroupName: string, name: string, options?: DedicatedHsmUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedHsmUpdateResponse>, DedicatedHsmUpdateResponse>>;
+    /**
+     * Update a dedicated HSM in the specified subscription.
+     * @param resourceGroupName The name of the Resource Group to which the server belongs.
+     * @param name Name of the dedicated HSM
+     * @param options The options parameters.
+     */
+    beginUpdateAndWait(resourceGroupName: string, name: string, options?: DedicatedHsmUpdateOptionalParams): Promise<DedicatedHsmUpdateResponse>;
+    /**
+     * Deletes the specified Azure Dedicated HSM.
+     * @param resourceGroupName The name of the Resource Group to which the dedicated HSM belongs.
+     * @param name The name of the dedicated HSM to delete
+     * @param options The options parameters.
+     */
+    beginDelete(resourceGroupName: string, name: string, options?: DedicatedHsmDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    /**
+     * Deletes the specified Azure Dedicated HSM.
+     * @param resourceGroupName The name of the Resource Group to which the dedicated HSM belongs.
+     * @param name The name of the dedicated HSM to delete
+     * @param options The options parameters.
+     */
+    beginDeleteAndWait(resourceGroupName: string, name: string, options?: DedicatedHsmDeleteOptionalParams): Promise<void>;
+    /**
+     * Gets the specified Azure dedicated HSM.
+     * @param resourceGroupName The name of the Resource Group to which the dedicated hsm belongs.
+     * @param name The name of the dedicated HSM.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, name: string, options?: DedicatedHsmGetOptionalParams): Promise<DedicatedHsmGetResponse>;
+}
+
+/** Patchable properties of the dedicated HSM */
+export declare interface DedicatedHsmPatchParameters {
+    /** Resource tags */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** Optional parameters. */
+export declare interface DedicatedHsmUpdateOptionalParams extends coreClient.OperationOptions {
+    /** Resource tags */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the update operation. */
+export declare type DedicatedHsmUpdateResponse = DedicatedHsm;
+
+/** A domain name that dedicated hsm services are reaching at. */
+export declare interface EndpointDependency {
+    /** The domain name of the dependency. */
+    domainName?: string;
+    /** The Ports and Protocols used when connecting to domainName. */
+    endpointDetails?: EndpointDetail[];
+}
+
+/** Connect information from the dedicated hsm service to a single endpoint. */
+export declare interface EndpointDetail {
+    /** An IP Address that Domain Name currently resolves to. */
+    ipAddress?: string;
+    /** The port an endpoint is connected to. */
+    port?: number;
+    /** The protocol used for connection */
+    protocol?: string;
+    /** Description of the detail */
+    description?: string;
+}
+
+/** The key vault server error. */
+export declare interface ErrorModel {
+    /**
+     * The error code.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * The error message.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /**
+     * Contains more specific error that narrows down the cause. May be null.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly innerError?: ErrorModel;
+}
+
+/**
+ * Defines values for IdentityType. \
+ * {@link KnownIdentityType} can be used interchangeably with IdentityType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User** \
+ * **Application** \
+ * **ManagedIdentity** \
+ * **Key**
+ */
+export declare type IdentityType = string;
+
+/**
+ * Defines values for JsonWebKeyType. \
+ * {@link KnownJsonWebKeyType} can be used interchangeably with JsonWebKeyType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Succeeded**: The dedicated HSM has been full provisioned. \
+ * **Provisioning**: The dedicated HSM is currently being provisioned. \
+ * **Allocating**: A device is currently being allocated for the dedicated HSM resource. \
+ * **Connecting**: The dedicated HSM is being connected to the virtual network. \
+ * **Failed**: Provisioning of the dedicated HSM has failed. \
+ * **CheckingQuota**: Validating the subscription has sufficient quota to allocate a dedicated HSM device. \
+ * **Deleting**: The dedicated HSM is currently being deleted.
+ */
+export declare type JsonWebKeyType = string;
+
+/** Known values of {@link IdentityType} that the service accepts. */
+export declare enum KnownIdentityType {
+    User = "User",
+    Application = "Application",
+    ManagedIdentity = "ManagedIdentity",
+    Key = "Key"
+}
+
+/** Known values of {@link JsonWebKeyType} that the service accepts. */
+export declare enum KnownJsonWebKeyType {
+    /** The dedicated HSM has been full provisioned. */
+    Succeeded = "Succeeded",
+    /** The dedicated HSM is currently being provisioned. */
+    Provisioning = "Provisioning",
+    /** A device is currently being allocated for the dedicated HSM resource. */
+    Allocating = "Allocating",
+    /** The dedicated HSM is being connected to the virtual network. */
+    Connecting = "Connecting",
+    /** Provisioning of the dedicated HSM has failed. */
+    Failed = "Failed",
+    /** Validating the subscription has sufficient quota to allocate a dedicated HSM device. */
+    CheckingQuota = "CheckingQuota",
+    /** The dedicated HSM is currently being deleted. */
+    Deleting = "Deleting"
+}
+
+/** Known values of {@link SkuName} that the service accepts. */
+export declare enum KnownSkuName {
+    /** The dedicated HSM is a Safenet Luna Network HSM A790 device. */
+    SafeNetLunaNetworkHSMA790 = "SafeNet Luna Network HSM A790",
+    /** The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 60 calls per second. */
+    PayShield10KLMK1CPS60 = "payShield10K_LMK1_CPS60",
+    /** The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 250 calls per second. */
+    PayShield10KLMK1CPS250 = "payShield10K_LMK1_CPS250",
+    /** The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 2500 calls per second. */
+    PayShield10KLMK1CPS2500 = "payShield10K_LMK1_CPS2500",
+    /** The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 60 calls per second. */
+    PayShield10KLMK2CPS60 = "payShield10K_LMK2_CPS60",
+    /** The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 250 calls per second. */
+    PayShield10KLMK2CPS250 = "payShield10K_LMK2_CPS250",
+    /** The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 2500 calls per second. */
+    PayShield10KLMK2CPS2500 = "payShield10K_LMK2_CPS2500"
+}
+
+/** The network interface definition. */
+export declare interface NetworkInterface {
+    /**
+     * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /** Private Ip address of the interface */
+    privateIpAddress?: string;
+}
+
+/** The network profile definition. */
+export declare interface NetworkProfile {
+    /** Specifies the identifier of the subnet. */
+    subnet?: ApiEntityReference;
+    /** Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. */
+    networkInterfaces?: NetworkInterface[];
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * Get a list of Dedicated HSM operations.
+     * @param options The options parameters.
+     */
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<DedicatedHsmOperation>;
+}
+
+/** Optional parameters. */
+export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OperationsListResponse = DedicatedHsmOperationListResult;
+
+/** Egress endpoints which dedicated hsm service connects to for common purpose. */
+export declare interface OutboundEnvironmentEndpoint {
+    /** The category of endpoints accessed by the dedicated hsm service, e.g. azure-resource-management, apiserver, etc. */
+    category?: string;
+    /** The endpoints that dedicated hsm service connects to */
+    endpoints?: EndpointDependency[];
+}
+
+/** Collection of OutboundEnvironmentEndpoint */
+export declare interface OutboundEnvironmentEndpointCollection {
+    /** Collection of resources. */
+    value: OutboundEnvironmentEndpoint[];
+    /**
+     * Link to next page of resources.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly nextLink?: string;
+}
+
+/** Dedicated HSM resource */
+export declare interface Resource {
+    /**
+     * The Azure Resource Manager resource ID for the dedicated HSM.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly id?: string;
+    /**
+     * The name of the dedicated HSM.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly name?: string;
+    /**
+     * The resource type of the dedicated HSM.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /** The supported Azure location where the dedicated HSM should be created. */
+    location: string;
+    /** SKU details */
+    sku?: Sku;
+    /** The Dedicated Hsm zones. */
+    zones?: string[];
+    /** Resource tags */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** List of dedicated HSM resources. */
+export declare interface ResourceListResult {
+    /** The list of dedicated HSM resources. */
+    value?: Resource[];
+    /** The URL to get the next set of dedicated HSM resources. */
+    nextLink?: string;
+}
+
+/** SKU of the dedicated HSM */
+export declare interface Sku {
+    /** SKU of the dedicated HSM */
+    name?: SkuName;
+}
+
+/**
+ * Defines values for SkuName. \
+ * {@link KnownSkuName} can be used interchangeably with SkuName,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **SafeNet Luna Network HSM A790**: The dedicated HSM is a Safenet Luna Network HSM A790 device. \
+ * **payShield10K_LMK1_CPS60**: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 60 calls per second. \
+ * **payShield10K_LMK1_CPS250**: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 250 calls per second. \
+ * **payShield10K_LMK1_CPS2500**: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 1 local master key which supports up to 2500 calls per second. \
+ * **payShield10K_LMK2_CPS60**: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 60 calls per second. \
+ * **payShield10K_LMK2_CPS250**: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 250 calls per second. \
+ * **payShield10K_LMK2_CPS2500**: The dedicated HSM is a payShield 10K, model PS10-D, 10Gb Ethernet Hardware Platform device with 2 local master keys which supports up to 2500 calls per second.
+ */
+export declare type SkuName = string;
+
+/** Metadata pertaining to creation and last modification of dedicated hsm resource. */
+export declare interface SystemData {
+    /** The identity that created dedicated hsm resource. */
+    createdBy?: string;
+    /** The type of identity that created dedicated hsm resource. */
+    createdByType?: IdentityType;
+    /** The timestamp of dedicated hsm resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified dedicated hsm resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified dedicated hsm resource. */
+    lastModifiedByType?: IdentityType;
+    /** The timestamp of dedicated hsm resource last modification (UTC). */
+    lastModifiedAt?: Date;
+}
+
+export { }

package/types/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.19.5"
+    }
+  ]
+}