mirror of
https://github.com/hanzoai/azure-sdk-for-js.git
synced 2026-10-30 19:51:51 +00:00
Updates the API extraction logic to generate the full report for the node package. It also generates API difference report for any other supported package/runtime.
21 KiB
21 KiB
API Report File for "@azure/arm-hardwaresecuritymodules"
Do not edit this file. It is a report generated by API Extractor.
import { AbortSignalLike } from '@azure/abort-controller';
import { ClientOptions } from '@azure-rest/core-client';
import { OperationOptions } from '@azure-rest/core-client';
import { OperationState } from '@azure/core-lro';
import { PathUncheckedResponse } from '@azure-rest/core-client';
import { Pipeline } from '@azure/core-rest-pipeline';
import { PollerLike } from '@azure/core-lro';
import { TokenCredential } from '@azure/core-auth';
// @public
export type ActionType = string;
// @public
export type ActivationState = string;
// @public
export interface ApiEntityReference {
resourceId?: string;
}
// @public
export type AutoGeneratedDomainNameLabelScope = string;
// @public (undocumented)
export class AzureDedicatedHSMResourceProvider {
constructor(credential: TokenCredential, subscriptionId: string, options?: AzureDedicatedHSMResourceProviderOptionalParams);
readonly cloudHsmClusterBackupStatus: CloudHsmClusterBackupStatusOperations;
readonly cloudHsmClusterPrivateEndpointConnections: CloudHsmClusterPrivateEndpointConnectionsOperations;
readonly cloudHsmClusterPrivateLinkResources: CloudHsmClusterPrivateLinkResourcesOperations;
readonly cloudHsmClusterRestoreStatus: CloudHsmClusterRestoreStatusOperations;
readonly cloudHsmClusters: CloudHsmClustersOperations;
readonly dedicatedHsm: DedicatedHsmOperations;
readonly operations: OperationsOperations;
readonly pipeline: Pipeline;
readonly privateEndpointConnections: PrivateEndpointConnectionsOperations;
}
// @public
export interface AzureDedicatedHSMResourceProviderOptionalParams extends ClientOptions {
apiVersion?: string;
}
// @public
export interface BackupRequestProperties extends BackupRestoreRequestBaseProperties {
}
// @public
export interface BackupRestoreBaseResultProperties {
readonly endTime?: Date | null;
error?: ErrorDetail;
jobId?: string;
readonly startTime?: Date;
readonly status?: BackupRestoreOperationStatus;
statusDetails?: string;
}
// @public
export type BackupRestoreOperationStatus = string;
// @public
export interface BackupRestoreRequestBaseProperties {
azureStorageBlobContainerUri: string;
token?: string;
}
// @public
export interface BackupResult {
properties?: BackupResultProperties;
}
// @public
export interface BackupResultProperties extends BackupRestoreBaseResultProperties {
azureStorageBlobContainerUri?: string;
backupId?: string;
}
// @public
export interface CloudHsmCluster extends TrackedResource {
identity?: ManagedServiceIdentity;
properties?: CloudHsmClusterProperties;
sku?: CloudHsmClusterSku;
}
// @public
export interface CloudHsmClusterBackupStatusGetOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClusterBackupStatusOperations {
get: (resourceGroupName: string, cloudHsmClusterName: string, jobId: string, options?: CloudHsmClusterBackupStatusGetOptionalParams) => PollerLike<OperationState<void>, void>;
}
// @public
export interface CloudHsmClusterPatchParameters {
identity?: ManagedServiceIdentity;
tags?: Record<string, string>;
}
// @public
export interface CloudHsmClusterPrivateEndpointConnectionsCreateOptionalParams extends OperationOptions {
}
// @public
export interface CloudHsmClusterPrivateEndpointConnectionsDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClusterPrivateEndpointConnectionsGetOptionalParams extends OperationOptions {
}
// @public
export interface CloudHsmClusterPrivateEndpointConnectionsOperations {
create: (resourceGroupName: string, cloudHsmClusterName: string, peConnectionName: string, properties: PrivateEndpointConnection, options?: CloudHsmClusterPrivateEndpointConnectionsCreateOptionalParams) => Promise<PrivateEndpointConnection>;
delete: (resourceGroupName: string, cloudHsmClusterName: string, peConnectionName: string, options?: CloudHsmClusterPrivateEndpointConnectionsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
get: (resourceGroupName: string, cloudHsmClusterName: string, peConnectionName: string, options?: CloudHsmClusterPrivateEndpointConnectionsGetOptionalParams) => Promise<PrivateEndpointConnection>;
}
// @public
export interface CloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterOptionalParams extends OperationOptions {
}
// @public
export interface CloudHsmClusterPrivateLinkResourcesOperations {
listByCloudHsmCluster: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterOptionalParams) => PagedAsyncIterableIterator<PrivateLinkResource>;
}
// @public
export interface CloudHsmClusterProperties {
readonly activationState?: ActivationState;
autoGeneratedDomainNameLabelScope?: AutoGeneratedDomainNameLabelScope;
readonly hsms?: CloudHsmProperties[];
readonly privateEndpointConnections?: PrivateEndpointConnection[];
readonly provisioningState?: ProvisioningState;
publicNetworkAccess?: PublicNetworkAccess;
readonly statusMessage?: string;
}
// @public
export interface CloudHsmClusterRestoreStatusGetOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClusterRestoreStatusOperations {
get: (resourceGroupName: string, cloudHsmClusterName: string, jobId: string, options?: CloudHsmClusterRestoreStatusGetOptionalParams) => PollerLike<OperationState<void>, void>;
}
// @public
export interface CloudHsmClustersBackupOptionalParams extends OperationOptions {
backupRequestProperties?: BackupRequestProperties;
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClustersCreateOrUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClustersDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClustersGetOptionalParams extends OperationOptions {
}
// @public
export interface CloudHsmClusterSku {
capacity?: number;
family: CloudHsmClusterSkuFamily;
name: CloudHsmClusterSkuName;
}
// @public
export type CloudHsmClusterSkuFamily = string;
// @public
export type CloudHsmClusterSkuName = "Standard_B1" | "Standard B10";
// @public
export interface CloudHsmClustersListByResourceGroupOptionalParams extends OperationOptions {
skiptoken?: string;
}
// @public
export interface CloudHsmClustersListBySubscriptionOptionalParams extends OperationOptions {
skiptoken?: string;
}
// @public
export interface CloudHsmClustersOperations {
backup: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersBackupOptionalParams) => PollerLike<OperationState<BackupResult>, BackupResult>;
createOrUpdate: (resourceGroupName: string, cloudHsmClusterName: string, body: CloudHsmCluster, options?: CloudHsmClustersCreateOrUpdateOptionalParams) => PollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>;
delete: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
get: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersGetOptionalParams) => Promise<CloudHsmCluster>;
listByResourceGroup: (resourceGroupName: string, options?: CloudHsmClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<CloudHsmCluster>;
listBySubscription: (options?: CloudHsmClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<CloudHsmCluster>;
restore: (resourceGroupName: string, cloudHsmClusterName: string, restoreRequestProperties: RestoreRequestProperties, options?: CloudHsmClustersRestoreOptionalParams) => PollerLike<OperationState<RestoreResult>, RestoreResult>;
update: (resourceGroupName: string, cloudHsmClusterName: string, body: CloudHsmClusterPatchParameters, options?: CloudHsmClustersUpdateOptionalParams) => PollerLike<OperationState<CloudHsmCluster>, CloudHsmCluster>;
validateBackupProperties: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateBackupPropertiesOptionalParams) => PollerLike<OperationState<BackupResult>, BackupResult>;
validateRestoreProperties: (resourceGroupName: string, cloudHsmClusterName: string, options?: CloudHsmClustersValidateRestorePropertiesOptionalParams) => PollerLike<OperationState<RestoreResult>, RestoreResult>;
}
// @public
export interface CloudHsmClustersRestoreOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClustersUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClustersValidateBackupPropertiesOptionalParams extends OperationOptions {
backupRequestProperties?: BackupRequestProperties;
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmClustersValidateRestorePropertiesOptionalParams extends OperationOptions {
restoreRequestProperties?: RestoreRequestProperties;
updateIntervalInMs?: number;
}
// @public
export interface CloudHsmProperties {
fqdn?: string;
state?: string;
stateMessage?: string;
}
// @public
export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
continuationToken?: string;
};
// @public
export type CreatedByType = string;
// @public
export interface DedicatedHsm extends TrackedResource {
properties: DedicatedHsmProperties;
sku: Sku;
zones?: string[];
}
// @public
export interface DedicatedHsmCreateOrUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface DedicatedHsmDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface DedicatedHsmError {
readonly error?: ErrorModel;
}
// @public
export interface DedicatedHsmGetOptionalParams extends OperationOptions {
}
// @public
export interface DedicatedHsmListByResourceGroupOptionalParams extends OperationOptions {
top?: number;
}
// @public
export interface DedicatedHsmListBySubscriptionOptionalParams extends OperationOptions {
top?: number;
}
// @public
export interface DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams extends OperationOptions {
}
// @public
export interface DedicatedHsmOperations {
createOrUpdate: (resourceGroupName: string, name: string, parameters: DedicatedHsm, options?: DedicatedHsmCreateOrUpdateOptionalParams) => PollerLike<OperationState<DedicatedHsm>, DedicatedHsm>;
delete: (resourceGroupName: string, name: string, options?: DedicatedHsmDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
get: (resourceGroupName: string, name: string, options?: DedicatedHsmGetOptionalParams) => Promise<DedicatedHsm>;
listByResourceGroup: (resourceGroupName: string, options?: DedicatedHsmListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<DedicatedHsm>;
listBySubscription: (options?: DedicatedHsmListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<DedicatedHsm>;
listOutboundNetworkDependenciesEndpoints: (resourceGroupName: string, name: string, options?: DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams) => PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>;
update: (resourceGroupName: string, name: string, parameters: DedicatedHsmPatchParameters, options?: DedicatedHsmUpdateOptionalParams) => PollerLike<OperationState<DedicatedHsm>, DedicatedHsm>;
}
// @public
export interface DedicatedHsmPatchParameters {
tags?: Record<string, string>;
}
// @public
export interface DedicatedHsmProperties {
managementNetworkProfile?: NetworkProfile;
networkProfile?: NetworkProfile;
readonly provisioningState?: JsonWebKeyType;
stampId?: string;
readonly statusMessage?: string;
}
// @public
export interface DedicatedHsmUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface EndpointDependency {
domainName?: string;
endpointDetails?: EndpointDetail[];
}
// @public
export interface EndpointDetail {
description?: string;
ipAddress?: string;
port?: number;
protocol?: string;
}
// @public
export interface ErrorAdditionalInfo {
readonly info?: any;
readonly type?: string;
}
// @public
export interface ErrorDetail {
readonly additionalInfo?: ErrorAdditionalInfo[];
readonly code?: string;
readonly details?: ErrorDetail[];
readonly message?: string;
readonly target?: string;
}
// @public
export interface ErrorModel {
readonly code?: string;
readonly innerError?: ErrorModel;
readonly message?: string;
}
// @public
export interface ErrorResponse {
error?: ErrorDetail;
}
// @public
export type JsonWebKeyType = string;
// @public
export enum KnownActionType {
Internal = "Internal"
}
// @public
export enum KnownActivationState {
// (undocumented)
Active = "Active",
// (undocumented)
Failed = "Failed",
// (undocumented)
NotActivated = "NotActivated",
// (undocumented)
NotDefined = "NotDefined",
// (undocumented)
Unknown = "Unknown"
}
// @public
export enum KnownAutoGeneratedDomainNameLabelScope {
// (undocumented)
NoReuse = "NoReuse",
// (undocumented)
ResourceGroupReuse = "ResourceGroupReuse",
// (undocumented)
SubscriptionReuse = "SubscriptionReuse",
// (undocumented)
TenantReuse = "TenantReuse"
}
// @public
export enum KnownBackupRestoreOperationStatus {
// (undocumented)
Cancelled = "Cancelled",
// (undocumented)
Failed = "Failed",
// (undocumented)
InProgress = "InProgress",
// (undocumented)
Succeeded = "Succeeded"
}
// @public
export enum KnownCloudHsmClusterSkuFamily {
// (undocumented)
B = "B"
}
// @public
export enum KnownCreatedByType {
Application = "Application",
Key = "Key",
ManagedIdentity = "ManagedIdentity",
User = "User"
}
// @public
export enum KnownJsonWebKeyType {
Allocating = "Allocating",
CheckingQuota = "CheckingQuota",
Connecting = "Connecting",
Deleting = "Deleting",
Failed = "Failed",
Provisioning = "Provisioning",
Succeeded = "Succeeded"
}
// @public
export enum KnownManagedServiceIdentityType {
None = "None",
SystemAssigned = "SystemAssigned",
SystemAssignedUserAssigned = "SystemAssigned,UserAssigned",
UserAssigned = "UserAssigned"
}
// @public
export enum KnownOrigin {
System = "system",
User = "user",
UserSystem = "user,system"
}
// @public
export enum KnownPrivateEndpointConnectionProvisioningState {
// (undocumented)
Canceled = "Canceled",
// (undocumented)
Creating = "Creating",
// (undocumented)
Deleting = "Deleting",
// (undocumented)
Failed = "Failed",
// (undocumented)
InternalError = "InternalError",
// (undocumented)
Succeeded = "Succeeded",
// (undocumented)
Updating = "Updating"
}
// @public
export enum KnownPrivateEndpointServiceConnectionStatus {
Approved = "Approved",
Pending = "Pending",
Rejected = "Rejected"
}
// @public
export enum KnownProvisioningState {
// (undocumented)
Canceled = "Canceled",
// (undocumented)
Deleting = "Deleting",
// (undocumented)
Failed = "Failed",
// (undocumented)
Provisioning = "Provisioning",
// (undocumented)
Succeeded = "Succeeded",
// (undocumented)
Updating = "Updating"
}
// @public
export enum KnownPublicNetworkAccess {
// (undocumented)
Disabled = "Disabled"
}
// @public
export enum KnownSkuName {
PayShield10KLMK1CPS250 = "payShield10K_LMK1_CPS250",
PayShield10KLMK1CPS2500 = "payShield10K_LMK1_CPS2500",
PayShield10KLMK1CPS60 = "payShield10K_LMK1_CPS60",
PayShield10KLMK2CPS250 = "payShield10K_LMK2_CPS250",
PayShield10KLMK2CPS2500 = "payShield10K_LMK2_CPS2500",
PayShield10KLMK2CPS60 = "payShield10K_LMK2_CPS60",
SafeNetLunaNetworkHSMA790 = "SafeNet Luna Network HSM A790"
}
// @public
export enum KnownVersions {
V20250331 = "2025-03-31"
}
// @public
export interface ManagedServiceIdentity {
readonly principalId?: string;
readonly tenantId?: string;
type: ManagedServiceIdentityType;
userAssignedIdentities?: Record<string, UserAssignedIdentity | null>;
}
// @public
export type ManagedServiceIdentityType = string;
// @public
export interface NetworkInterface {
privateIpAddress?: string;
readonly resourceId?: string;
}
// @public
export interface NetworkProfile {
networkInterfaces?: NetworkInterface[];
subnet?: ApiEntityReference;
}
// @public
export interface Operation {
readonly actionType?: ActionType;
display?: OperationDisplay;
readonly isDataAction?: boolean;
readonly name?: string;
readonly origin?: Origin;
}
// @public
export interface OperationDisplay {
readonly description?: string;
readonly operation?: string;
readonly provider?: string;
readonly resource?: string;
}
// @public
export interface OperationsListOptionalParams extends OperationOptions {
}
// @public
export interface OperationsOperations {
list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
}
// @public
export type Origin = string;
// @public
export interface OutboundEnvironmentEndpoint {
category?: string;
endpoints?: EndpointDependency[];
}
// @public
export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
[Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
next(): Promise<IteratorResult<TElement>>;
}
// @public
export interface PageSettings {
continuationToken?: string;
}
// @public
export interface PrivateEndpoint {
readonly id?: string;
}
// @public
export interface PrivateEndpointConnection extends ProxyResource {
etag?: string;
properties?: PrivateEndpointConnectionProperties;
}
// @public
export interface PrivateEndpointConnectionProperties {
readonly groupIds?: string[];
privateEndpoint?: PrivateEndpoint;
privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;
readonly provisioningState?: PrivateEndpointConnectionProvisioningState;
}
// @public
export type PrivateEndpointConnectionProvisioningState = string;
// @public
export interface PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams extends OperationOptions {
}
// @public
export interface PrivateEndpointConnectionsOperations {
listByCloudHsmCluster: (resourceGroupName: string, cloudHsmClusterName: string, options?: PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams) => PagedAsyncIterableIterator<PrivateEndpointConnection>;
}
// @public
export type PrivateEndpointServiceConnectionStatus = string;
// @public
export interface PrivateLinkResource extends Resource {
properties?: PrivateLinkResourceProperties;
}
// @public
export interface PrivateLinkResourceProperties {
readonly groupId?: string;
readonly requiredMembers?: string[];
requiredZoneNames?: string[];
}
// @public
export interface PrivateLinkServiceConnectionState {
actionsRequired?: string;
description?: string;
status?: PrivateEndpointServiceConnectionStatus;
}
// @public
export type ProvisioningState = string;
// @public
export interface ProxyResource extends Resource {
}
// @public
export type PublicNetworkAccess = string;
// @public
export interface Resource {
readonly id?: string;
readonly name?: string;
readonly systemData?: SystemData;
readonly type?: string;
}
// @public
export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: AzureDedicatedHSMResourceProvider, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
// @public (undocumented)
export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
abortSignal?: AbortSignalLike;
processResponseBody?: (result: TResponse) => Promise<TResult>;
updateIntervalInMs?: number;
}
// @public
export interface RestoreRequestProperties extends BackupRestoreRequestBaseProperties {
backupId: string;
}
// @public
export interface RestoreResult {
properties?: BackupRestoreBaseResultProperties;
}
// @public
export interface Sku {
name?: SkuName;
}
// @public
export type SkuName = string;
// @public
export interface SystemData {
createdAt?: Date;
createdBy?: string;
createdByType?: CreatedByType;
lastModifiedAt?: Date;
lastModifiedBy?: string;
lastModifiedByType?: CreatedByType;
}
// @public
export interface TrackedResource extends Resource {
location: string;
tags?: Record<string, string>;
}
// @public
export interface UserAssignedIdentity {
readonly clientId?: string;
readonly principalId?: string;
}
// (No @packageDocumentation comment for this package)