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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (172) hide show
  1. package/CHANGELOG.md +146 -2
  2. package/dist/index.js +2121 -1216
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.min.js +1 -1
  5. package/dist/index.min.js.map +1 -1
  6. package/dist-esm/samples-dev/cloudHsmClusterBackupStatusGetSample.d.ts +2 -0
  7. package/dist-esm/samples-dev/cloudHsmClusterBackupStatusGetSample.d.ts.map +1 -0
  8. package/dist-esm/samples-dev/cloudHsmClusterBackupStatusGetSample.js +40 -0
  9. package/dist-esm/samples-dev/cloudHsmClusterBackupStatusGetSample.js.map +1 -0
  10. package/dist-esm/samples-dev/cloudHsmClusterPrivateEndpointConnectionsCreateSample.js +4 -4
  11. package/dist-esm/samples-dev/cloudHsmClusterPrivateEndpointConnectionsCreateSample.js.map +1 -1
  12. package/dist-esm/samples-dev/cloudHsmClusterPrivateEndpointConnectionsDeleteSample.js +1 -1
  13. package/dist-esm/samples-dev/cloudHsmClusterPrivateEndpointConnectionsDeleteSample.js.map +1 -1
  14. package/dist-esm/samples-dev/cloudHsmClusterPrivateEndpointConnectionsGetSample.js +1 -1
  15. package/dist-esm/samples-dev/cloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterSample.js +20 -4
  16. package/dist-esm/samples-dev/cloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterSample.js.map +1 -1
  17. package/dist-esm/samples-dev/cloudHsmClusterRestoreStatusGetSample.d.ts +2 -0
  18. package/dist-esm/samples-dev/cloudHsmClusterRestoreStatusGetSample.d.ts.map +1 -0
  19. package/dist-esm/samples-dev/cloudHsmClusterRestoreStatusGetSample.js +40 -0
  20. package/dist-esm/samples-dev/cloudHsmClusterRestoreStatusGetSample.js.map +1 -0
  21. package/dist-esm/samples-dev/cloudHsmClustersBackupSample.d.ts +2 -0
  22. package/dist-esm/samples-dev/cloudHsmClustersBackupSample.d.ts.map +1 -0
  23. package/dist-esm/samples-dev/cloudHsmClustersBackupSample.js +39 -0
  24. package/dist-esm/samples-dev/cloudHsmClustersBackupSample.js.map +1 -0
  25. package/dist-esm/samples-dev/cloudHsmClustersCreateOrUpdateSample.js +6 -6
  26. package/dist-esm/samples-dev/cloudHsmClustersCreateOrUpdateSample.js.map +1 -1
  27. package/dist-esm/samples-dev/cloudHsmClustersDeleteSample.js +1 -1
  28. package/dist-esm/samples-dev/cloudHsmClustersGetSample.js +1 -1
  29. package/dist-esm/samples-dev/cloudHsmClustersListByResourceGroupSample.js +2 -2
  30. package/dist-esm/samples-dev/cloudHsmClustersListByResourceGroupSample.js.map +1 -1
  31. package/dist-esm/samples-dev/cloudHsmClustersListBySubscriptionSample.js +2 -2
  32. package/dist-esm/samples-dev/cloudHsmClustersListBySubscriptionSample.js.map +1 -1
  33. package/dist-esm/samples-dev/cloudHsmClustersRestoreSample.d.ts +2 -0
  34. package/dist-esm/samples-dev/cloudHsmClustersRestoreSample.d.ts.map +1 -0
  35. package/dist-esm/samples-dev/cloudHsmClustersRestoreSample.js +43 -0
  36. package/dist-esm/samples-dev/cloudHsmClustersRestoreSample.js.map +1 -0
  37. package/dist-esm/samples-dev/cloudHsmClustersUpdateSample.js +4 -4
  38. package/dist-esm/samples-dev/cloudHsmClustersUpdateSample.js.map +1 -1
  39. package/dist-esm/samples-dev/cloudHsmClustersValidateBackupPropertiesSample.d.ts +2 -0
  40. package/dist-esm/samples-dev/cloudHsmClustersValidateBackupPropertiesSample.d.ts.map +1 -0
  41. package/dist-esm/samples-dev/cloudHsmClustersValidateBackupPropertiesSample.js +39 -0
  42. package/dist-esm/samples-dev/cloudHsmClustersValidateBackupPropertiesSample.js.map +1 -0
  43. package/dist-esm/samples-dev/cloudHsmClustersValidateRestorePropertiesSample.d.ts +2 -0
  44. package/dist-esm/samples-dev/cloudHsmClustersValidateRestorePropertiesSample.d.ts.map +1 -0
  45. package/dist-esm/samples-dev/cloudHsmClustersValidateRestorePropertiesSample.js +46 -0
  46. package/dist-esm/samples-dev/cloudHsmClustersValidateRestorePropertiesSample.js.map +1 -0
  47. package/dist-esm/samples-dev/dedicatedHsmCreateOrUpdateSample.js +15 -15
  48. package/dist-esm/samples-dev/dedicatedHsmCreateOrUpdateSample.js.map +1 -1
  49. package/dist-esm/samples-dev/dedicatedHsmDeleteSample.js +1 -1
  50. package/dist-esm/samples-dev/dedicatedHsmGetSample.js +3 -3
  51. package/dist-esm/samples-dev/dedicatedHsmListByResourceGroupSample.js +4 -4
  52. package/dist-esm/samples-dev/dedicatedHsmListByResourceGroupSample.js.map +1 -1
  53. package/dist-esm/samples-dev/dedicatedHsmListBySubscriptionSample.js +4 -4
  54. package/dist-esm/samples-dev/dedicatedHsmListBySubscriptionSample.js.map +1 -1
  55. package/dist-esm/samples-dev/dedicatedHsmListOutboundNetworkDependenciesEndpointsSample.js +2 -2
  56. package/dist-esm/samples-dev/dedicatedHsmListOutboundNetworkDependenciesEndpointsSample.js.map +1 -1
  57. package/dist-esm/samples-dev/dedicatedHsmUpdateSample.js +3 -3
  58. package/dist-esm/samples-dev/dedicatedHsmUpdateSample.js.map +1 -1
  59. package/dist-esm/samples-dev/operationsListSample.js +8 -8
  60. package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
  61. package/dist-esm/samples-dev/privateEndpointConnectionsListByCloudHsmClusterSample.js +2 -2
  62. package/dist-esm/samples-dev/privateEndpointConnectionsListByCloudHsmClusterSample.js.map +1 -1
  63. package/dist-esm/src/azureHSMResourceProvider.d.ts +7 -2
  64. package/dist-esm/src/azureHSMResourceProvider.d.ts.map +1 -1
  65. package/dist-esm/src/azureHSMResourceProvider.js +44 -10
  66. package/dist-esm/src/azureHSMResourceProvider.js.map +1 -1
  67. package/dist-esm/src/index.d.ts +0 -1
  68. package/dist-esm/src/index.d.ts.map +1 -1
  69. package/dist-esm/src/lroImpl.js +1 -1
  70. package/dist-esm/src/models/index.d.ts +543 -263
  71. package/dist-esm/src/models/index.d.ts.map +1 -1
  72. package/dist-esm/src/models/index.js +109 -49
  73. package/dist-esm/src/models/index.js.map +1 -1
  74. package/dist-esm/src/models/mappers.d.ts +28 -16
  75. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  76. package/dist-esm/src/models/mappers.js +832 -637
  77. package/dist-esm/src/models/mappers.js.map +1 -1
  78. package/dist-esm/src/models/parameters.d.ts +5 -12
  79. package/dist-esm/src/models/parameters.d.ts.map +1 -1
  80. package/dist-esm/src/models/parameters.js +76 -117
  81. package/dist-esm/src/models/parameters.js.map +1 -1
  82. package/dist-esm/src/operations/cloudHsmClusterBackupStatus.d.ts +22 -0
  83. package/dist-esm/src/operations/cloudHsmClusterBackupStatus.d.ts.map +1 -0
  84. package/dist-esm/src/operations/cloudHsmClusterBackupStatus.js +61 -0
  85. package/dist-esm/src/operations/cloudHsmClusterBackupStatus.js.map +1 -0
  86. package/dist-esm/src/operations/cloudHsmClusterPrivateEndpointConnections.d.ts +7 -7
  87. package/dist-esm/src/operations/cloudHsmClusterPrivateEndpointConnections.d.ts.map +1 -1
  88. package/dist-esm/src/operations/cloudHsmClusterPrivateEndpointConnections.js +37 -29
  89. package/dist-esm/src/operations/cloudHsmClusterPrivateEndpointConnections.js.map +1 -1
  90. package/dist-esm/src/operations/cloudHsmClusterPrivateLinkResources.d.ts +23 -3
  91. package/dist-esm/src/operations/cloudHsmClusterPrivateLinkResources.d.ts.map +1 -1
  92. package/dist-esm/src/operations/cloudHsmClusterPrivateLinkResources.js +105 -6
  93. package/dist-esm/src/operations/cloudHsmClusterPrivateLinkResources.js.map +1 -1
  94. package/dist-esm/src/operations/cloudHsmClusterRestoreStatus.d.ts +22 -0
  95. package/dist-esm/src/operations/cloudHsmClusterRestoreStatus.d.ts.map +1 -0
  96. package/dist-esm/src/operations/cloudHsmClusterRestoreStatus.js +61 -0
  97. package/dist-esm/src/operations/cloudHsmClusterRestoreStatus.js.map +1 -0
  98. package/dist-esm/src/operations/cloudHsmClusters.d.ts +78 -10
  99. package/dist-esm/src/operations/cloudHsmClusters.d.ts.map +1 -1
  100. package/dist-esm/src/operations/cloudHsmClusters.js +467 -82
  101. package/dist-esm/src/operations/cloudHsmClusters.js.map +1 -1
  102. package/dist-esm/src/operations/dedicatedHsmOperations.d.ts +24 -24
  103. package/dist-esm/src/operations/dedicatedHsmOperations.d.ts.map +1 -1
  104. package/dist-esm/src/operations/dedicatedHsmOperations.js +117 -109
  105. package/dist-esm/src/operations/dedicatedHsmOperations.js.map +1 -1
  106. package/dist-esm/src/operations/index.d.ts +3 -1
  107. package/dist-esm/src/operations/index.d.ts.map +1 -1
  108. package/dist-esm/src/operations/index.js +3 -1
  109. package/dist-esm/src/operations/index.js.map +1 -1
  110. package/dist-esm/src/operations/operations.d.ts +4 -4
  111. package/dist-esm/src/operations/operations.d.ts.map +1 -1
  112. package/dist-esm/src/operations/operations.js +8 -8
  113. package/dist-esm/src/operations/operations.js.map +1 -1
  114. package/dist-esm/src/operations/privateEndpointConnections.d.ts +3 -3
  115. package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -1
  116. package/dist-esm/src/operations/privateEndpointConnections.js +14 -14
  117. package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -1
  118. package/dist-esm/src/operationsInterfaces/cloudHsmClusterBackupStatus.d.ts +14 -0
  119. package/dist-esm/src/operationsInterfaces/cloudHsmClusterBackupStatus.d.ts.map +1 -0
  120. package/dist-esm/src/operationsInterfaces/cloudHsmClusterBackupStatus.js +9 -0
  121. package/dist-esm/src/operationsInterfaces/cloudHsmClusterBackupStatus.js.map +1 -0
  122. package/dist-esm/src/operationsInterfaces/cloudHsmClusterPrivateEndpointConnections.d.ts +7 -7
  123. package/dist-esm/src/operationsInterfaces/cloudHsmClusterPrivateEndpointConnections.d.ts.map +1 -1
  124. package/dist-esm/src/operationsInterfaces/cloudHsmClusterPrivateLinkResources.d.ts +4 -3
  125. package/dist-esm/src/operationsInterfaces/cloudHsmClusterPrivateLinkResources.d.ts.map +1 -1
  126. package/dist-esm/src/operationsInterfaces/cloudHsmClusterRestoreStatus.d.ts +14 -0
  127. package/dist-esm/src/operationsInterfaces/cloudHsmClusterRestoreStatus.d.ts.map +1 -0
  128. package/dist-esm/src/operationsInterfaces/cloudHsmClusterRestoreStatus.js +9 -0
  129. package/dist-esm/src/operationsInterfaces/cloudHsmClusterRestoreStatus.js.map +1 -0
  130. package/dist-esm/src/operationsInterfaces/cloudHsmClusters.d.ts +78 -10
  131. package/dist-esm/src/operationsInterfaces/cloudHsmClusters.d.ts.map +1 -1
  132. package/dist-esm/src/operationsInterfaces/dedicatedHsmOperations.d.ts +18 -18
  133. package/dist-esm/src/operationsInterfaces/dedicatedHsmOperations.d.ts.map +1 -1
  134. package/dist-esm/src/operationsInterfaces/index.d.ts +3 -1
  135. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
  136. package/dist-esm/src/operationsInterfaces/index.js +3 -1
  137. package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
  138. package/dist-esm/src/operationsInterfaces/operations.d.ts +3 -3
  139. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -1
  140. package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +1 -1
  141. package/dist-esm/src/pagingHelper.js.map +1 -1
  142. package/dist-esm/test/hardwaresecuritymodules_operations_test.spec.d.ts.map +1 -1
  143. package/dist-esm/test/hardwaresecuritymodules_operations_test.spec.js +6 -2
  144. package/dist-esm/test/hardwaresecuritymodules_operations_test.spec.js.map +1 -1
  145. package/package.json +14 -15
  146. package/review/arm-hardwaresecuritymodules.api.md +298 -93
  147. package/src/azureHSMResourceProvider.ts +67 -20
  148. package/src/lroImpl.ts +4 -4
  149. package/src/models/index.ts +633 -284
  150. package/src/models/mappers.ts +898 -675
  151. package/src/models/parameters.ts +82 -128
  152. package/src/operations/cloudHsmClusterBackupStatus.ts +82 -0
  153. package/src/operations/cloudHsmClusterPrivateEndpointConnections.ts +74 -56
  154. package/src/operations/cloudHsmClusterPrivateLinkResources.ts +145 -13
  155. package/src/operations/cloudHsmClusterRestoreStatus.ts +82 -0
  156. package/src/operations/cloudHsmClusters.ts +684 -151
  157. package/src/operations/dedicatedHsmOperations.ts +224 -215
  158. package/src/operations/index.ts +3 -1
  159. package/src/operations/operations.ts +17 -17
  160. package/src/operations/privateEndpointConnections.ts +30 -30
  161. package/src/operationsInterfaces/cloudHsmClusterBackupStatus.ts +30 -0
  162. package/src/operationsInterfaces/cloudHsmClusterPrivateEndpointConnections.ts +17 -11
  163. package/src/operationsInterfaces/cloudHsmClusterPrivateLinkResources.ts +6 -4
  164. package/src/operationsInterfaces/cloudHsmClusterRestoreStatus.ts +30 -0
  165. package/src/operationsInterfaces/cloudHsmClusters.ts +156 -19
  166. package/src/operationsInterfaces/dedicatedHsmOperations.ts +34 -28
  167. package/src/operationsInterfaces/index.ts +3 -1
  168. package/src/operationsInterfaces/operations.ts +4 -4
  169. package/src/operationsInterfaces/privateEndpointConnections.ts +3 -3
  170. package/src/pagingHelper.ts +1 -1
  171. package/types/arm-hardwaresecuritymodules.d.ts +625 -205
  172. package/types/tsdoc-metadata.json +1 -1
@@ -1,16 +1,9 @@
1
1
  import * as coreClient from "@azure/core-client";
2
- /** Security domain properties information for Cloud HSM cluster */
3
- export interface CloudHsmClusterSecurityDomainProperties {
4
- /** FIPS state information for security domain */
5
- fipsState?: number;
6
- /** status of security domain activation */
7
- activationStatus?: string;
8
- }
9
2
  /** The Cloud HSM Properties */
10
3
  export interface CloudHsmProperties {
11
4
  /** FQDN of the Cloud HSM */
12
5
  fqdn?: string;
13
- /** The Cloud HSM State */
6
+ /** The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating */
14
7
  state?: string;
15
8
  /** The Cloud HSM State message */
16
9
  stateMessage?: string;
@@ -70,37 +63,6 @@ export interface SystemData {
70
63
  /** The timestamp of resource last modification (UTC) */
71
64
  lastModifiedAt?: Date;
72
65
  }
73
- /** Cloud Hsm Cluster restore information */
74
- export interface RestoreProperties {
75
- /** Directory name in Azure Storage Blob where the backup is stored */
76
- foldername?: string;
77
- /** Azure Blob storage container Uri */
78
- azureStorageResourceUri?: string;
79
- }
80
- /** Cloud Hsm Cluster backup information */
81
- export interface BackupProperties {
82
- /** Azure storage Resource Uri */
83
- azureStorageResourceUri?: string;
84
- /**
85
- * Last Date Time that Customer Enabled Backup was taken
86
- * NOTE: This property will not be serialized. It can only be populated by the server.
87
- */
88
- readonly lastBackupDateTime?: Date;
89
- /**
90
- * Status of last backup
91
- * NOTE: This property will not be serialized. It can only be populated by the server.
92
- */
93
- readonly lastBackupStatus?: string;
94
- }
95
- /** Cloud Hsm Cluster SKU information */
96
- export interface CloudHsmClusterSku {
97
- /** Sku family of the Cloud HSM Cluster */
98
- family: CloudHsmClusterSkuFamily;
99
- /** Sku name of the Cloud HSM Cluster */
100
- name: CloudHsmClusterSkuName;
101
- /** Sku capacity */
102
- capacity?: number;
103
- }
104
66
  /** Managed service identity (system assigned and/or user assigned identities) */
105
67
  export interface ManagedServiceIdentity {
106
68
  /**
@@ -133,13 +95,22 @@ export interface UserAssignedIdentity {
133
95
  */
134
96
  readonly clientId?: string;
135
97
  }
136
- /** The Cloud HSM Cluster error details */
137
- export interface CloudHsmClusterError {
138
- /** Error details */
139
- error?: CHsmError;
98
+ /** Cloud Hsm Cluster SKU information */
99
+ export interface CloudHsmClusterSku {
100
+ /** Sku family of the Cloud HSM Cluster */
101
+ family: CloudHsmClusterSkuFamily;
102
+ /** Sku name of the Cloud HSM Cluster */
103
+ name: CloudHsmClusterSkuName;
104
+ /** Sku capacity */
105
+ capacity?: number;
106
+ }
107
+ /** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */
108
+ export interface ErrorResponse {
109
+ /** The error object. */
110
+ error?: ErrorDetail;
140
111
  }
141
- /** Error details */
142
- export interface CHsmError {
112
+ /** The error detail. */
113
+ export interface ErrorDetail {
143
114
  /**
144
115
  * The error code.
145
116
  * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -150,6 +121,34 @@ export interface CHsmError {
150
121
  * NOTE: This property will not be serialized. It can only be populated by the server.
151
122
  */
152
123
  readonly message?: string;
124
+ /**
125
+ * The error target.
126
+ * NOTE: This property will not be serialized. It can only be populated by the server.
127
+ */
128
+ readonly target?: string;
129
+ /**
130
+ * The error details.
131
+ * NOTE: This property will not be serialized. It can only be populated by the server.
132
+ */
133
+ readonly details?: ErrorDetail[];
134
+ /**
135
+ * The error additional info.
136
+ * NOTE: This property will not be serialized. It can only be populated by the server.
137
+ */
138
+ readonly additionalInfo?: ErrorAdditionalInfo[];
139
+ }
140
+ /** The resource management error additional info. */
141
+ export interface ErrorAdditionalInfo {
142
+ /**
143
+ * The additional info type.
144
+ * NOTE: This property will not be serialized. It can only be populated by the server.
145
+ */
146
+ readonly type?: string;
147
+ /**
148
+ * The additional info.
149
+ * NOTE: This property will not be serialized. It can only be populated by the server.
150
+ */
151
+ readonly info?: Record<string, unknown>;
153
152
  }
154
153
  /** Patchable properties of the Cloud HSM Cluster */
155
154
  export interface CloudHsmClusterPatchParameters {
@@ -157,12 +156,8 @@ export interface CloudHsmClusterPatchParameters {
157
156
  tags?: {
158
157
  [propertyName: string]: string;
159
158
  };
160
- /** SKU details */
161
- sku?: CloudHsmClusterSku;
162
159
  /** Managed service identity (system assigned and/or user assigned identities) */
163
160
  identity?: ManagedServiceIdentity;
164
- /** Cloud Hsm Cluster backup information */
165
- backupProperties?: BackupProperties;
166
161
  }
167
162
  /** List of Cloud HSM Clusters */
168
163
  export interface CloudHsmClusterListResult {
@@ -175,6 +170,11 @@ export interface CloudHsmClusterListResult {
175
170
  export interface PrivateLinkResourceListResult {
176
171
  /** Array of private link resources */
177
172
  value?: PrivateLinkResource[];
173
+ /**
174
+ * URL to get the next set of operation list results (if there are any).
175
+ * NOTE: This property will not be serialized. It can only be populated by the server.
176
+ */
177
+ readonly nextLink?: string;
178
178
  }
179
179
  /** List of private endpoint connections associated with the specified resource. */
180
180
  export interface PrivateEndpointConnectionListResult {
@@ -183,76 +183,74 @@ export interface PrivateEndpointConnectionListResult {
183
183
  /** The URL to get the next set of private endpoint connections. */
184
184
  nextLink?: string;
185
185
  }
186
- /** Result of the request to list Dedicated HSM Provider operations. It contains a list of operations. */
187
- export interface DedicatedHsmOperationListResult {
188
- /** List of Dedicated HSM Resource Provider operations. */
189
- value?: DedicatedHsmOperation[];
186
+ /** Backup and Restore Common properties */
187
+ export interface BackupRestoreRequestBaseProperties {
188
+ /** The Azure blob storage container Uri which contains the backup */
189
+ azureStorageBlobContainerUri: string;
190
+ /** The SAS token pointing to an Azure blob storage container. This property is reserved for Azure Backup Service. */
191
+ token?: string;
190
192
  }
191
- /** REST API operation */
192
- export interface DedicatedHsmOperation {
193
- /** The name of the Dedicated HSM Resource Provider Operation. */
194
- name?: string;
193
+ /** Backup operation Result */
194
+ export interface BackupResult {
195
195
  /**
196
- * Gets or sets a value indicating whether it is a data plane action
196
+ * Status of the backup/restore operation
197
197
  * NOTE: This property will not be serialized. It can only be populated by the server.
198
198
  */
199
- readonly isDataAction?: boolean;
200
- /** The origin of the operation */
201
- origin?: string;
202
- /** The display string. */
203
- display?: DedicatedHsmOperationDisplay;
204
- }
205
- /** The display string. */
206
- export interface DedicatedHsmOperationDisplay {
207
- /** The Resource Provider of the operation */
208
- provider?: string;
209
- /** Resource on which the operation is performed. */
210
- resource?: string;
211
- /** Operation type: Read, write, delete, etc. */
212
- operation?: string;
213
- /** The object that represents the operation. */
214
- description?: string;
215
- }
216
- /** The error exception. */
217
- export interface DedicatedHsmError {
199
+ readonly status?: BackupRestoreOperationStatus;
200
+ /** The status details of backup/restore operation */
201
+ statusDetails?: string;
202
+ /** Error encountered, if any, during the backup/restore operation. */
203
+ error?: ErrorDetail;
218
204
  /**
219
- * The error detail of the operation if any.
205
+ * The start time of the backup/restore operation in UTC
220
206
  * NOTE: This property will not be serialized. It can only be populated by the server.
221
207
  */
222
- readonly error?: ErrorModel;
223
- }
224
- /** The key vault server error. */
225
- export interface ErrorModel {
208
+ readonly startTime?: Date;
226
209
  /**
227
- * The error code.
210
+ * The end time of the backup/restore operation in UTC
228
211
  * NOTE: This property will not be serialized. It can only be populated by the server.
229
212
  */
230
- readonly code?: string;
213
+ readonly endTime?: Date;
214
+ /** Identifier for the backup/restore operation. */
215
+ jobId?: string;
216
+ /** The Azure blob storage container Uri which contains the backup */
217
+ azureStorageBlobContainerUri?: string;
218
+ /** The ID of the backup. */
219
+ backupId?: string;
220
+ }
221
+ /** Backup and Restore operation common properties */
222
+ export interface BackupRestoreBaseResultProperties {
231
223
  /**
232
- * The error message.
224
+ * Status of the backup/restore operation
233
225
  * NOTE: This property will not be serialized. It can only be populated by the server.
234
226
  */
235
- readonly message?: string;
227
+ readonly status?: BackupRestoreOperationStatus;
228
+ /** The status details of backup/restore operation */
229
+ statusDetails?: string;
230
+ /** Error encountered, if any, during the backup/restore operation. */
231
+ error?: ErrorDetail;
236
232
  /**
237
- * Contains more specific error that narrows down the cause. May be null.
233
+ * The start time of the backup/restore operation in UTC
238
234
  * NOTE: This property will not be serialized. It can only be populated by the server.
239
235
  */
240
- readonly innerError?: ErrorModel;
236
+ readonly startTime?: Date;
237
+ /**
238
+ * The end time of the backup/restore operation in UTC
239
+ * NOTE: This property will not be serialized. It can only be populated by the server.
240
+ */
241
+ readonly endTime?: Date;
242
+ /** Identifier for the backup/restore operation. */
243
+ jobId?: string;
241
244
  }
242
- /** Metadata pertaining to creation and last modification of dedicated hsm resource. */
243
- export interface SystemDataAutoGenerated {
244
- /** The identity that created dedicated hsm resource. */
245
- createdBy?: string;
246
- /** The type of identity that created dedicated hsm resource. */
247
- createdByType?: IdentityType;
248
- /** The timestamp of dedicated hsm resource creation (UTC). */
249
- createdAt?: Date;
250
- /** The identity that last modified dedicated hsm resource. */
251
- lastModifiedBy?: string;
252
- /** The type of identity that last modified dedicated hsm resource. */
253
- lastModifiedByType?: IdentityType;
254
- /** The timestamp of dedicated hsm resource last modification (UTC). */
255
- lastModifiedAt?: Date;
245
+ /** Restore operation properties */
246
+ export interface RestoreResult {
247
+ /** Backup and Restore operation common properties */
248
+ properties?: BackupRestoreBaseResultProperties;
249
+ }
250
+ /** SKU of the dedicated HSM */
251
+ export interface Sku {
252
+ /** SKU of the dedicated HSM */
253
+ name?: SkuName;
256
254
  }
257
255
  /** The network profile definition. */
258
256
  export interface NetworkProfile {
@@ -263,51 +261,44 @@ export interface NetworkProfile {
263
261
  }
264
262
  /** The API entity reference. */
265
263
  export interface ApiEntityReference {
266
- /** The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */
267
- id?: string;
264
+ /** The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */
265
+ resourceId?: string;
268
266
  }
269
267
  /** The network interface definition. */
270
268
  export interface NetworkInterface {
271
269
  /**
272
- * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
270
+ * The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
273
271
  * NOTE: This property will not be serialized. It can only be populated by the server.
274
272
  */
275
- readonly id?: string;
273
+ readonly resourceId?: string;
276
274
  /** Private Ip address of the interface */
277
275
  privateIpAddress?: string;
278
276
  }
279
- /** Dedicated HSM resource */
280
- export interface DedicatedHsmResource {
277
+ /** The error exception. */
278
+ export interface DedicatedHsmError {
281
279
  /**
282
- * The Azure Resource Manager resource ID for the dedicated HSM.
280
+ * The error detail of the operation if any.
283
281
  * NOTE: This property will not be serialized. It can only be populated by the server.
284
282
  */
285
- readonly id?: string;
283
+ readonly error?: ErrorModel;
284
+ }
285
+ /** The key vault server error. */
286
+ export interface ErrorModel {
286
287
  /**
287
- * The name of the dedicated HSM.
288
+ * The error code.
288
289
  * NOTE: This property will not be serialized. It can only be populated by the server.
289
290
  */
290
- readonly name?: string;
291
+ readonly code?: string;
291
292
  /**
292
- * The resource type of the dedicated HSM.
293
+ * The error message.
293
294
  * NOTE: This property will not be serialized. It can only be populated by the server.
294
295
  */
295
- readonly type?: string;
296
- /** The supported Azure location where the dedicated HSM should be created. */
297
- location: string;
298
- /** SKU details */
299
- sku?: Sku;
300
- /** The Dedicated Hsm zones. */
301
- zones?: string[];
302
- /** Resource tags */
303
- tags?: {
304
- [propertyName: string]: string;
305
- };
306
- }
307
- /** SKU of the dedicated HSM */
308
- export interface Sku {
309
- /** SKU of the dedicated HSM */
310
- name?: SkuName;
296
+ readonly message?: string;
297
+ /**
298
+ * Contains more specific error that narrows down the cause. May be null.
299
+ * NOTE: This property will not be serialized. It can only be populated by the server.
300
+ */
301
+ readonly innerError?: ErrorModel;
311
302
  }
312
303
  /** Patchable properties of the dedicated HSM */
313
304
  export interface DedicatedHsmPatchParameters {
@@ -358,12 +349,66 @@ export interface EndpointDetail {
358
349
  /** Description of the detail */
359
350
  description?: string;
360
351
  }
361
- /** List of dedicated HSM resources. */
362
- export interface ResourceListResult {
363
- /** The list of dedicated HSM resources. */
364
- value?: DedicatedHsmResource[];
365
- /** The URL to get the next set of dedicated HSM resources. */
366
- nextLink?: string;
352
+ /** A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results. */
353
+ export interface OperationListResult {
354
+ /**
355
+ * List of operations supported by the resource provider
356
+ * NOTE: This property will not be serialized. It can only be populated by the server.
357
+ */
358
+ readonly value?: Operation[];
359
+ /**
360
+ * URL to get the next set of operation list results (if there are any).
361
+ * NOTE: This property will not be serialized. It can only be populated by the server.
362
+ */
363
+ readonly nextLink?: string;
364
+ }
365
+ /** Details of a REST API operation, returned from the Resource Provider Operations API */
366
+ export interface Operation {
367
+ /**
368
+ * The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
369
+ * NOTE: This property will not be serialized. It can only be populated by the server.
370
+ */
371
+ readonly name?: string;
372
+ /**
373
+ * Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
374
+ * NOTE: This property will not be serialized. It can only be populated by the server.
375
+ */
376
+ readonly isDataAction?: boolean;
377
+ /** Localized display information for this particular operation. */
378
+ display?: OperationDisplay;
379
+ /**
380
+ * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
381
+ * NOTE: This property will not be serialized. It can only be populated by the server.
382
+ */
383
+ readonly origin?: Origin;
384
+ /**
385
+ * Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
386
+ * NOTE: This property will not be serialized. It can only be populated by the server.
387
+ */
388
+ readonly actionType?: ActionType;
389
+ }
390
+ /** Localized display information for this particular operation. */
391
+ export interface OperationDisplay {
392
+ /**
393
+ * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute".
394
+ * NOTE: This property will not be serialized. It can only be populated by the server.
395
+ */
396
+ readonly provider?: string;
397
+ /**
398
+ * The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections".
399
+ * NOTE: This property will not be serialized. It can only be populated by the server.
400
+ */
401
+ readonly resource?: string;
402
+ /**
403
+ * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".
404
+ * NOTE: This property will not be serialized. It can only be populated by the server.
405
+ */
406
+ readonly operation?: string;
407
+ /**
408
+ * The short, localized friendly description of the operation; suitable for tool tips and detailed views.
409
+ * NOTE: This property will not be serialized. It can only be populated by the server.
410
+ */
411
+ readonly description?: string;
367
412
  }
368
413
  /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
369
414
  export interface ProxyResource extends Resource {
@@ -392,29 +437,20 @@ export interface PrivateLinkResource extends Resource {
392
437
  /** The private link resource private link DNS zone name. */
393
438
  requiredZoneNames?: string[];
394
439
  }
395
- /** Resource information with extended details. */
396
- export interface DedicatedHsm extends DedicatedHsmResource {
397
- /**
398
- * Metadata pertaining to creation and last modification of the resource
399
- * NOTE: This property will not be serialized. It can only be populated by the server.
400
- */
401
- readonly systemData?: SystemDataAutoGenerated;
402
- /** Specifies the network interfaces of the dedicated hsm. */
403
- networkProfile?: NetworkProfile;
404
- /** Specifies the management network interfaces of the dedicated hsm. */
405
- managementNetworkProfile?: NetworkProfile;
406
- /** This field will be used when RP does not support Availability zones. */
407
- stampId?: string;
408
- /**
409
- * Resource Status Message.
410
- * NOTE: This property will not be serialized. It can only be populated by the server.
411
- */
412
- readonly statusMessage?: string;
413
- /**
414
- * Provisioning state.
415
- * NOTE: This property will not be serialized. It can only be populated by the server.
416
- */
417
- readonly provisioningState?: JsonWebKeyType;
440
+ /** Backup properties */
441
+ export interface BackupRequestProperties extends BackupRestoreRequestBaseProperties {
442
+ }
443
+ /** Cloud Hsm Cluster restore information */
444
+ export interface RestoreRequestProperties extends BackupRestoreRequestBaseProperties {
445
+ /** An autogenerated unique string ID for labeling the backup. It contains both a UUID and a date timestamp. */
446
+ backupId: string;
447
+ }
448
+ /** Properties of the Cloud HSM Cluster */
449
+ export interface BackupResultProperties extends BackupRestoreBaseResultProperties {
450
+ /** The Azure blob storage container Uri which contains the backup */
451
+ azureStorageBlobContainerUri?: string;
452
+ /** The ID of the backup. */
453
+ backupId?: string;
418
454
  }
419
455
  /** The private endpoint connection resource. */
420
456
  export interface PrivateEndpointConnection extends ProxyResource {
@@ -437,34 +473,65 @@ export interface PrivateEndpointConnection extends ProxyResource {
437
473
  }
438
474
  /** Cloud HSM Cluster Resource */
439
475
  export interface CloudHsmClusterResource extends TrackedResource {
440
- /** SKU details */
441
- sku?: CloudHsmClusterSku;
442
476
  /** Managed service identity (system assigned and/or user assigned identities) */
443
477
  identity?: ManagedServiceIdentity;
478
+ /** SKU details */
479
+ sku?: CloudHsmClusterSku;
480
+ }
481
+ /** Resource information with extended details. */
482
+ export interface DedicatedHsm extends TrackedResource {
483
+ /** SKU details */
484
+ sku: Sku;
485
+ /** The Dedicated Hsm zones. */
486
+ zones?: string[];
487
+ /** Specifies the network interfaces of the dedicated hsm. */
488
+ networkProfile?: NetworkProfile;
489
+ /** Specifies the management network interfaces of the dedicated hsm. */
490
+ managementNetworkProfile?: NetworkProfile;
491
+ /** This field will be used when RP does not support Availability zones. */
492
+ stampId?: string;
493
+ /**
494
+ * Resource Status Message.
495
+ * NOTE: This property will not be serialized. It can only be populated by the server.
496
+ */
497
+ readonly statusMessage?: string;
498
+ /**
499
+ * Provisioning state.
500
+ * NOTE: This property will not be serialized. It can only be populated by the server.
501
+ */
502
+ readonly provisioningState?: JsonWebKeyType;
444
503
  }
445
504
  /** Resource information with extended details. */
446
505
  export interface CloudHsmCluster extends CloudHsmClusterResource {
447
- /** The Cloud HSM Cluster's provisioningState */
448
- provisioningState?: ProvisioningState;
506
+ /**
507
+ * State of security domain activation
508
+ * NOTE: This property will not be serialized. It can only be populated by the server.
509
+ */
510
+ readonly activationState?: ActivationState;
449
511
  /** The Cloud HSM Cluster's auto-generated Domain Name Label Scope */
450
- autoGeneratedDomainNameLabelScope?: string;
451
- /** Security domain properties information for Cloud HSM cluster */
452
- securityDomain?: CloudHsmClusterSecurityDomainProperties;
453
- /** An array of Cloud HSM Cluster's HSMs */
454
- hsms?: CloudHsmProperties[];
512
+ autoGeneratedDomainNameLabelScope?: AutoGeneratedDomainNameLabelScope;
513
+ /**
514
+ * An array of Cloud HSM Cluster's HSMs
515
+ * NOTE: This property will not be serialized. It can only be populated by the server.
516
+ */
517
+ readonly hsms?: CloudHsmProperties[];
518
+ /**
519
+ * List of private endpoint connection resources
520
+ * NOTE: This property will not be serialized. It can only be populated by the server.
521
+ */
522
+ readonly privateEndpointConnections?: PrivateEndpointConnection[];
523
+ /**
524
+ * The Cloud HSM Cluster's provisioningState
525
+ * NOTE: This property will not be serialized. It can only be populated by the server.
526
+ */
527
+ readonly provisioningState?: ProvisioningState;
455
528
  /** The Cloud HSM Cluster public network access */
456
- publicNetworkAccess?: string;
457
- /** List of private endpoint connection resources */
458
- privateEndpointConnections?: PrivateEndpointConnection[];
529
+ publicNetworkAccess?: PublicNetworkAccess;
459
530
  /**
460
531
  * Cloud HSM Cluster status message
461
532
  * NOTE: This property will not be serialized. It can only be populated by the server.
462
533
  */
463
534
  readonly statusMessage?: string;
464
- /** Cloud Hsm Cluster restore information */
465
- restoreProperties?: RestoreProperties;
466
- /** Cloud Hsm Cluster backup information */
467
- backupProperties?: BackupProperties;
468
535
  }
469
536
  /** Defines headers for CloudHsmClusters_update operation. */
470
537
  export interface CloudHsmClustersUpdateHeaders {
@@ -476,36 +543,108 @@ export interface CloudHsmClustersDeleteHeaders {
476
543
  /** The URI to poll for completion status. */
477
544
  location?: string;
478
545
  }
546
+ /** Defines headers for CloudHsmClusters_validateBackupProperties operation. */
547
+ export interface CloudHsmClustersValidateBackupPropertiesHeaders {
548
+ /** A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. */
549
+ xMsRequestId?: string;
550
+ }
551
+ /** Defines headers for CloudHsmClusters_backup operation. */
552
+ export interface CloudHsmClustersBackupHeaders {
553
+ /** A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. */
554
+ xMsRequestId?: string;
555
+ }
556
+ /** Defines headers for CloudHsmClusters_validateRestoreProperties operation. */
557
+ export interface CloudHsmClustersValidateRestorePropertiesHeaders {
558
+ /** A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. */
559
+ xMsRequestId?: string;
560
+ }
561
+ /** Defines headers for CloudHsmClusters_restore operation. */
562
+ export interface CloudHsmClustersRestoreHeaders {
563
+ /** A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. */
564
+ xMsRequestId?: string;
565
+ }
479
566
  /** Defines headers for CloudHsmClusterPrivateEndpointConnections_delete operation. */
480
567
  export interface CloudHsmClusterPrivateEndpointConnectionsDeleteHeaders {
481
568
  /** The URI to poll for completion status. */
482
569
  location?: string;
483
570
  }
484
- /** Known values of {@link ProvisioningState} that the service accepts. */
485
- export declare enum KnownProvisioningState {
486
- /** Provisioning */
487
- Provisioning = "Provisioning",
488
- /** Succeeded */
489
- Succeeded = "Succeeded",
571
+ /** Defines headers for CloudHsmClusterBackupStatus_get operation. */
572
+ export interface CloudHsmClusterBackupStatusGetHeaders {
573
+ /** A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. */
574
+ xMsRequestId?: string;
575
+ }
576
+ /** Defines headers for CloudHsmClusterBackupStatus_get operation. */
577
+ export interface CloudHsmClusterBackupStatusGetExceptionHeaders {
578
+ /** A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. */
579
+ xMsRequestId?: string;
580
+ }
581
+ /** Defines headers for CloudHsmClusterRestoreStatus_get operation. */
582
+ export interface CloudHsmClusterRestoreStatusGetHeaders {
583
+ /** A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. */
584
+ xMsRequestId?: string;
585
+ }
586
+ /** Defines headers for CloudHsmClusterRestoreStatus_get operation. */
587
+ export interface CloudHsmClusterRestoreStatusGetExceptionHeaders {
588
+ /** A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging. */
589
+ xMsRequestId?: string;
590
+ }
591
+ /** Defines headers for DedicatedHsm_update operation. */
592
+ export interface DedicatedHsmUpdateHeaders {
593
+ /** The URI to poll for completion status. */
594
+ location?: string;
595
+ }
596
+ /** Defines headers for DedicatedHsm_delete operation. */
597
+ export interface DedicatedHsmDeleteHeaders {
598
+ /** The URI to poll for completion status. */
599
+ location?: string;
600
+ }
601
+ /** Known values of {@link ActivationState} that the service accepts. */
602
+ export declare enum KnownActivationState {
603
+ /** NotDefined */
604
+ NotDefined = "NotDefined",
605
+ /** NotActivated */
606
+ NotActivated = "NotActivated",
607
+ /** Active */
608
+ Active = "Active",
490
609
  /** Failed */
491
610
  Failed = "Failed",
492
- /** Deleting */
493
- Deleting = "Deleting",
494
- /** Canceled */
495
- Canceled = "Canceled"
611
+ /** Unknown */
612
+ Unknown = "Unknown"
496
613
  }
497
614
  /**
498
- * Defines values for ProvisioningState. \
499
- * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
615
+ * Defines values for ActivationState. \
616
+ * {@link KnownActivationState} can be used interchangeably with ActivationState,
500
617
  * this enum contains the known values that the service supports.
501
618
  * ### Known values supported by the service
502
- * **Provisioning** \
503
- * **Succeeded** \
619
+ * **NotDefined** \
620
+ * **NotActivated** \
621
+ * **Active** \
504
622
  * **Failed** \
505
- * **Deleting** \
506
- * **Canceled**
623
+ * **Unknown**
507
624
  */
508
- export type ProvisioningState = string;
625
+ export type ActivationState = string;
626
+ /** Known values of {@link AutoGeneratedDomainNameLabelScope} that the service accepts. */
627
+ export declare enum KnownAutoGeneratedDomainNameLabelScope {
628
+ /** TenantReuse */
629
+ TenantReuse = "TenantReuse",
630
+ /** SubscriptionReuse */
631
+ SubscriptionReuse = "SubscriptionReuse",
632
+ /** ResourceGroupReuse */
633
+ ResourceGroupReuse = "ResourceGroupReuse",
634
+ /** NoReuse */
635
+ NoReuse = "NoReuse"
636
+ }
637
+ /**
638
+ * Defines values for AutoGeneratedDomainNameLabelScope. \
639
+ * {@link KnownAutoGeneratedDomainNameLabelScope} can be used interchangeably with AutoGeneratedDomainNameLabelScope,
640
+ * this enum contains the known values that the service supports.
641
+ * ### Known values supported by the service
642
+ * **TenantReuse** \
643
+ * **SubscriptionReuse** \
644
+ * **ResourceGroupReuse** \
645
+ * **NoReuse**
646
+ */
647
+ export type AutoGeneratedDomainNameLabelScope = string;
509
648
  /** Known values of {@link PrivateEndpointServiceConnectionStatus} that the service accepts. */
510
649
  export declare enum KnownPrivateEndpointServiceConnectionStatus {
511
650
  /** Pending */
@@ -578,19 +717,44 @@ export declare enum KnownCreatedByType {
578
717
  * **Key**
579
718
  */
580
719
  export type CreatedByType = string;
581
- /** Known values of {@link CloudHsmClusterSkuFamily} that the service accepts. */
582
- export declare enum KnownCloudHsmClusterSkuFamily {
583
- /** B */
584
- B = "B"
720
+ /** Known values of {@link ProvisioningState} that the service accepts. */
721
+ export declare enum KnownProvisioningState {
722
+ /** Provisioning */
723
+ Provisioning = "Provisioning",
724
+ /** Succeeded */
725
+ Succeeded = "Succeeded",
726
+ /** Failed */
727
+ Failed = "Failed",
728
+ /** Deleting */
729
+ Deleting = "Deleting",
730
+ /** Canceled */
731
+ Canceled = "Canceled"
585
732
  }
586
733
  /**
587
- * Defines values for CloudHsmClusterSkuFamily. \
588
- * {@link KnownCloudHsmClusterSkuFamily} can be used interchangeably with CloudHsmClusterSkuFamily,
734
+ * Defines values for ProvisioningState. \
735
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
589
736
  * this enum contains the known values that the service supports.
590
737
  * ### Known values supported by the service
591
- * **B**
738
+ * **Provisioning** \
739
+ * **Succeeded** \
740
+ * **Failed** \
741
+ * **Deleting** \
742
+ * **Canceled**
592
743
  */
593
- export type CloudHsmClusterSkuFamily = string;
744
+ export type ProvisioningState = string;
745
+ /** Known values of {@link PublicNetworkAccess} that the service accepts. */
746
+ export declare enum KnownPublicNetworkAccess {
747
+ /** Disabled */
748
+ Disabled = "Disabled"
749
+ }
750
+ /**
751
+ * Defines values for PublicNetworkAccess. \
752
+ * {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
753
+ * this enum contains the known values that the service supports.
754
+ * ### Known values supported by the service
755
+ * **Disabled**
756
+ */
757
+ export type PublicNetworkAccess = string;
594
758
  /** Known values of {@link ManagedServiceIdentityType} that the service accepts. */
595
759
  export declare enum KnownManagedServiceIdentityType {
596
760
  /** None */
@@ -613,59 +777,41 @@ export declare enum KnownManagedServiceIdentityType {
613
777
  * **SystemAssigned,UserAssigned**
614
778
  */
615
779
  export type ManagedServiceIdentityType = string;
616
- /** Known values of {@link IdentityType} that the service accepts. */
617
- export declare enum KnownIdentityType {
618
- /** User */
619
- User = "User",
620
- /** Application */
621
- Application = "Application",
622
- /** ManagedIdentity */
623
- ManagedIdentity = "ManagedIdentity",
624
- /** Key */
625
- Key = "Key"
780
+ /** Known values of {@link CloudHsmClusterSkuFamily} that the service accepts. */
781
+ export declare enum KnownCloudHsmClusterSkuFamily {
782
+ /** B */
783
+ B = "B"
626
784
  }
627
785
  /**
628
- * Defines values for IdentityType. \
629
- * {@link KnownIdentityType} can be used interchangeably with IdentityType,
786
+ * Defines values for CloudHsmClusterSkuFamily. \
787
+ * {@link KnownCloudHsmClusterSkuFamily} can be used interchangeably with CloudHsmClusterSkuFamily,
630
788
  * this enum contains the known values that the service supports.
631
789
  * ### Known values supported by the service
632
- * **User** \
633
- * **Application** \
634
- * **ManagedIdentity** \
635
- * **Key**
790
+ * **B**
636
791
  */
637
- export type IdentityType = string;
638
- /** Known values of {@link JsonWebKeyType} that the service accepts. */
639
- export declare enum KnownJsonWebKeyType {
640
- /** The dedicated HSM has been full provisioned. */
792
+ export type CloudHsmClusterSkuFamily = string;
793
+ /** Known values of {@link BackupRestoreOperationStatus} that the service accepts. */
794
+ export declare enum KnownBackupRestoreOperationStatus {
795
+ /** InProgress */
796
+ InProgress = "InProgress",
797
+ /** Succeeded */
641
798
  Succeeded = "Succeeded",
642
- /** The dedicated HSM is currently being provisioned. */
643
- Provisioning = "Provisioning",
644
- /** A device is currently being allocated for the dedicated HSM resource. */
645
- Allocating = "Allocating",
646
- /** The dedicated HSM is being connected to the virtual network. */
647
- Connecting = "Connecting",
648
- /** Provisioning of the dedicated HSM has failed. */
799
+ /** Failed */
649
800
  Failed = "Failed",
650
- /** Validating the subscription has sufficient quota to allocate a dedicated HSM device. */
651
- CheckingQuota = "CheckingQuota",
652
- /** The dedicated HSM is currently being deleted. */
653
- Deleting = "Deleting"
801
+ /** Cancelled */
802
+ Cancelled = "Cancelled"
654
803
  }
655
804
  /**
656
- * Defines values for JsonWebKeyType. \
657
- * {@link KnownJsonWebKeyType} can be used interchangeably with JsonWebKeyType,
805
+ * Defines values for BackupRestoreOperationStatus. \
806
+ * {@link KnownBackupRestoreOperationStatus} can be used interchangeably with BackupRestoreOperationStatus,
658
807
  * this enum contains the known values that the service supports.
659
808
  * ### Known values supported by the service
660
- * **Succeeded**: The dedicated HSM has been full provisioned. \
661
- * **Provisioning**: The dedicated HSM is currently being provisioned. \
662
- * **Allocating**: A device is currently being allocated for the dedicated HSM resource. \
663
- * **Connecting**: The dedicated HSM is being connected to the virtual network. \
664
- * **Failed**: Provisioning of the dedicated HSM has failed. \
665
- * **CheckingQuota**: Validating the subscription has sufficient quota to allocate a dedicated HSM device. \
666
- * **Deleting**: The dedicated HSM is currently being deleted.
809
+ * **InProgress** \
810
+ * **Succeeded** \
811
+ * **Failed** \
812
+ * **Cancelled**
667
813
  */
668
- export type JsonWebKeyType = string;
814
+ export type BackupRestoreOperationStatus = string;
669
815
  /** Known values of {@link SkuName} that the service accepts. */
670
816
  export declare enum KnownSkuName {
671
817
  /** The dedicated HSM is a Safenet Luna Network HSM A790 device. */
@@ -697,6 +843,91 @@ export declare enum KnownSkuName {
697
843
  * **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.
698
844
  */
699
845
  export type SkuName = string;
846
+ /** Known values of {@link JsonWebKeyType} that the service accepts. */
847
+ export declare enum KnownJsonWebKeyType {
848
+ /** The dedicated HSM has been fully provisioned. */
849
+ Succeeded = "Succeeded",
850
+ /** The dedicated HSM is currently being provisioned. */
851
+ Provisioning = "Provisioning",
852
+ /** A device is currently being allocated for the dedicated HSM resource. */
853
+ Allocating = "Allocating",
854
+ /** The dedicated HSM is being connected to the virtual network. */
855
+ Connecting = "Connecting",
856
+ /** Provisioning of the dedicated HSM has failed. */
857
+ Failed = "Failed",
858
+ /** Validating the subscription has sufficient quota to allocate a dedicated HSM device. */
859
+ CheckingQuota = "CheckingQuota",
860
+ /** The dedicated HSM is currently being deleted. */
861
+ Deleting = "Deleting"
862
+ }
863
+ /**
864
+ * Defines values for JsonWebKeyType. \
865
+ * {@link KnownJsonWebKeyType} can be used interchangeably with JsonWebKeyType,
866
+ * this enum contains the known values that the service supports.
867
+ * ### Known values supported by the service
868
+ * **Succeeded**: The dedicated HSM has been fully provisioned. \
869
+ * **Provisioning**: The dedicated HSM is currently being provisioned. \
870
+ * **Allocating**: A device is currently being allocated for the dedicated HSM resource. \
871
+ * **Connecting**: The dedicated HSM is being connected to the virtual network. \
872
+ * **Failed**: Provisioning of the dedicated HSM has failed. \
873
+ * **CheckingQuota**: Validating the subscription has sufficient quota to allocate a dedicated HSM device. \
874
+ * **Deleting**: The dedicated HSM is currently being deleted.
875
+ */
876
+ export type JsonWebKeyType = string;
877
+ /** Known values of {@link Origin} that the service accepts. */
878
+ export declare enum KnownOrigin {
879
+ /** User */
880
+ User = "user",
881
+ /** System */
882
+ System = "system",
883
+ /** UserSystem */
884
+ UserSystem = "user,system"
885
+ }
886
+ /**
887
+ * Defines values for Origin. \
888
+ * {@link KnownOrigin} can be used interchangeably with Origin,
889
+ * this enum contains the known values that the service supports.
890
+ * ### Known values supported by the service
891
+ * **user** \
892
+ * **system** \
893
+ * **user,system**
894
+ */
895
+ export type Origin = string;
896
+ /** Known values of {@link ActionType} that the service accepts. */
897
+ export declare enum KnownActionType {
898
+ /** Internal */
899
+ Internal = "Internal"
900
+ }
901
+ /**
902
+ * Defines values for ActionType. \
903
+ * {@link KnownActionType} can be used interchangeably with ActionType,
904
+ * this enum contains the known values that the service supports.
905
+ * ### Known values supported by the service
906
+ * **Internal**
907
+ */
908
+ export type ActionType = string;
909
+ /** Known values of {@link IdentityType} that the service accepts. */
910
+ export declare enum KnownIdentityType {
911
+ /** User */
912
+ User = "User",
913
+ /** Application */
914
+ Application = "Application",
915
+ /** ManagedIdentity */
916
+ ManagedIdentity = "ManagedIdentity",
917
+ /** Key */
918
+ Key = "Key"
919
+ }
920
+ /**
921
+ * Defines values for IdentityType. \
922
+ * {@link KnownIdentityType} can be used interchangeably with IdentityType,
923
+ * this enum contains the known values that the service supports.
924
+ * ### Known values supported by the service
925
+ * **User** \
926
+ * **Application** \
927
+ * **ManagedIdentity** \
928
+ * **Key**
929
+ */
930
+ export type IdentityType = string;
700
931
  /** Defines values for CloudHsmClusterSkuName. */
701
932
  export type CloudHsmClusterSkuName = "Standard_B1" | "Standard B10";
702
933
  /** Optional parameters. */
@@ -705,26 +936,14 @@ export interface CloudHsmClustersCreateOrUpdateOptionalParams extends coreClient
705
936
  tags?: {
706
937
  [propertyName: string]: string;
707
938
  };
708
- /** SKU details */
709
- sku?: CloudHsmClusterSku;
710
939
  /** Managed service identity (system assigned and/or user assigned identities) */
711
940
  identity?: ManagedServiceIdentity;
712
- /** The Cloud HSM Cluster's provisioningState */
713
- provisioningState?: ProvisioningState;
941
+ /** SKU details */
942
+ sku?: CloudHsmClusterSku;
714
943
  /** The Cloud HSM Cluster's auto-generated Domain Name Label Scope */
715
- autoGeneratedDomainNameLabelScope?: string;
716
- /** Security domain properties information for Cloud HSM cluster */
717
- securityDomain?: CloudHsmClusterSecurityDomainProperties;
718
- /** An array of Cloud HSM Cluster's HSMs */
719
- hsms?: CloudHsmProperties[];
944
+ autoGeneratedDomainNameLabelScope?: AutoGeneratedDomainNameLabelScope;
720
945
  /** The Cloud HSM Cluster public network access */
721
- publicNetworkAccess?: string;
722
- /** List of private endpoint connection resources */
723
- privateEndpointConnections?: PrivateEndpointConnection[];
724
- /** Cloud Hsm Cluster restore information */
725
- restoreProperties?: RestoreProperties;
726
- /** Cloud Hsm Cluster backup information */
727
- backupProperties?: BackupProperties;
946
+ publicNetworkAccess?: PublicNetworkAccess;
728
947
  /** Delay to wait until next poll, in milliseconds. */
729
948
  updateIntervalInMs?: number;
730
949
  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
@@ -738,12 +957,8 @@ export interface CloudHsmClustersUpdateOptionalParams extends coreClient.Operati
738
957
  tags?: {
739
958
  [propertyName: string]: string;
740
959
  };
741
- /** SKU details */
742
- sku?: CloudHsmClusterSku;
743
960
  /** Managed service identity (system assigned and/or user assigned identities) */
744
961
  identity?: ManagedServiceIdentity;
745
- /** Cloud Hsm Cluster backup information */
746
- backupProperties?: BackupProperties;
747
962
  /** Delay to wait until next poll, in milliseconds. */
748
963
  updateIntervalInMs?: number;
749
964
  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
@@ -763,6 +978,8 @@ export interface CloudHsmClustersDeleteOptionalParams extends coreClient.Operati
763
978
  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
764
979
  resumeFrom?: string;
765
980
  }
981
+ /** Contains response data for the delete operation. */
982
+ export type CloudHsmClustersDeleteResponse = CloudHsmClustersDeleteHeaders;
766
983
  /** Optional parameters. */
767
984
  export interface CloudHsmClustersListByResourceGroupOptionalParams extends coreClient.OperationOptions {
768
985
  /** The page-continuation token to use with a paged version of this API */
@@ -778,6 +995,48 @@ export interface CloudHsmClustersListBySubscriptionOptionalParams extends coreCl
778
995
  /** Contains response data for the listBySubscription operation. */
779
996
  export type CloudHsmClustersListBySubscriptionResponse = CloudHsmClusterListResult;
780
997
  /** Optional parameters. */
998
+ export interface CloudHsmClustersValidateBackupPropertiesOptionalParams extends coreClient.OperationOptions {
999
+ /** Backup Operation Required properties */
1000
+ backupRequestProperties?: BackupRequestProperties;
1001
+ /** Delay to wait until next poll, in milliseconds. */
1002
+ updateIntervalInMs?: number;
1003
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1004
+ resumeFrom?: string;
1005
+ }
1006
+ /** Contains response data for the validateBackupProperties operation. */
1007
+ export type CloudHsmClustersValidateBackupPropertiesResponse = CloudHsmClustersValidateBackupPropertiesHeaders & BackupResult;
1008
+ /** Optional parameters. */
1009
+ export interface CloudHsmClustersBackupOptionalParams extends coreClient.OperationOptions {
1010
+ /** Azure storage Resource Uri */
1011
+ backupRequestProperties?: BackupRequestProperties;
1012
+ /** Delay to wait until next poll, in milliseconds. */
1013
+ updateIntervalInMs?: number;
1014
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1015
+ resumeFrom?: string;
1016
+ }
1017
+ /** Contains response data for the backup operation. */
1018
+ export type CloudHsmClustersBackupResponse = CloudHsmClustersBackupHeaders & BackupResult;
1019
+ /** Optional parameters. */
1020
+ export interface CloudHsmClustersValidateRestorePropertiesOptionalParams extends coreClient.OperationOptions {
1021
+ /** Optional Parameters to validate prior performing a restore operation. */
1022
+ restoreRequestProperties?: RestoreRequestProperties;
1023
+ /** Delay to wait until next poll, in milliseconds. */
1024
+ updateIntervalInMs?: number;
1025
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1026
+ resumeFrom?: string;
1027
+ }
1028
+ /** Contains response data for the validateRestoreProperties operation. */
1029
+ export type CloudHsmClustersValidateRestorePropertiesResponse = CloudHsmClustersValidateRestorePropertiesHeaders & RestoreResult;
1030
+ /** Optional parameters. */
1031
+ export interface CloudHsmClustersRestoreOptionalParams extends coreClient.OperationOptions {
1032
+ /** Delay to wait until next poll, in milliseconds. */
1033
+ updateIntervalInMs?: number;
1034
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1035
+ resumeFrom?: string;
1036
+ }
1037
+ /** Contains response data for the restore operation. */
1038
+ export type CloudHsmClustersRestoreResponse = CloudHsmClustersRestoreHeaders & RestoreResult;
1039
+ /** Optional parameters. */
781
1040
  export interface CloudHsmClustersListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
782
1041
  }
783
1042
  /** Contains response data for the listByResourceGroupNext operation. */
@@ -793,6 +1052,11 @@ export interface CloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterOptiona
793
1052
  /** Contains response data for the listByCloudHsmCluster operation. */
794
1053
  export type CloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterResponse = PrivateLinkResourceListResult;
795
1054
  /** Optional parameters. */
1055
+ export interface CloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterNextOptionalParams extends coreClient.OperationOptions {
1056
+ }
1057
+ /** Contains response data for the listByCloudHsmClusterNext operation. */
1058
+ export type CloudHsmClusterPrivateLinkResourcesListByCloudHsmClusterNextResponse = PrivateLinkResourceListResult;
1059
+ /** Optional parameters. */
796
1060
  export interface CloudHsmClusterPrivateEndpointConnectionsCreateOptionalParams extends coreClient.OperationOptions {
797
1061
  }
798
1062
  /** Contains response data for the create operation. */
@@ -804,6 +1068,8 @@ export interface CloudHsmClusterPrivateEndpointConnectionsDeleteOptionalParams e
804
1068
  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
805
1069
  resumeFrom?: string;
806
1070
  }
1071
+ /** Contains response data for the delete operation. */
1072
+ export type CloudHsmClusterPrivateEndpointConnectionsDeleteResponse = CloudHsmClusterPrivateEndpointConnectionsDeleteHeaders;
807
1073
  /** Optional parameters. */
808
1074
  export interface CloudHsmClusterPrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
809
1075
  }
@@ -820,10 +1086,15 @@ export interface PrivateEndpointConnectionsListByCloudHsmClusterNextOptionalPara
820
1086
  /** Contains response data for the listByCloudHsmClusterNext operation. */
821
1087
  export type PrivateEndpointConnectionsListByCloudHsmClusterNextResponse = PrivateEndpointConnectionListResult;
822
1088
  /** Optional parameters. */
823
- export interface OperationsListOptionalParams extends coreClient.OperationOptions {
1089
+ export interface CloudHsmClusterBackupStatusGetOptionalParams extends coreClient.OperationOptions {
824
1090
  }
825
- /** Contains response data for the list operation. */
826
- export type OperationsListResponse = DedicatedHsmOperationListResult;
1091
+ /** Contains response data for the get operation. */
1092
+ export type CloudHsmClusterBackupStatusGetResponse = CloudHsmClusterBackupStatusGetHeaders & BackupResult;
1093
+ /** Optional parameters. */
1094
+ export interface CloudHsmClusterRestoreStatusGetOptionalParams extends coreClient.OperationOptions {
1095
+ }
1096
+ /** Contains response data for the get operation. */
1097
+ export type CloudHsmClusterRestoreStatusGetResponse = CloudHsmClusterRestoreStatusGetHeaders & RestoreResult;
827
1098
  /** Optional parameters. */
828
1099
  export interface DedicatedHsmCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
829
1100
  /** Delay to wait until next poll, in milliseconds. */
@@ -853,6 +1124,8 @@ export interface DedicatedHsmDeleteOptionalParams extends coreClient.OperationOp
853
1124
  /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
854
1125
  resumeFrom?: string;
855
1126
  }
1127
+ /** Contains response data for the delete operation. */
1128
+ export type DedicatedHsmDeleteResponse = DedicatedHsmDeleteHeaders;
856
1129
  /** Optional parameters. */
857
1130
  export interface DedicatedHsmGetOptionalParams extends coreClient.OperationOptions {
858
1131
  }
@@ -893,9 +1166,16 @@ export interface DedicatedHsmListOutboundNetworkDependenciesEndpointsNextOptiona
893
1166
  /** Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation. */
894
1167
  export type DedicatedHsmListOutboundNetworkDependenciesEndpointsNextResponse = OutboundEnvironmentEndpointCollection;
895
1168
  /** Optional parameters. */
1169
+ export interface OperationsListOptionalParams extends coreClient.OperationOptions {
1170
+ }
1171
+ /** Contains response data for the list operation. */
1172
+ export type OperationsListResponse = OperationListResult;
1173
+ /** Optional parameters. */
896
1174
  export interface AzureHSMResourceProviderOptionalParams extends coreClient.ServiceClientOptions {
897
1175
  /** server parameter */
898
1176
  $host?: string;
1177
+ /** Api Version */
1178
+ apiVersion?: string;
899
1179
  /** Overrides client endpoint. */
900
1180
  endpoint?: string;
901
1181
  }