@azure/arm-hardwaresecuritymodules 2.0.0-beta.2 → 2.0.0

package/review/arm-hardwaresecuritymodules-api-dedicatedHsm.api.md

@@ -0,0 +1,68 @@
+## API Report File for "@azure/arm-hardwaresecuritymodules"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Client } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PollerLike } from '@azure/core-lro';
+
+// @public
+export function $delete(context: AzureDedicatedHSMResourceProviderContext, resourceGroupName: string, name: string, options?: DedicatedHsmDeleteOptionalParams): PollerLike<OperationState<void>, void>;
+
+// @public
+export function createOrUpdate(context: AzureDedicatedHSMResourceProviderContext, resourceGroupName: string, name: string, parameters: DedicatedHsm, options?: DedicatedHsmCreateOrUpdateOptionalParams): PollerLike<OperationState<DedicatedHsm>, DedicatedHsm>;
+
+// @public
+export interface DedicatedHsmCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface DedicatedHsmDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @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 DedicatedHsmUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export function get(context: AzureDedicatedHSMResourceProviderContext, resourceGroupName: string, name: string, options?: DedicatedHsmGetOptionalParams): Promise<DedicatedHsm>;
+
+// @public
+export function listByResourceGroup(context: AzureDedicatedHSMResourceProviderContext, resourceGroupName: string, options?: DedicatedHsmListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DedicatedHsm>;
+
+// @public
+export function listBySubscription(context: AzureDedicatedHSMResourceProviderContext, options?: DedicatedHsmListBySubscriptionOptionalParams): PagedAsyncIterableIterator<DedicatedHsm>;
+
+// @public
+export function listOutboundNetworkDependenciesEndpoints(context: AzureDedicatedHSMResourceProviderContext, resourceGroupName: string, name: string, options?: DedicatedHsmListOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>;
+
+// @public
+export function update(context: AzureDedicatedHSMResourceProviderContext, resourceGroupName: string, name: string, parameters: DedicatedHsmPatchParameters, options?: DedicatedHsmUpdateOptionalParams): PollerLike<OperationState<DedicatedHsm>, DedicatedHsm>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/review/arm-hardwaresecuritymodules-api-operations.api.md

@@ -0,0 +1,19 @@
+## API Report File for "@azure/arm-hardwaresecuritymodules"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Client } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+
+// @public
+export function list(context: AzureDedicatedHSMResourceProviderContext, options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/review/arm-hardwaresecuritymodules-api-privateEndpointConnections.api.md

@@ -0,0 +1,19 @@
+## API Report File for "@azure/arm-hardwaresecuritymodules"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Client } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+
+// @public
+export function listByCloudHsmCluster(context: AzureDedicatedHSMResourceProviderContext, resourceGroupName: string, cloudHsmClusterName: string, options?: PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
+
+// @public
+export interface PrivateEndpointConnectionsListByCloudHsmClusterOptionalParams extends OperationOptions {
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/review/arm-hardwaresecuritymodules-api.api.md

@@ -0,0 +1,27 @@
+## API Report File for "@azure/arm-hardwaresecuritymodules"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Client } from '@azure-rest/core-client';
+import { ClientOptions } from '@azure-rest/core-client';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export interface AzureDedicatedHSMResourceProviderContext extends Client {
+    apiVersion: string;
+    subscriptionId: string;
+}
+
+// @public
+export interface AzureDedicatedHSMResourceProviderOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export function createAzureDedicatedHSMResourceProvider(credential: TokenCredential, subscriptionId: string, options?: AzureDedicatedHSMResourceProviderOptionalParams): AzureDedicatedHSMResourceProviderContext;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/review/arm-hardwaresecuritymodules-models.api.md

@@ -0,0 +1,471 @@
+## API Report File for "@azure/arm-hardwaresecuritymodules"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type ActionType = string;
+
+// @public
+export type ActivationState = string;
+
+// @public
+export interface ApiEntityReference {
+    resourceId?: string;
+}
+
+// @public
+export type AutoGeneratedDomainNameLabelScope = 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 CloudHsmClusterPatchParameters {
+    identity?: ManagedServiceIdentity;
+    tags?: Record<string, string>;
+}
+
+// @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 CloudHsmClusterSku {
+    capacity?: number;
+    family: CloudHsmClusterSkuFamily;
+    name: CloudHsmClusterSkuName;
+}
+
+// @public
+export type CloudHsmClusterSkuFamily = string;
+
+// @public
+export type CloudHsmClusterSkuName = "Standard_B1" | "Standard B10";
+
+// @public
+export interface CloudHsmProperties {
+    fqdn?: string;
+    state?: string;
+    stateMessage?: string;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface DedicatedHsm extends TrackedResource {
+    properties: DedicatedHsmProperties;
+    sku: Sku;
+    zones?: string[];
+}
+
+// @public
+export interface DedicatedHsmError {
+    readonly error?: ErrorModel;
+}
+
+// @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 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 type Origin = string;
+
+// @public
+export interface OutboundEnvironmentEndpoint {
+    category?: string;
+    endpoints?: EndpointDependency[];
+}
+
+// @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 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 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)
+
+```