@azure/arm-keyvault 2.1.0-beta.1 → 3.0.0-alpha.20230424.3
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.
- package/CHANGELOG.md +73 -3
- package/LICENSE +1 -1
- package/README.md +2 -2
- package/dist/index.js +3461 -1761
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/index.min.js.map +1 -1
- package/dist-esm/samples-dev/keysCreateIfNotExistSample.js +12 -4
- package/dist-esm/samples-dev/keysCreateIfNotExistSample.js.map +1 -1
- package/dist-esm/samples-dev/keysGetSample.js +12 -4
- package/dist-esm/samples-dev/keysGetSample.js.map +1 -1
- package/dist-esm/samples-dev/keysGetVersionSample.js +12 -4
- package/dist-esm/samples-dev/keysGetVersionSample.js.map +1 -1
- package/dist-esm/samples-dev/keysListSample.js +24 -9
- package/dist-esm/samples-dev/keysListSample.js.map +1 -1
- package/dist-esm/samples-dev/keysListVersionsSample.js +24 -9
- package/dist-esm/samples-dev/keysListVersionsSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmKeysCreateIfNotExistSample.d.ts +2 -0
- package/dist-esm/samples-dev/managedHsmKeysCreateIfNotExistSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysCreateIfNotExistSample.js +43 -0
- package/dist-esm/samples-dev/managedHsmKeysCreateIfNotExistSample.js.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysGetSample.d.ts +2 -0
- package/dist-esm/samples-dev/managedHsmKeysGetSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysGetSample.js +40 -0
- package/dist-esm/samples-dev/managedHsmKeysGetSample.js.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysGetVersionSample.d.ts +2 -0
- package/dist-esm/samples-dev/managedHsmKeysGetVersionSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysGetVersionSample.js +41 -0
- package/dist-esm/samples-dev/managedHsmKeysGetVersionSample.js.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysListSample.d.ts +2 -0
- package/dist-esm/samples-dev/managedHsmKeysListSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysListSample.js +60 -0
- package/dist-esm/samples-dev/managedHsmKeysListSample.js.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysListVersionsSample.d.ts +2 -0
- package/dist-esm/samples-dev/managedHsmKeysListVersionsSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/managedHsmKeysListVersionsSample.js +61 -0
- package/dist-esm/samples-dev/managedHsmKeysListVersionsSample.js.map +1 -0
- package/dist-esm/samples-dev/managedHsmsCheckMhsmNameAvailabilitySample.d.ts +2 -0
- package/dist-esm/samples-dev/managedHsmsCheckMhsmNameAvailabilitySample.d.ts.map +1 -0
- package/dist-esm/samples-dev/managedHsmsCheckMhsmNameAvailabilitySample.js +38 -0
- package/dist-esm/samples-dev/managedHsmsCheckMhsmNameAvailabilitySample.js.map +1 -0
- package/dist-esm/samples-dev/managedHsmsCreateOrUpdateSample.js +13 -5
- package/dist-esm/samples-dev/managedHsmsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmsDeleteSample.js +12 -4
- package/dist-esm/samples-dev/managedHsmsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmsGetDeletedSample.js +11 -3
- package/dist-esm/samples-dev/managedHsmsGetDeletedSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmsGetSample.js +12 -4
- package/dist-esm/samples-dev/managedHsmsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmsListByResourceGroupSample.js +24 -9
- package/dist-esm/samples-dev/managedHsmsListByResourceGroupSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmsListBySubscriptionSample.js +23 -8
- package/dist-esm/samples-dev/managedHsmsListBySubscriptionSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmsListDeletedSample.js +23 -8
- package/dist-esm/samples-dev/managedHsmsListDeletedSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmsPurgeDeletedSample.js +11 -3
- package/dist-esm/samples-dev/managedHsmsPurgeDeletedSample.js.map +1 -1
- package/dist-esm/samples-dev/managedHsmsUpdateSample.js +12 -4
- package/dist-esm/samples-dev/managedHsmsUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/mhsmPrivateEndpointConnectionsDeleteSample.js +12 -4
- package/dist-esm/samples-dev/mhsmPrivateEndpointConnectionsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/mhsmPrivateEndpointConnectionsGetSample.js +12 -4
- package/dist-esm/samples-dev/mhsmPrivateEndpointConnectionsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/mhsmPrivateEndpointConnectionsListByResourceSample.js +24 -9
- package/dist-esm/samples-dev/mhsmPrivateEndpointConnectionsListByResourceSample.js.map +1 -1
- package/dist-esm/samples-dev/mhsmPrivateEndpointConnectionsPutSample.js +12 -4
- package/dist-esm/samples-dev/mhsmPrivateEndpointConnectionsPutSample.js.map +1 -1
- package/dist-esm/samples-dev/mhsmPrivateLinkResourcesListByMhsmResourceSample.js +12 -4
- package/dist-esm/samples-dev/mhsmPrivateLinkResourcesListByMhsmResourceSample.js.map +1 -1
- package/dist-esm/samples-dev/mhsmRegionsListByResourceSample.d.ts +2 -0
- package/dist-esm/samples-dev/mhsmRegionsListByResourceSample.d.ts.map +1 -0
- package/dist-esm/samples-dev/mhsmRegionsListByResourceSample.js +60 -0
- package/dist-esm/samples-dev/mhsmRegionsListByResourceSample.js.map +1 -0
- package/dist-esm/samples-dev/operationsListSample.js +23 -8
- package/dist-esm/samples-dev/operationsListSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js +12 -4
- package/dist-esm/samples-dev/privateEndpointConnectionsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js +12 -4
- package/dist-esm/samples-dev/privateEndpointConnectionsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsListByResourceSample.js +24 -9
- package/dist-esm/samples-dev/privateEndpointConnectionsListByResourceSample.js.map +1 -1
- package/dist-esm/samples-dev/privateEndpointConnectionsPutSample.js +12 -4
- package/dist-esm/samples-dev/privateEndpointConnectionsPutSample.js.map +1 -1
- package/dist-esm/samples-dev/privateLinkResourcesListByVaultSample.js +12 -4
- package/dist-esm/samples-dev/privateLinkResourcesListByVaultSample.js.map +1 -1
- package/dist-esm/samples-dev/secretsCreateOrUpdateSample.js +12 -4
- package/dist-esm/samples-dev/secretsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/secretsGetSample.js +12 -4
- package/dist-esm/samples-dev/secretsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/secretsListSample.js +24 -9
- package/dist-esm/samples-dev/secretsListSample.js.map +1 -1
- package/dist-esm/samples-dev/secretsUpdateSample.js +12 -4
- package/dist-esm/samples-dev/secretsUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsCheckNameAvailabilitySample.js +11 -3
- package/dist-esm/samples-dev/vaultsCheckNameAvailabilitySample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsCreateOrUpdateSample.js +17 -8
- package/dist-esm/samples-dev/vaultsCreateOrUpdateSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsDeleteSample.js +12 -4
- package/dist-esm/samples-dev/vaultsDeleteSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsGetDeletedSample.js +11 -3
- package/dist-esm/samples-dev/vaultsGetDeletedSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsGetSample.js +12 -4
- package/dist-esm/samples-dev/vaultsGetSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsListByResourceGroupSample.js +24 -9
- package/dist-esm/samples-dev/vaultsListByResourceGroupSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsListBySubscriptionSample.js +23 -8
- package/dist-esm/samples-dev/vaultsListBySubscriptionSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsListDeletedSample.js +23 -8
- package/dist-esm/samples-dev/vaultsListDeletedSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsListSample.js +23 -8
- package/dist-esm/samples-dev/vaultsListSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsPurgeDeletedSample.js +11 -3
- package/dist-esm/samples-dev/vaultsPurgeDeletedSample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsUpdateAccessPolicySample.js +12 -4
- package/dist-esm/samples-dev/vaultsUpdateAccessPolicySample.js.map +1 -1
- package/dist-esm/samples-dev/vaultsUpdateSample.js +12 -4
- package/dist-esm/samples-dev/vaultsUpdateSample.js.map +1 -1
- package/dist-esm/src/index.d.ts +1 -0
- package/dist-esm/src/index.d.ts.map +1 -1
- package/dist-esm/src/index.js +1 -0
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/keyVaultManagementClient.d.ts +5 -1
- package/dist-esm/src/keyVaultManagementClient.d.ts.map +1 -1
- package/dist-esm/src/keyVaultManagementClient.js +53 -20
- package/dist-esm/src/keyVaultManagementClient.js.map +1 -1
- package/dist-esm/src/lroImpl.d.ts +6 -11
- package/dist-esm/src/lroImpl.d.ts.map +1 -1
- package/dist-esm/src/lroImpl.js +12 -20
- package/dist-esm/src/lroImpl.js.map +1 -1
- package/dist-esm/src/models/index.d.ts +547 -107
- package/dist-esm/src/models/index.d.ts.map +1 -1
- package/dist-esm/src/models/index.js +135 -0
- package/dist-esm/src/models/index.js.map +1 -1
- package/dist-esm/src/models/mappers.d.ts +21 -0
- package/dist-esm/src/models/mappers.d.ts.map +1 -1
- package/dist-esm/src/models/mappers.js +617 -11
- package/dist-esm/src/models/mappers.js.map +1 -1
- package/dist-esm/src/models/parameters.d.ts +9 -5
- package/dist-esm/src/models/parameters.d.ts.map +1 -1
- package/dist-esm/src/models/parameters.js +45 -8
- package/dist-esm/src/models/parameters.js.map +1 -1
- package/dist-esm/src/operations/index.d.ts +2 -0
- package/dist-esm/src/operations/index.d.ts.map +1 -1
- package/dist-esm/src/operations/index.js +2 -0
- package/dist-esm/src/operations/index.js.map +1 -1
- package/dist-esm/src/operations/keys.d.ts +3 -1
- package/dist-esm/src/operations/keys.d.ts.map +1 -1
- package/dist-esm/src/operations/keys.js +64 -27
- package/dist-esm/src/operations/keys.js.map +1 -1
- package/dist-esm/src/operations/managedHsmKeys.d.ts +105 -0
- package/dist-esm/src/operations/managedHsmKeys.d.ts.map +1 -0
- package/dist-esm/src/operations/managedHsmKeys.js +404 -0
- package/dist-esm/src/operations/managedHsmKeys.js.map +1 -0
- package/dist-esm/src/operations/managedHsms.d.ts +13 -7
- package/dist-esm/src/operations/managedHsms.d.ts.map +1 -1
- package/dist-esm/src/operations/managedHsms.js +171 -70
- package/dist-esm/src/operations/managedHsms.js.map +1 -1
- package/dist-esm/src/operations/mhsmPrivateEndpointConnections.d.ts +2 -2
- package/dist-esm/src/operations/mhsmPrivateEndpointConnections.d.ts.map +1 -1
- package/dist-esm/src/operations/mhsmPrivateEndpointConnections.js +46 -24
- package/dist-esm/src/operations/mhsmPrivateEndpointConnections.js.map +1 -1
- package/dist-esm/src/operations/mhsmPrivateLinkResources.js +1 -1
- package/dist-esm/src/operations/mhsmPrivateLinkResources.js.map +1 -1
- package/dist-esm/src/operations/mhsmRegions.d.ts +38 -0
- package/dist-esm/src/operations/mhsmRegions.d.ts.map +1 -0
- package/dist-esm/src/operations/mhsmRegions.js +155 -0
- package/dist-esm/src/operations/mhsmRegions.js.map +1 -0
- package/dist-esm/src/operations/operations.d.ts.map +1 -1
- package/dist-esm/src/operations/operations.js +31 -13
- package/dist-esm/src/operations/operations.js.map +1 -1
- package/dist-esm/src/operations/privateEndpointConnections.d.ts +2 -2
- package/dist-esm/src/operations/privateEndpointConnections.d.ts.map +1 -1
- package/dist-esm/src/operations/privateEndpointConnections.js +46 -19
- package/dist-esm/src/operations/privateEndpointConnections.js.map +1 -1
- package/dist-esm/src/operations/secrets.d.ts +3 -1
- package/dist-esm/src/operations/secrets.d.ts.map +1 -1
- package/dist-esm/src/operations/secrets.js +36 -16
- package/dist-esm/src/operations/secrets.js.map +1 -1
- package/dist-esm/src/operations/vaults.d.ts +3 -3
- package/dist-esm/src/operations/vaults.d.ts.map +1 -1
- package/dist-esm/src/operations/vaults.js +142 -65
- package/dist-esm/src/operations/vaults.js.map +1 -1
- package/dist-esm/src/operationsInterfaces/index.d.ts +2 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/index.js +2 -0
- package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
- package/dist-esm/src/operationsInterfaces/keys.d.ts +3 -1
- package/dist-esm/src/operationsInterfaces/keys.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/managedHsmKeys.d.ts +57 -0
- package/dist-esm/src/operationsInterfaces/managedHsmKeys.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/managedHsmKeys.js +9 -0
- package/dist-esm/src/operationsInterfaces/managedHsmKeys.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/managedHsms.d.ts +13 -7
- package/dist-esm/src/operationsInterfaces/managedHsms.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/mhsmPrivateEndpointConnections.d.ts +2 -2
- package/dist-esm/src/operationsInterfaces/mhsmPrivateEndpointConnections.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/mhsmRegions.d.ts +13 -0
- package/dist-esm/src/operationsInterfaces/mhsmRegions.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/mhsmRegions.js +9 -0
- package/dist-esm/src/operationsInterfaces/mhsmRegions.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts +2 -2
- package/dist-esm/src/operationsInterfaces/privateEndpointConnections.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/secrets.d.ts +3 -1
- package/dist-esm/src/operationsInterfaces/secrets.d.ts.map +1 -1
- package/dist-esm/src/operationsInterfaces/vaults.d.ts +3 -3
- package/dist-esm/src/operationsInterfaces/vaults.d.ts.map +1 -1
- package/dist-esm/src/pagingHelper.d.ts +13 -0
- package/dist-esm/src/pagingHelper.d.ts.map +1 -0
- package/dist-esm/src/pagingHelper.js +32 -0
- package/dist-esm/src/pagingHelper.js.map +1 -0
- package/dist-esm/test/keyvault_examples.d.ts.map +1 -1
- package/dist-esm/test/keyvault_examples.js +42 -30
- package/dist-esm/test/keyvault_examples.js.map +1 -1
- package/package.json +21 -16
- package/review/arm-keyvault.api.md +304 -141
- package/src/index.ts +1 -0
- package/src/keyVaultManagementClient.ts +69 -21
- package/src/lroImpl.ts +31 -23
- package/src/models/index.ts +519 -44
- package/src/models/mappers.ts +644 -6
- package/src/models/parameters.ts +50 -7
- package/src/operations/index.ts +2 -0
- package/src/operations/keys.ts +56 -25
- package/src/operations/managedHsmKeys.ts +525 -0
- package/src/operations/managedHsms.ts +184 -83
- package/src/operations/mhsmPrivateEndpointConnections.ts +50 -26
- package/src/operations/mhsmPrivateLinkResources.ts +1 -1
- package/src/operations/mhsmRegions.ts +194 -0
- package/src/operations/operations.ts +21 -9
- package/src/operations/privateEndpointConnections.ts +51 -26
- package/src/operations/secrets.ts +32 -13
- package/src/operations/vaults.ts +117 -61
- package/src/operationsInterfaces/index.ts +2 -0
- package/src/operationsInterfaces/keys.ts +3 -1
- package/src/operationsInterfaces/managedHsmKeys.ts +103 -0
- package/src/operationsInterfaces/managedHsms.ts +27 -9
- package/src/operationsInterfaces/mhsmPrivateEndpointConnections.ts +3 -3
- package/src/operationsInterfaces/mhsmRegions.ts +29 -0
- package/src/operationsInterfaces/privateEndpointConnections.ts +3 -3
- package/src/operationsInterfaces/secrets.ts +3 -1
- package/src/operationsInterfaces/vaults.ts +4 -4
- package/src/pagingHelper.ts +39 -0
- package/types/arm-keyvault.d.ts +620 -45
- package/types/tsdoc-metadata.json +1 -1
package/types/arm-keyvault.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import * as coreAuth from '@azure/core-auth';
|
|
2
2
|
import * as coreClient from '@azure/core-client';
|
|
3
|
+
import { OperationState } from '@azure/core-lro';
|
|
3
4
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
4
|
-
import {
|
|
5
|
-
import { PollOperationState } from '@azure/core-lro';
|
|
5
|
+
import { SimplePollerLike } from '@azure/core-lro';
|
|
6
6
|
|
|
7
7
|
/** An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. */
|
|
8
8
|
export declare interface AccessPolicyEntry {
|
|
@@ -33,6 +33,18 @@ export declare interface Action {
|
|
|
33
33
|
*/
|
|
34
34
|
export declare type ActionsRequired = string;
|
|
35
35
|
|
|
36
|
+
/**
|
|
37
|
+
* Defines values for ActivationStatus. \
|
|
38
|
+
* {@link KnownActivationStatus} can be used interchangeably with ActivationStatus,
|
|
39
|
+
* this enum contains the known values that the service supports.
|
|
40
|
+
* ### Known values supported by the service
|
|
41
|
+
* **Active**: The managed HSM Pool is active. \
|
|
42
|
+
* **NotActivated**: The managed HSM Pool is not yet activated. \
|
|
43
|
+
* **Unknown**: An unknown error occurred while activating managed hsm. \
|
|
44
|
+
* **Failed**: Failed to activate managed hsm.
|
|
45
|
+
*/
|
|
46
|
+
export declare type ActivationStatus = string;
|
|
47
|
+
|
|
36
48
|
/** The object attributes managed by the KeyVault service. */
|
|
37
49
|
export declare interface Attributes {
|
|
38
50
|
/** Determines whether the object is enabled. */
|
|
@@ -78,6 +90,31 @@ export declare interface Attributes {
|
|
|
78
90
|
*/
|
|
79
91
|
export declare type CertificatePermissions = string;
|
|
80
92
|
|
|
93
|
+
/** The parameters used to check the availability of the managed hsm name. */
|
|
94
|
+
export declare interface CheckMhsmNameAvailabilityParameters {
|
|
95
|
+
/** The managed hsm name. */
|
|
96
|
+
name: string;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/** The CheckMhsmNameAvailability operation response. */
|
|
100
|
+
export declare interface CheckMhsmNameAvailabilityResult {
|
|
101
|
+
/**
|
|
102
|
+
* A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.
|
|
103
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
104
|
+
*/
|
|
105
|
+
readonly nameAvailable?: boolean;
|
|
106
|
+
/**
|
|
107
|
+
* The reason that a managed hsm name could not be used. The reason element is only returned if NameAvailable is false.
|
|
108
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
109
|
+
*/
|
|
110
|
+
readonly reason?: Reason;
|
|
111
|
+
/**
|
|
112
|
+
* An error message explaining the Reason value in more detail.
|
|
113
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
114
|
+
*/
|
|
115
|
+
readonly message?: string;
|
|
116
|
+
}
|
|
117
|
+
|
|
81
118
|
/** The CheckNameAvailability operation response. */
|
|
82
119
|
export declare interface CheckNameAvailabilityResult {
|
|
83
120
|
/**
|
|
@@ -284,6 +321,29 @@ export declare interface ErrorModel {
|
|
|
284
321
|
readonly innerError?: ErrorModel;
|
|
285
322
|
}
|
|
286
323
|
|
|
324
|
+
/**
|
|
325
|
+
* Defines values for GeoReplicationRegionProvisioningState. \
|
|
326
|
+
* {@link KnownGeoReplicationRegionProvisioningState} can be used interchangeably with GeoReplicationRegionProvisioningState,
|
|
327
|
+
* this enum contains the known values that the service supports.
|
|
328
|
+
* ### Known values supported by the service
|
|
329
|
+
* **Preprovisioning** \
|
|
330
|
+
* **Provisioning** \
|
|
331
|
+
* **Succeeded** \
|
|
332
|
+
* **Failed** \
|
|
333
|
+
* **Deleting** \
|
|
334
|
+
* **Cleanup**
|
|
335
|
+
*/
|
|
336
|
+
export declare type GeoReplicationRegionProvisioningState = string;
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* Given the last `.value` produced by the `byPage` iterator,
|
|
340
|
+
* returns a continuation token that can be used to begin paging from
|
|
341
|
+
* that point later.
|
|
342
|
+
* @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
|
|
343
|
+
* @returns The continuation token that can be passed into byPage() during future calls.
|
|
344
|
+
*/
|
|
345
|
+
export declare function getContinuationToken(page: unknown): string | undefined;
|
|
346
|
+
|
|
287
347
|
/**
|
|
288
348
|
* Defines values for IdentityType. \
|
|
289
349
|
* {@link KnownIdentityType} can be used interchangeably with IdentityType,
|
|
@@ -343,7 +403,7 @@ export declare type JsonWebKeyOperation = string;
|
|
|
343
403
|
export declare type JsonWebKeyType = string;
|
|
344
404
|
|
|
345
405
|
/** The key resource. */
|
|
346
|
-
export declare
|
|
406
|
+
export declare interface Key extends Resource {
|
|
347
407
|
/** The attributes of the key. */
|
|
348
408
|
attributes?: KeyAttributes;
|
|
349
409
|
/** The type of the key. For valid values, see JsonWebKeyType. */
|
|
@@ -367,7 +427,7 @@ export declare type Key = Resource & {
|
|
|
367
427
|
rotationPolicy?: RotationPolicy;
|
|
368
428
|
/** Key release policy in response. It will be used for both output and input. Omitted if empty */
|
|
369
429
|
releasePolicy?: KeyReleasePolicy;
|
|
370
|
-
}
|
|
430
|
+
}
|
|
371
431
|
|
|
372
432
|
/** The object attributes managed by the Azure Key Vault service. */
|
|
373
433
|
export declare interface KeyAttributes {
|
|
@@ -518,7 +578,9 @@ export declare interface Keys {
|
|
|
518
578
|
* versions, and does not update existing keys.
|
|
519
579
|
* @param resourceGroupName The name of the resource group which contains the specified key vault.
|
|
520
580
|
* @param vaultName The name of the key vault which contains the key to be created.
|
|
521
|
-
* @param keyName The name of the key to be created.
|
|
581
|
+
* @param keyName The name of the key to be created. The value you provide may be copied globally for
|
|
582
|
+
* the purpose of running the service. The value provided should not include personally identifiable or
|
|
583
|
+
* sensitive information.
|
|
522
584
|
* @param parameters The parameters used to create the specified key.
|
|
523
585
|
* @param options The options parameters.
|
|
524
586
|
*/
|
|
@@ -603,13 +665,17 @@ export declare class KeyVaultManagementClient extends coreClient.ServiceClient {
|
|
|
603
665
|
* @param options The parameter options
|
|
604
666
|
*/
|
|
605
667
|
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: KeyVaultManagementClientOptionalParams);
|
|
668
|
+
/** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
|
|
669
|
+
private addCustomApiVersionPolicy;
|
|
606
670
|
keys: Keys;
|
|
671
|
+
managedHsmKeys: ManagedHsmKeys;
|
|
607
672
|
vaults: Vaults;
|
|
608
673
|
privateEndpointConnections: PrivateEndpointConnections;
|
|
609
674
|
privateLinkResources: PrivateLinkResources;
|
|
610
675
|
managedHsms: ManagedHsms;
|
|
611
676
|
mhsmPrivateEndpointConnections: MhsmPrivateEndpointConnections;
|
|
612
677
|
mhsmPrivateLinkResources: MhsmPrivateLinkResources;
|
|
678
|
+
mhsmRegions: MhsmRegions;
|
|
613
679
|
operations: Operations;
|
|
614
680
|
secrets: Secrets;
|
|
615
681
|
}
|
|
@@ -626,131 +692,237 @@ export declare interface KeyVaultManagementClientOptionalParams extends coreClie
|
|
|
626
692
|
|
|
627
693
|
/** Known values of {@link ActionsRequired} that the service accepts. */
|
|
628
694
|
export declare enum KnownActionsRequired {
|
|
695
|
+
/** None */
|
|
629
696
|
None = "None"
|
|
630
697
|
}
|
|
631
698
|
|
|
699
|
+
/** Known values of {@link ActivationStatus} that the service accepts. */
|
|
700
|
+
export declare enum KnownActivationStatus {
|
|
701
|
+
/** The managed HSM Pool is active. */
|
|
702
|
+
Active = "Active",
|
|
703
|
+
/** The managed HSM Pool is not yet activated. */
|
|
704
|
+
NotActivated = "NotActivated",
|
|
705
|
+
/** An unknown error occurred while activating managed hsm. */
|
|
706
|
+
Unknown = "Unknown",
|
|
707
|
+
/** Failed to activate managed hsm. */
|
|
708
|
+
Failed = "Failed"
|
|
709
|
+
}
|
|
710
|
+
|
|
632
711
|
/** Known values of {@link CertificatePermissions} that the service accepts. */
|
|
633
712
|
export declare enum KnownCertificatePermissions {
|
|
713
|
+
/** All */
|
|
634
714
|
All = "all",
|
|
715
|
+
/** Get */
|
|
635
716
|
Get = "get",
|
|
717
|
+
/** List */
|
|
636
718
|
List = "list",
|
|
719
|
+
/** Delete */
|
|
637
720
|
Delete = "delete",
|
|
721
|
+
/** Create */
|
|
638
722
|
Create = "create",
|
|
723
|
+
/** Import */
|
|
639
724
|
Import = "import",
|
|
725
|
+
/** Update */
|
|
640
726
|
Update = "update",
|
|
727
|
+
/** Managecontacts */
|
|
641
728
|
Managecontacts = "managecontacts",
|
|
729
|
+
/** Getissuers */
|
|
642
730
|
Getissuers = "getissuers",
|
|
731
|
+
/** Listissuers */
|
|
643
732
|
Listissuers = "listissuers",
|
|
733
|
+
/** Setissuers */
|
|
644
734
|
Setissuers = "setissuers",
|
|
735
|
+
/** Deleteissuers */
|
|
645
736
|
Deleteissuers = "deleteissuers",
|
|
737
|
+
/** Manageissuers */
|
|
646
738
|
Manageissuers = "manageissuers",
|
|
739
|
+
/** Recover */
|
|
647
740
|
Recover = "recover",
|
|
741
|
+
/** Purge */
|
|
648
742
|
Purge = "purge",
|
|
743
|
+
/** Backup */
|
|
649
744
|
Backup = "backup",
|
|
745
|
+
/** Restore */
|
|
650
746
|
Restore = "restore"
|
|
651
747
|
}
|
|
652
748
|
|
|
653
749
|
/** Known values of {@link DeletionRecoveryLevel} that the service accepts. */
|
|
654
750
|
export declare enum KnownDeletionRecoveryLevel {
|
|
751
|
+
/** Purgeable */
|
|
655
752
|
Purgeable = "Purgeable",
|
|
753
|
+
/** RecoverablePurgeable */
|
|
656
754
|
RecoverablePurgeable = "Recoverable+Purgeable",
|
|
755
|
+
/** Recoverable */
|
|
657
756
|
Recoverable = "Recoverable",
|
|
757
|
+
/** RecoverableProtectedSubscription */
|
|
658
758
|
RecoverableProtectedSubscription = "Recoverable+ProtectedSubscription"
|
|
659
759
|
}
|
|
660
760
|
|
|
761
|
+
/** Known values of {@link GeoReplicationRegionProvisioningState} that the service accepts. */
|
|
762
|
+
export declare enum KnownGeoReplicationRegionProvisioningState {
|
|
763
|
+
/** Preprovisioning */
|
|
764
|
+
Preprovisioning = "Preprovisioning",
|
|
765
|
+
/** Provisioning */
|
|
766
|
+
Provisioning = "Provisioning",
|
|
767
|
+
/** Succeeded */
|
|
768
|
+
Succeeded = "Succeeded",
|
|
769
|
+
/** Failed */
|
|
770
|
+
Failed = "Failed",
|
|
771
|
+
/** Deleting */
|
|
772
|
+
Deleting = "Deleting",
|
|
773
|
+
/** Cleanup */
|
|
774
|
+
Cleanup = "Cleanup"
|
|
775
|
+
}
|
|
776
|
+
|
|
661
777
|
/** Known values of {@link IdentityType} that the service accepts. */
|
|
662
778
|
export declare enum KnownIdentityType {
|
|
779
|
+
/** User */
|
|
663
780
|
User = "User",
|
|
781
|
+
/** Application */
|
|
664
782
|
Application = "Application",
|
|
783
|
+
/** ManagedIdentity */
|
|
665
784
|
ManagedIdentity = "ManagedIdentity",
|
|
785
|
+
/** Key */
|
|
666
786
|
Key = "Key"
|
|
667
787
|
}
|
|
668
788
|
|
|
669
789
|
/** Known values of {@link JsonWebKeyCurveName} that the service accepts. */
|
|
670
790
|
export declare enum KnownJsonWebKeyCurveName {
|
|
791
|
+
/** P256 */
|
|
671
792
|
P256 = "P-256",
|
|
793
|
+
/** P384 */
|
|
672
794
|
P384 = "P-384",
|
|
795
|
+
/** P521 */
|
|
673
796
|
P521 = "P-521",
|
|
797
|
+
/** P256K */
|
|
674
798
|
P256K = "P-256K"
|
|
675
799
|
}
|
|
676
800
|
|
|
677
801
|
/** Known values of {@link JsonWebKeyOperation} that the service accepts. */
|
|
678
802
|
export declare enum KnownJsonWebKeyOperation {
|
|
803
|
+
/** Encrypt */
|
|
679
804
|
Encrypt = "encrypt",
|
|
805
|
+
/** Decrypt */
|
|
680
806
|
Decrypt = "decrypt",
|
|
807
|
+
/** Sign */
|
|
681
808
|
Sign = "sign",
|
|
809
|
+
/** Verify */
|
|
682
810
|
Verify = "verify",
|
|
811
|
+
/** WrapKey */
|
|
683
812
|
WrapKey = "wrapKey",
|
|
813
|
+
/** UnwrapKey */
|
|
684
814
|
UnwrapKey = "unwrapKey",
|
|
815
|
+
/** Import */
|
|
685
816
|
Import = "import",
|
|
817
|
+
/** Release */
|
|
686
818
|
Release = "release"
|
|
687
819
|
}
|
|
688
820
|
|
|
689
821
|
/** Known values of {@link JsonWebKeyType} that the service accepts. */
|
|
690
822
|
export declare enum KnownJsonWebKeyType {
|
|
823
|
+
/** EC */
|
|
691
824
|
EC = "EC",
|
|
825
|
+
/** ECHSM */
|
|
692
826
|
ECHSM = "EC-HSM",
|
|
827
|
+
/** RSA */
|
|
693
828
|
RSA = "RSA",
|
|
829
|
+
/** RSAHSM */
|
|
694
830
|
RSAHSM = "RSA-HSM"
|
|
695
831
|
}
|
|
696
832
|
|
|
697
833
|
/** Known values of {@link KeyPermissions} that the service accepts. */
|
|
698
834
|
export declare enum KnownKeyPermissions {
|
|
835
|
+
/** All */
|
|
699
836
|
All = "all",
|
|
837
|
+
/** Encrypt */
|
|
700
838
|
Encrypt = "encrypt",
|
|
839
|
+
/** Decrypt */
|
|
701
840
|
Decrypt = "decrypt",
|
|
841
|
+
/** WrapKey */
|
|
702
842
|
WrapKey = "wrapKey",
|
|
843
|
+
/** UnwrapKey */
|
|
703
844
|
UnwrapKey = "unwrapKey",
|
|
845
|
+
/** Sign */
|
|
704
846
|
Sign = "sign",
|
|
847
|
+
/** Verify */
|
|
705
848
|
Verify = "verify",
|
|
849
|
+
/** Get */
|
|
706
850
|
Get = "get",
|
|
851
|
+
/** List */
|
|
707
852
|
List = "list",
|
|
853
|
+
/** Create */
|
|
708
854
|
Create = "create",
|
|
855
|
+
/** Update */
|
|
709
856
|
Update = "update",
|
|
857
|
+
/** Import */
|
|
710
858
|
Import = "import",
|
|
859
|
+
/** Delete */
|
|
711
860
|
Delete = "delete",
|
|
861
|
+
/** Backup */
|
|
712
862
|
Backup = "backup",
|
|
863
|
+
/** Restore */
|
|
713
864
|
Restore = "restore",
|
|
865
|
+
/** Recover */
|
|
714
866
|
Recover = "recover",
|
|
867
|
+
/** Purge */
|
|
715
868
|
Purge = "purge",
|
|
869
|
+
/** Release */
|
|
716
870
|
Release = "release",
|
|
871
|
+
/** Rotate */
|
|
717
872
|
Rotate = "rotate",
|
|
873
|
+
/** Getrotationpolicy */
|
|
718
874
|
Getrotationpolicy = "getrotationpolicy",
|
|
875
|
+
/** Setrotationpolicy */
|
|
719
876
|
Setrotationpolicy = "setrotationpolicy"
|
|
720
877
|
}
|
|
721
878
|
|
|
722
879
|
/** Known values of {@link ManagedHsmSkuFamily} that the service accepts. */
|
|
723
880
|
export declare enum KnownManagedHsmSkuFamily {
|
|
881
|
+
/** B */
|
|
724
882
|
B = "B"
|
|
725
883
|
}
|
|
726
884
|
|
|
727
885
|
/** Known values of {@link NetworkRuleAction} that the service accepts. */
|
|
728
886
|
export declare enum KnownNetworkRuleAction {
|
|
887
|
+
/** Allow */
|
|
729
888
|
Allow = "Allow",
|
|
889
|
+
/** Deny */
|
|
730
890
|
Deny = "Deny"
|
|
731
891
|
}
|
|
732
892
|
|
|
733
893
|
/** Known values of {@link NetworkRuleBypassOptions} that the service accepts. */
|
|
734
894
|
export declare enum KnownNetworkRuleBypassOptions {
|
|
895
|
+
/** AzureServices */
|
|
735
896
|
AzureServices = "AzureServices",
|
|
897
|
+
/** None */
|
|
736
898
|
None = "None"
|
|
737
899
|
}
|
|
738
900
|
|
|
739
901
|
/** Known values of {@link PrivateEndpointConnectionProvisioningState} that the service accepts. */
|
|
740
902
|
export declare enum KnownPrivateEndpointConnectionProvisioningState {
|
|
903
|
+
/** Succeeded */
|
|
741
904
|
Succeeded = "Succeeded",
|
|
905
|
+
/** Creating */
|
|
742
906
|
Creating = "Creating",
|
|
907
|
+
/** Updating */
|
|
743
908
|
Updating = "Updating",
|
|
909
|
+
/** Deleting */
|
|
744
910
|
Deleting = "Deleting",
|
|
911
|
+
/** Failed */
|
|
745
912
|
Failed = "Failed",
|
|
913
|
+
/** Disconnected */
|
|
746
914
|
Disconnected = "Disconnected"
|
|
747
915
|
}
|
|
748
916
|
|
|
749
917
|
/** Known values of {@link PrivateEndpointServiceConnectionStatus} that the service accepts. */
|
|
750
918
|
export declare enum KnownPrivateEndpointServiceConnectionStatus {
|
|
919
|
+
/** Pending */
|
|
751
920
|
Pending = "Pending",
|
|
921
|
+
/** Approved */
|
|
752
922
|
Approved = "Approved",
|
|
923
|
+
/** Rejected */
|
|
753
924
|
Rejected = "Rejected",
|
|
925
|
+
/** Disconnected */
|
|
754
926
|
Disconnected = "Disconnected"
|
|
755
927
|
}
|
|
756
928
|
|
|
@@ -776,50 +948,79 @@ export declare enum KnownProvisioningState {
|
|
|
776
948
|
|
|
777
949
|
/** Known values of {@link PublicNetworkAccess} that the service accepts. */
|
|
778
950
|
export declare enum KnownPublicNetworkAccess {
|
|
951
|
+
/** Enabled */
|
|
779
952
|
Enabled = "Enabled",
|
|
953
|
+
/** Disabled */
|
|
780
954
|
Disabled = "Disabled"
|
|
781
955
|
}
|
|
782
956
|
|
|
783
957
|
/** Known values of {@link SecretPermissions} that the service accepts. */
|
|
784
958
|
export declare enum KnownSecretPermissions {
|
|
959
|
+
/** All */
|
|
785
960
|
All = "all",
|
|
961
|
+
/** Get */
|
|
786
962
|
Get = "get",
|
|
963
|
+
/** List */
|
|
787
964
|
List = "list",
|
|
965
|
+
/** Set */
|
|
788
966
|
Set = "set",
|
|
967
|
+
/** Delete */
|
|
789
968
|
Delete = "delete",
|
|
969
|
+
/** Backup */
|
|
790
970
|
Backup = "backup",
|
|
971
|
+
/** Restore */
|
|
791
972
|
Restore = "restore",
|
|
973
|
+
/** Recover */
|
|
792
974
|
Recover = "recover",
|
|
975
|
+
/** Purge */
|
|
793
976
|
Purge = "purge"
|
|
794
977
|
}
|
|
795
978
|
|
|
796
979
|
/** Known values of {@link SkuFamily} that the service accepts. */
|
|
797
980
|
export declare enum KnownSkuFamily {
|
|
981
|
+
/** A */
|
|
798
982
|
A = "A"
|
|
799
983
|
}
|
|
800
984
|
|
|
801
985
|
/** Known values of {@link StoragePermissions} that the service accepts. */
|
|
802
986
|
export declare enum KnownStoragePermissions {
|
|
987
|
+
/** All */
|
|
803
988
|
All = "all",
|
|
989
|
+
/** Get */
|
|
804
990
|
Get = "get",
|
|
991
|
+
/** List */
|
|
805
992
|
List = "list",
|
|
993
|
+
/** Delete */
|
|
806
994
|
Delete = "delete",
|
|
995
|
+
/** Set */
|
|
807
996
|
Set = "set",
|
|
997
|
+
/** Update */
|
|
808
998
|
Update = "update",
|
|
999
|
+
/** Regeneratekey */
|
|
809
1000
|
Regeneratekey = "regeneratekey",
|
|
1001
|
+
/** Recover */
|
|
810
1002
|
Recover = "recover",
|
|
1003
|
+
/** Purge */
|
|
811
1004
|
Purge = "purge",
|
|
1005
|
+
/** Backup */
|
|
812
1006
|
Backup = "backup",
|
|
1007
|
+
/** Restore */
|
|
813
1008
|
Restore = "restore",
|
|
1009
|
+
/** Setsas */
|
|
814
1010
|
Setsas = "setsas",
|
|
1011
|
+
/** Listsas */
|
|
815
1012
|
Listsas = "listsas",
|
|
1013
|
+
/** Getsas */
|
|
816
1014
|
Getsas = "getsas",
|
|
1015
|
+
/** Deletesas */
|
|
817
1016
|
Deletesas = "deletesas"
|
|
818
1017
|
}
|
|
819
1018
|
|
|
820
1019
|
/** Known values of {@link VaultProvisioningState} that the service accepts. */
|
|
821
1020
|
export declare enum KnownVaultProvisioningState {
|
|
1021
|
+
/** Succeeded */
|
|
822
1022
|
Succeeded = "Succeeded",
|
|
1023
|
+
/** RegisteringDns */
|
|
823
1024
|
RegisteringDns = "RegisteringDns"
|
|
824
1025
|
}
|
|
825
1026
|
|
|
@@ -841,10 +1042,15 @@ export declare interface LogSpecification {
|
|
|
841
1042
|
}
|
|
842
1043
|
|
|
843
1044
|
/** Resource information with extended details. */
|
|
844
|
-
export declare
|
|
1045
|
+
export declare interface ManagedHsm extends ManagedHsmResource {
|
|
845
1046
|
/** Properties of the managed HSM */
|
|
846
1047
|
properties?: ManagedHsmProperties;
|
|
847
|
-
}
|
|
1048
|
+
}
|
|
1049
|
+
|
|
1050
|
+
export declare interface ManagedHsmAction {
|
|
1051
|
+
/** The type of action. */
|
|
1052
|
+
type?: KeyRotationPolicyActionType;
|
|
1053
|
+
}
|
|
848
1054
|
|
|
849
1055
|
/** The error exception. */
|
|
850
1056
|
export declare interface ManagedHsmError {
|
|
@@ -855,6 +1061,238 @@ export declare interface ManagedHsmError {
|
|
|
855
1061
|
readonly error?: ErrorModel;
|
|
856
1062
|
}
|
|
857
1063
|
|
|
1064
|
+
/** The key resource. */
|
|
1065
|
+
export declare interface ManagedHsmKey extends ProxyResourceWithoutSystemData {
|
|
1066
|
+
/** The attributes of the key. */
|
|
1067
|
+
attributes?: ManagedHsmKeyAttributes;
|
|
1068
|
+
/** The type of the key. For valid values, see JsonWebKeyType. */
|
|
1069
|
+
kty?: JsonWebKeyType;
|
|
1070
|
+
keyOps?: JsonWebKeyOperation[];
|
|
1071
|
+
/** The key size in bits. For example: 2048, 3072, or 4096 for RSA. */
|
|
1072
|
+
keySize?: number;
|
|
1073
|
+
/** The elliptic curve name. For valid values, see JsonWebKeyCurveName. */
|
|
1074
|
+
curveName?: JsonWebKeyCurveName;
|
|
1075
|
+
/**
|
|
1076
|
+
* The URI to retrieve the current version of the key.
|
|
1077
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1078
|
+
*/
|
|
1079
|
+
readonly keyUri?: string;
|
|
1080
|
+
/**
|
|
1081
|
+
* The URI to retrieve the specific version of the key.
|
|
1082
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1083
|
+
*/
|
|
1084
|
+
readonly keyUriWithVersion?: string;
|
|
1085
|
+
/** Key rotation policy in response. It will be used for both output and input. Omitted if empty */
|
|
1086
|
+
rotationPolicy?: ManagedHsmRotationPolicy;
|
|
1087
|
+
/** Key release policy in response. It will be used for both output and input. Omitted if empty */
|
|
1088
|
+
releasePolicy?: ManagedHsmKeyReleasePolicy;
|
|
1089
|
+
}
|
|
1090
|
+
|
|
1091
|
+
/** The object attributes managed by the Azure Key Vault service. */
|
|
1092
|
+
export declare interface ManagedHsmKeyAttributes {
|
|
1093
|
+
/** Determines whether or not the object is enabled. */
|
|
1094
|
+
enabled?: boolean;
|
|
1095
|
+
/** Not before date in seconds since 1970-01-01T00:00:00Z. */
|
|
1096
|
+
notBefore?: number;
|
|
1097
|
+
/** Expiry date in seconds since 1970-01-01T00:00:00Z. */
|
|
1098
|
+
expires?: number;
|
|
1099
|
+
/**
|
|
1100
|
+
* Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
1101
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1102
|
+
*/
|
|
1103
|
+
readonly created?: number;
|
|
1104
|
+
/**
|
|
1105
|
+
* Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
1106
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1107
|
+
*/
|
|
1108
|
+
readonly updated?: number;
|
|
1109
|
+
/**
|
|
1110
|
+
* The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
|
|
1111
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1112
|
+
*/
|
|
1113
|
+
readonly recoveryLevel?: DeletionRecoveryLevel;
|
|
1114
|
+
/** Indicates if the private key can be exported. */
|
|
1115
|
+
exportable?: boolean;
|
|
1116
|
+
}
|
|
1117
|
+
|
|
1118
|
+
/** The parameters used to create a key. */
|
|
1119
|
+
export declare interface ManagedHsmKeyCreateParameters {
|
|
1120
|
+
/** The tags that will be assigned to the key. */
|
|
1121
|
+
tags?: {
|
|
1122
|
+
[propertyName: string]: string;
|
|
1123
|
+
};
|
|
1124
|
+
/** The properties of the key to be created. */
|
|
1125
|
+
properties: ManagedHsmKeyProperties;
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
/** The page of keys. */
|
|
1129
|
+
export declare interface ManagedHsmKeyListResult {
|
|
1130
|
+
/** The key resources. */
|
|
1131
|
+
value?: ManagedHsmKey[];
|
|
1132
|
+
/** The URL to get the next page of keys. */
|
|
1133
|
+
nextLink?: string;
|
|
1134
|
+
}
|
|
1135
|
+
|
|
1136
|
+
/** The properties of the key. */
|
|
1137
|
+
export declare interface ManagedHsmKeyProperties {
|
|
1138
|
+
/** The attributes of the key. */
|
|
1139
|
+
attributes?: ManagedHsmKeyAttributes;
|
|
1140
|
+
/** The type of the key. For valid values, see JsonWebKeyType. */
|
|
1141
|
+
kty?: JsonWebKeyType;
|
|
1142
|
+
keyOps?: JsonWebKeyOperation[];
|
|
1143
|
+
/** The key size in bits. For example: 2048, 3072, or 4096 for RSA. */
|
|
1144
|
+
keySize?: number;
|
|
1145
|
+
/** The elliptic curve name. For valid values, see JsonWebKeyCurveName. */
|
|
1146
|
+
curveName?: JsonWebKeyCurveName;
|
|
1147
|
+
/**
|
|
1148
|
+
* The URI to retrieve the current version of the key.
|
|
1149
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1150
|
+
*/
|
|
1151
|
+
readonly keyUri?: string;
|
|
1152
|
+
/**
|
|
1153
|
+
* The URI to retrieve the specific version of the key.
|
|
1154
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1155
|
+
*/
|
|
1156
|
+
readonly keyUriWithVersion?: string;
|
|
1157
|
+
/** Key rotation policy in response. It will be used for both output and input. Omitted if empty */
|
|
1158
|
+
rotationPolicy?: ManagedHsmRotationPolicy;
|
|
1159
|
+
/** Key release policy in response. It will be used for both output and input. Omitted if empty */
|
|
1160
|
+
releasePolicy?: ManagedHsmKeyReleasePolicy;
|
|
1161
|
+
}
|
|
1162
|
+
|
|
1163
|
+
export declare interface ManagedHsmKeyReleasePolicy {
|
|
1164
|
+
/** Content type and version of key release policy */
|
|
1165
|
+
contentType?: string;
|
|
1166
|
+
/** Blob encoding the policy rules under which the key can be released. */
|
|
1167
|
+
data?: Uint8Array;
|
|
1168
|
+
}
|
|
1169
|
+
|
|
1170
|
+
export declare interface ManagedHsmKeyRotationPolicyAttributes {
|
|
1171
|
+
/**
|
|
1172
|
+
* Creation time in seconds since 1970-01-01T00:00:00Z.
|
|
1173
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1174
|
+
*/
|
|
1175
|
+
readonly created?: number;
|
|
1176
|
+
/**
|
|
1177
|
+
* Last updated time in seconds since 1970-01-01T00:00:00Z.
|
|
1178
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1179
|
+
*/
|
|
1180
|
+
readonly updated?: number;
|
|
1181
|
+
/** The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. */
|
|
1182
|
+
expiryTime?: string;
|
|
1183
|
+
}
|
|
1184
|
+
|
|
1185
|
+
/** Interface representing a ManagedHsmKeys. */
|
|
1186
|
+
export declare interface ManagedHsmKeys {
|
|
1187
|
+
/**
|
|
1188
|
+
* Lists the keys in the specified managed HSM.
|
|
1189
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1190
|
+
* @param name The name of the Managed HSM Pool within the specified resource group.
|
|
1191
|
+
* @param options The options parameters.
|
|
1192
|
+
*/
|
|
1193
|
+
list(resourceGroupName: string, name: string, options?: ManagedHsmKeysListOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey>;
|
|
1194
|
+
/**
|
|
1195
|
+
* Lists the versions of the specified key in the specified managed HSM.
|
|
1196
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1197
|
+
* @param name The name of the Managed HSM Pool within the specified resource group.
|
|
1198
|
+
* @param keyName The name of the key to be created. The value you provide may be copied globally for
|
|
1199
|
+
* the purpose of running the service. The value provided should not include personally identifiable or
|
|
1200
|
+
* sensitive information.
|
|
1201
|
+
* @param options The options parameters.
|
|
1202
|
+
*/
|
|
1203
|
+
listVersions(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysListVersionsOptionalParams): PagedAsyncIterableIterator<ManagedHsmKey>;
|
|
1204
|
+
/**
|
|
1205
|
+
* Creates the first version of a new key if it does not exist. If it already exists, then the existing
|
|
1206
|
+
* key is returned without any write operations being performed. This API does not create subsequent
|
|
1207
|
+
* versions, and does not update existing keys.
|
|
1208
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1209
|
+
* @param name The name of the Managed HSM Pool within the specified resource group.
|
|
1210
|
+
* @param keyName The name of the key to be created. The value you provide may be copied globally for
|
|
1211
|
+
* the purpose of running the service. The value provided should not include personally identifiable or
|
|
1212
|
+
* sensitive information.
|
|
1213
|
+
* @param parameters The parameters used to create the specified key.
|
|
1214
|
+
* @param options The options parameters.
|
|
1215
|
+
*/
|
|
1216
|
+
createIfNotExist(resourceGroupName: string, name: string, keyName: string, parameters: ManagedHsmKeyCreateParameters, options?: ManagedHsmKeysCreateIfNotExistOptionalParams): Promise<ManagedHsmKeysCreateIfNotExistResponse>;
|
|
1217
|
+
/**
|
|
1218
|
+
* Gets the current version of the specified key from the specified managed HSM.
|
|
1219
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1220
|
+
* @param name The name of the Managed HSM Pool within the specified resource group.
|
|
1221
|
+
* @param keyName The name of the key to be created. The value you provide may be copied globally for
|
|
1222
|
+
* the purpose of running the service. The value provided should not include personally identifiable or
|
|
1223
|
+
* sensitive information.
|
|
1224
|
+
* @param options The options parameters.
|
|
1225
|
+
*/
|
|
1226
|
+
get(resourceGroupName: string, name: string, keyName: string, options?: ManagedHsmKeysGetOptionalParams): Promise<ManagedHsmKeysGetResponse>;
|
|
1227
|
+
/**
|
|
1228
|
+
* Gets the specified version of the specified key in the specified managed HSM.
|
|
1229
|
+
* @param resourceGroupName The name of the resource group. The name is case insensitive.
|
|
1230
|
+
* @param name The name of the Managed HSM Pool within the specified resource group.
|
|
1231
|
+
* @param keyName The name of the key to be created. The value you provide may be copied globally for
|
|
1232
|
+
* the purpose of running the service. The value provided should not include personally identifiable or
|
|
1233
|
+
* sensitive information.
|
|
1234
|
+
* @param keyVersion The version of the key to be retrieved.
|
|
1235
|
+
* @param options The options parameters.
|
|
1236
|
+
*/
|
|
1237
|
+
getVersion(resourceGroupName: string, name: string, keyName: string, keyVersion: string, options?: ManagedHsmKeysGetVersionOptionalParams): Promise<ManagedHsmKeysGetVersionResponse>;
|
|
1238
|
+
}
|
|
1239
|
+
|
|
1240
|
+
/** Optional parameters. */
|
|
1241
|
+
export declare interface ManagedHsmKeysCreateIfNotExistOptionalParams extends coreClient.OperationOptions {
|
|
1242
|
+
}
|
|
1243
|
+
|
|
1244
|
+
/** Contains response data for the createIfNotExist operation. */
|
|
1245
|
+
export declare type ManagedHsmKeysCreateIfNotExistResponse = ManagedHsmKey;
|
|
1246
|
+
|
|
1247
|
+
/** Optional parameters. */
|
|
1248
|
+
export declare interface ManagedHsmKeysGetOptionalParams extends coreClient.OperationOptions {
|
|
1249
|
+
}
|
|
1250
|
+
|
|
1251
|
+
/** Contains response data for the get operation. */
|
|
1252
|
+
export declare type ManagedHsmKeysGetResponse = ManagedHsmKey;
|
|
1253
|
+
|
|
1254
|
+
/** Optional parameters. */
|
|
1255
|
+
export declare interface ManagedHsmKeysGetVersionOptionalParams extends coreClient.OperationOptions {
|
|
1256
|
+
}
|
|
1257
|
+
|
|
1258
|
+
/** Contains response data for the getVersion operation. */
|
|
1259
|
+
export declare type ManagedHsmKeysGetVersionResponse = ManagedHsmKey;
|
|
1260
|
+
|
|
1261
|
+
/** Optional parameters. */
|
|
1262
|
+
export declare interface ManagedHsmKeysListNextOptionalParams extends coreClient.OperationOptions {
|
|
1263
|
+
}
|
|
1264
|
+
|
|
1265
|
+
/** Contains response data for the listNext operation. */
|
|
1266
|
+
export declare type ManagedHsmKeysListNextResponse = ManagedHsmKeyListResult;
|
|
1267
|
+
|
|
1268
|
+
/** Optional parameters. */
|
|
1269
|
+
export declare interface ManagedHsmKeysListOptionalParams extends coreClient.OperationOptions {
|
|
1270
|
+
}
|
|
1271
|
+
|
|
1272
|
+
/** Contains response data for the list operation. */
|
|
1273
|
+
export declare type ManagedHsmKeysListResponse = ManagedHsmKeyListResult;
|
|
1274
|
+
|
|
1275
|
+
/** Optional parameters. */
|
|
1276
|
+
export declare interface ManagedHsmKeysListVersionsNextOptionalParams extends coreClient.OperationOptions {
|
|
1277
|
+
}
|
|
1278
|
+
|
|
1279
|
+
/** Contains response data for the listVersionsNext operation. */
|
|
1280
|
+
export declare type ManagedHsmKeysListVersionsNextResponse = ManagedHsmKeyListResult;
|
|
1281
|
+
|
|
1282
|
+
/** Optional parameters. */
|
|
1283
|
+
export declare interface ManagedHsmKeysListVersionsOptionalParams extends coreClient.OperationOptions {
|
|
1284
|
+
}
|
|
1285
|
+
|
|
1286
|
+
/** Contains response data for the listVersions operation. */
|
|
1287
|
+
export declare type ManagedHsmKeysListVersionsResponse = ManagedHsmKeyListResult;
|
|
1288
|
+
|
|
1289
|
+
export declare interface ManagedHsmLifetimeAction {
|
|
1290
|
+
/** The trigger of key rotation policy lifetimeAction. */
|
|
1291
|
+
trigger?: ManagedHsmTrigger;
|
|
1292
|
+
/** The action of key rotation policy lifetimeAction. */
|
|
1293
|
+
action?: ManagedHsmAction;
|
|
1294
|
+
}
|
|
1295
|
+
|
|
858
1296
|
/** List of managed HSM Pools */
|
|
859
1297
|
export declare interface ManagedHsmListResult {
|
|
860
1298
|
/** The list of managed HSM Pools. */
|
|
@@ -894,6 +1332,8 @@ export declare interface ManagedHsmProperties {
|
|
|
894
1332
|
readonly provisioningState?: ProvisioningState;
|
|
895
1333
|
/** Rules governing the accessibility of the key vault from specific network locations. */
|
|
896
1334
|
networkAcls?: MhsmNetworkRuleSet;
|
|
1335
|
+
/** List of all regions associated with the managed hsm pool. */
|
|
1336
|
+
regions?: MhsmGeoReplicatedRegion[];
|
|
897
1337
|
/**
|
|
898
1338
|
* List of private endpoint connections associated with the managed hsm pool.
|
|
899
1339
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -906,6 +1346,11 @@ export declare interface ManagedHsmProperties {
|
|
|
906
1346
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
907
1347
|
*/
|
|
908
1348
|
readonly scheduledPurgeDate?: Date;
|
|
1349
|
+
/**
|
|
1350
|
+
* Managed HSM security domain properties.
|
|
1351
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1352
|
+
*/
|
|
1353
|
+
readonly securityDomainProperties?: ManagedHSMSecurityDomainProperties;
|
|
909
1354
|
}
|
|
910
1355
|
|
|
911
1356
|
/** Managed HSM resource */
|
|
@@ -940,6 +1385,13 @@ export declare interface ManagedHsmResource {
|
|
|
940
1385
|
readonly systemData?: SystemData;
|
|
941
1386
|
}
|
|
942
1387
|
|
|
1388
|
+
export declare interface ManagedHsmRotationPolicy {
|
|
1389
|
+
/** The attributes of key rotation policy. */
|
|
1390
|
+
attributes?: ManagedHsmKeyRotationPolicyAttributes;
|
|
1391
|
+
/** The lifetimeActions for key rotation action. */
|
|
1392
|
+
lifetimeActions?: ManagedHsmLifetimeAction[];
|
|
1393
|
+
}
|
|
1394
|
+
|
|
943
1395
|
/** Interface representing a ManagedHsms. */
|
|
944
1396
|
export declare interface ManagedHsms {
|
|
945
1397
|
/**
|
|
@@ -966,7 +1418,7 @@ export declare interface ManagedHsms {
|
|
|
966
1418
|
* @param parameters Parameters to create or update the managed HSM Pool
|
|
967
1419
|
* @param options The options parameters.
|
|
968
1420
|
*/
|
|
969
|
-
beginCreateOrUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsCreateOrUpdateOptionalParams): Promise<
|
|
1421
|
+
beginCreateOrUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsmsCreateOrUpdateResponse>, ManagedHsmsCreateOrUpdateResponse>>;
|
|
970
1422
|
/**
|
|
971
1423
|
* Create or update a managed HSM Pool in the specified subscription.
|
|
972
1424
|
* @param resourceGroupName Name of the resource group that contains the managed HSM pool.
|
|
@@ -982,7 +1434,7 @@ export declare interface ManagedHsms {
|
|
|
982
1434
|
* @param parameters Parameters to patch the managed HSM Pool
|
|
983
1435
|
* @param options The options parameters.
|
|
984
1436
|
*/
|
|
985
|
-
beginUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsUpdateOptionalParams): Promise<
|
|
1437
|
+
beginUpdate(resourceGroupName: string, name: string, parameters: ManagedHsm, options?: ManagedHsmsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsmsUpdateResponse>, ManagedHsmsUpdateResponse>>;
|
|
986
1438
|
/**
|
|
987
1439
|
* Update a managed HSM Pool in the specified subscription.
|
|
988
1440
|
* @param resourceGroupName Name of the resource group that contains the managed HSM pool.
|
|
@@ -997,7 +1449,7 @@ export declare interface ManagedHsms {
|
|
|
997
1449
|
* @param name The name of the managed HSM Pool to delete
|
|
998
1450
|
* @param options The options parameters.
|
|
999
1451
|
*/
|
|
1000
|
-
beginDelete(resourceGroupName: string, name: string, options?: ManagedHsmsDeleteOptionalParams): Promise<
|
|
1452
|
+
beginDelete(resourceGroupName: string, name: string, options?: ManagedHsmsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
|
|
1001
1453
|
/**
|
|
1002
1454
|
* Deletes the specified managed HSM Pool.
|
|
1003
1455
|
* @param resourceGroupName Name of the resource group that contains the managed HSM pool.
|
|
@@ -1025,14 +1477,33 @@ export declare interface ManagedHsms {
|
|
|
1025
1477
|
* @param location The location of the soft-deleted managed HSM.
|
|
1026
1478
|
* @param options The options parameters.
|
|
1027
1479
|
*/
|
|
1028
|
-
beginPurgeDeleted(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<
|
|
1480
|
+
beginPurgeDeleted(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<ManagedHsmsPurgeDeletedResponse>, ManagedHsmsPurgeDeletedResponse>>;
|
|
1029
1481
|
/**
|
|
1030
1482
|
* Permanently deletes the specified managed HSM.
|
|
1031
1483
|
* @param name The name of the soft-deleted managed HSM.
|
|
1032
1484
|
* @param location The location of the soft-deleted managed HSM.
|
|
1033
1485
|
* @param options The options parameters.
|
|
1034
1486
|
*/
|
|
1035
|
-
beginPurgeDeletedAndWait(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<
|
|
1487
|
+
beginPurgeDeletedAndWait(name: string, location: string, options?: ManagedHsmsPurgeDeletedOptionalParams): Promise<ManagedHsmsPurgeDeletedResponse>;
|
|
1488
|
+
/**
|
|
1489
|
+
* Checks that the managed hsm name is valid and is not already in use.
|
|
1490
|
+
* @param mhsmName The name of the managed hsm.
|
|
1491
|
+
* @param options The options parameters.
|
|
1492
|
+
*/
|
|
1493
|
+
checkMhsmNameAvailability(mhsmName: CheckMhsmNameAvailabilityParameters, options?: ManagedHsmsCheckMhsmNameAvailabilityOptionalParams): Promise<ManagedHsmsCheckMhsmNameAvailabilityResponse>;
|
|
1494
|
+
}
|
|
1495
|
+
|
|
1496
|
+
/** Optional parameters. */
|
|
1497
|
+
export declare interface ManagedHsmsCheckMhsmNameAvailabilityOptionalParams extends coreClient.OperationOptions {
|
|
1498
|
+
}
|
|
1499
|
+
|
|
1500
|
+
/** Contains response data for the checkMhsmNameAvailability operation. */
|
|
1501
|
+
export declare type ManagedHsmsCheckMhsmNameAvailabilityResponse = CheckMhsmNameAvailabilityResult;
|
|
1502
|
+
|
|
1503
|
+
/** Defines headers for ManagedHsms_createOrUpdate operation. */
|
|
1504
|
+
export declare interface ManagedHsmsCreateOrUpdateHeaders {
|
|
1505
|
+
/** The URI to poll for completion status. */
|
|
1506
|
+
location?: string;
|
|
1036
1507
|
}
|
|
1037
1508
|
|
|
1038
1509
|
/** Optional parameters. */
|
|
@@ -1046,6 +1517,12 @@ export declare interface ManagedHsmsCreateOrUpdateOptionalParams extends coreCli
|
|
|
1046
1517
|
/** Contains response data for the createOrUpdate operation. */
|
|
1047
1518
|
export declare type ManagedHsmsCreateOrUpdateResponse = ManagedHsm;
|
|
1048
1519
|
|
|
1520
|
+
/** Defines headers for ManagedHsms_delete operation. */
|
|
1521
|
+
export declare interface ManagedHsmsDeleteHeaders {
|
|
1522
|
+
/** The URI to poll for completion status. */
|
|
1523
|
+
location?: string;
|
|
1524
|
+
}
|
|
1525
|
+
|
|
1049
1526
|
/** Optional parameters. */
|
|
1050
1527
|
export declare interface ManagedHsmsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1051
1528
|
/** Delay to wait until next poll, in milliseconds. */
|
|
@@ -1054,6 +1531,20 @@ export declare interface ManagedHsmsDeleteOptionalParams extends coreClient.Oper
|
|
|
1054
1531
|
resumeFrom?: string;
|
|
1055
1532
|
}
|
|
1056
1533
|
|
|
1534
|
+
/** The security domain properties of the managed hsm. */
|
|
1535
|
+
export declare interface ManagedHSMSecurityDomainProperties {
|
|
1536
|
+
/**
|
|
1537
|
+
* Activation Status
|
|
1538
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1539
|
+
*/
|
|
1540
|
+
readonly activationStatus?: ActivationStatus;
|
|
1541
|
+
/**
|
|
1542
|
+
* Activation Status Message.
|
|
1543
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1544
|
+
*/
|
|
1545
|
+
readonly activationStatusMessage?: string;
|
|
1546
|
+
}
|
|
1547
|
+
|
|
1057
1548
|
/** Optional parameters. */
|
|
1058
1549
|
export declare interface ManagedHsmsGetDeletedOptionalParams extends coreClient.OperationOptions {
|
|
1059
1550
|
}
|
|
@@ -1090,8 +1581,6 @@ export declare type ManagedHsmSkuName = "Standard_B1" | "Custom_B32";
|
|
|
1090
1581
|
|
|
1091
1582
|
/** Optional parameters. */
|
|
1092
1583
|
export declare interface ManagedHsmsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
|
|
1093
|
-
/** Maximum number of results to return. */
|
|
1094
|
-
top?: number;
|
|
1095
1584
|
}
|
|
1096
1585
|
|
|
1097
1586
|
/** Contains response data for the listByResourceGroupNext operation. */
|
|
@@ -1108,8 +1597,6 @@ export declare type ManagedHsmsListByResourceGroupResponse = ManagedHsmListResul
|
|
|
1108
1597
|
|
|
1109
1598
|
/** Optional parameters. */
|
|
1110
1599
|
export declare interface ManagedHsmsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
|
|
1111
|
-
/** Maximum number of results to return. */
|
|
1112
|
-
top?: number;
|
|
1113
1600
|
}
|
|
1114
1601
|
|
|
1115
1602
|
/** Contains response data for the listBySubscriptionNext operation. */
|
|
@@ -1138,6 +1625,12 @@ export declare interface ManagedHsmsListDeletedOptionalParams extends coreClient
|
|
|
1138
1625
|
/** Contains response data for the listDeleted operation. */
|
|
1139
1626
|
export declare type ManagedHsmsListDeletedResponse = DeletedManagedHsmListResult;
|
|
1140
1627
|
|
|
1628
|
+
/** Defines headers for ManagedHsms_purgeDeleted operation. */
|
|
1629
|
+
export declare interface ManagedHsmsPurgeDeletedHeaders {
|
|
1630
|
+
/** The URI to poll for completion status. */
|
|
1631
|
+
location?: string;
|
|
1632
|
+
}
|
|
1633
|
+
|
|
1141
1634
|
/** Optional parameters. */
|
|
1142
1635
|
export declare interface ManagedHsmsPurgeDeletedOptionalParams extends coreClient.OperationOptions {
|
|
1143
1636
|
/** Delay to wait until next poll, in milliseconds. */
|
|
@@ -1146,6 +1639,15 @@ export declare interface ManagedHsmsPurgeDeletedOptionalParams extends coreClien
|
|
|
1146
1639
|
resumeFrom?: string;
|
|
1147
1640
|
}
|
|
1148
1641
|
|
|
1642
|
+
/** Contains response data for the purgeDeleted operation. */
|
|
1643
|
+
export declare type ManagedHsmsPurgeDeletedResponse = ManagedHsmsPurgeDeletedHeaders;
|
|
1644
|
+
|
|
1645
|
+
/** Defines headers for ManagedHsms_update operation. */
|
|
1646
|
+
export declare interface ManagedHsmsUpdateHeaders {
|
|
1647
|
+
/** The URI to poll for completion status. */
|
|
1648
|
+
location?: string;
|
|
1649
|
+
}
|
|
1650
|
+
|
|
1149
1651
|
/** Optional parameters. */
|
|
1150
1652
|
export declare interface ManagedHsmsUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1151
1653
|
/** Delay to wait until next poll, in milliseconds. */
|
|
@@ -1157,6 +1659,13 @@ export declare interface ManagedHsmsUpdateOptionalParams extends coreClient.Oper
|
|
|
1157
1659
|
/** Contains response data for the update operation. */
|
|
1158
1660
|
export declare type ManagedHsmsUpdateResponse = ManagedHsm;
|
|
1159
1661
|
|
|
1662
|
+
export declare interface ManagedHsmTrigger {
|
|
1663
|
+
/** The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. */
|
|
1664
|
+
timeAfterCreate?: string;
|
|
1665
|
+
/** The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. */
|
|
1666
|
+
timeBeforeExpiry?: string;
|
|
1667
|
+
}
|
|
1668
|
+
|
|
1160
1669
|
/** Metric specification of operation. */
|
|
1161
1670
|
export declare interface MetricSpecification {
|
|
1162
1671
|
/** Name of metric specification. */
|
|
@@ -1183,7 +1692,20 @@ export declare interface MetricSpecification {
|
|
|
1183
1692
|
internalMetricName?: string;
|
|
1184
1693
|
}
|
|
1185
1694
|
|
|
1186
|
-
/** A
|
|
1695
|
+
/** A region that this managed HSM Pool has been extended to. */
|
|
1696
|
+
export declare interface MhsmGeoReplicatedRegion {
|
|
1697
|
+
/** Name of the geo replicated region. */
|
|
1698
|
+
name?: string;
|
|
1699
|
+
/**
|
|
1700
|
+
* Provisioning state of the geo replicated region.
|
|
1701
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1702
|
+
*/
|
|
1703
|
+
readonly provisioningState?: GeoReplicationRegionProvisioningState;
|
|
1704
|
+
/** A boolean value that indicates whether the region is the primary region or a secondary region. */
|
|
1705
|
+
isPrimary?: boolean;
|
|
1706
|
+
}
|
|
1707
|
+
|
|
1708
|
+
/** A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range. */
|
|
1187
1709
|
export declare interface MhsmipRule {
|
|
1188
1710
|
/** An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). */
|
|
1189
1711
|
value: string;
|
|
@@ -1211,7 +1733,7 @@ export declare interface MhsmPrivateEndpoint {
|
|
|
1211
1733
|
}
|
|
1212
1734
|
|
|
1213
1735
|
/** Private endpoint connection resource. */
|
|
1214
|
-
export declare
|
|
1736
|
+
export declare interface MhsmPrivateEndpointConnection extends ManagedHsmResource {
|
|
1215
1737
|
/** Modified whenever there is a change in the state of private endpoint connection. */
|
|
1216
1738
|
etag?: string;
|
|
1217
1739
|
/** Properties of the private endpoint object. */
|
|
@@ -1220,10 +1742,14 @@ export declare type MhsmPrivateEndpointConnection = ManagedHsmResource & {
|
|
|
1220
1742
|
privateLinkServiceConnectionState?: MhsmPrivateLinkServiceConnectionState;
|
|
1221
1743
|
/** Provisioning state of the private endpoint connection. */
|
|
1222
1744
|
provisioningState?: PrivateEndpointConnectionProvisioningState;
|
|
1223
|
-
}
|
|
1745
|
+
}
|
|
1224
1746
|
|
|
1225
1747
|
/** Private endpoint connection item. */
|
|
1226
1748
|
export declare interface MhsmPrivateEndpointConnectionItem {
|
|
1749
|
+
/** Id of private endpoint connection. */
|
|
1750
|
+
id?: string;
|
|
1751
|
+
/** Modified whenever there is a change in the state of private endpoint connection. */
|
|
1752
|
+
etag?: string;
|
|
1227
1753
|
/** Properties of the private endpoint object. */
|
|
1228
1754
|
privateEndpoint?: MhsmPrivateEndpoint;
|
|
1229
1755
|
/** Approval state of the private link connection. */
|
|
@@ -1269,7 +1795,7 @@ export declare interface MhsmPrivateEndpointConnections {
|
|
|
1269
1795
|
* managed hsm pool.
|
|
1270
1796
|
* @param options The options parameters.
|
|
1271
1797
|
*/
|
|
1272
|
-
beginDelete(resourceGroupName: string, name: string, privateEndpointConnectionName: string, options?: MhsmPrivateEndpointConnectionsDeleteOptionalParams): Promise<
|
|
1798
|
+
beginDelete(resourceGroupName: string, name: string, privateEndpointConnectionName: string, options?: MhsmPrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<MhsmPrivateEndpointConnectionsDeleteResponse>, MhsmPrivateEndpointConnectionsDeleteResponse>>;
|
|
1273
1799
|
/**
|
|
1274
1800
|
* Deletes the specified private endpoint connection associated with the managed hsm pool.
|
|
1275
1801
|
* @param resourceGroupName Name of the resource group that contains the managed HSM pool.
|
|
@@ -1283,8 +1809,6 @@ export declare interface MhsmPrivateEndpointConnections {
|
|
|
1283
1809
|
|
|
1284
1810
|
/** Defines headers for MhsmPrivateEndpointConnections_delete operation. */
|
|
1285
1811
|
export declare interface MhsmPrivateEndpointConnectionsDeleteHeaders {
|
|
1286
|
-
/** The recommended number of seconds to wait before calling the URI specified in the location header. */
|
|
1287
|
-
retryAfter?: number;
|
|
1288
1812
|
/** The URI to poll for completion status. */
|
|
1289
1813
|
location?: string;
|
|
1290
1814
|
}
|
|
@@ -1345,7 +1869,7 @@ export declare interface MhsmPrivateEndpointConnectionsPutOptionalParams extends
|
|
|
1345
1869
|
export declare type MhsmPrivateEndpointConnectionsPutResponse = MhsmPrivateEndpointConnectionsPutHeaders & MhsmPrivateEndpointConnection;
|
|
1346
1870
|
|
|
1347
1871
|
/** A private link resource */
|
|
1348
|
-
export declare
|
|
1872
|
+
export declare interface MhsmPrivateLinkResource extends ManagedHsmResource {
|
|
1349
1873
|
/**
|
|
1350
1874
|
* Group identifier of private link resource.
|
|
1351
1875
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1358,7 +1882,7 @@ export declare type MhsmPrivateLinkResource = ManagedHsmResource & {
|
|
|
1358
1882
|
readonly requiredMembers?: string[];
|
|
1359
1883
|
/** Required DNS zone names of the the private link resource. */
|
|
1360
1884
|
requiredZoneNames?: string[];
|
|
1361
|
-
}
|
|
1885
|
+
}
|
|
1362
1886
|
|
|
1363
1887
|
/** A list of private link resources */
|
|
1364
1888
|
export declare interface MhsmPrivateLinkResourceListResult {
|
|
@@ -1394,6 +1918,39 @@ export declare interface MhsmPrivateLinkServiceConnectionState {
|
|
|
1394
1918
|
actionsRequired?: ActionsRequired;
|
|
1395
1919
|
}
|
|
1396
1920
|
|
|
1921
|
+
/** Interface representing a MhsmRegions. */
|
|
1922
|
+
export declare interface MhsmRegions {
|
|
1923
|
+
/**
|
|
1924
|
+
* The List operation gets information about the regions associated with the managed HSM Pool.
|
|
1925
|
+
* @param resourceGroupName Name of the resource group that contains the managed HSM pool.
|
|
1926
|
+
* @param name Name of the managed HSM Pool
|
|
1927
|
+
* @param options The options parameters.
|
|
1928
|
+
*/
|
|
1929
|
+
listByResource(resourceGroupName: string, name: string, options?: MhsmRegionsListByResourceOptionalParams): PagedAsyncIterableIterator<MhsmGeoReplicatedRegion>;
|
|
1930
|
+
}
|
|
1931
|
+
|
|
1932
|
+
/** Optional parameters. */
|
|
1933
|
+
export declare interface MhsmRegionsListByResourceNextOptionalParams extends coreClient.OperationOptions {
|
|
1934
|
+
}
|
|
1935
|
+
|
|
1936
|
+
/** Contains response data for the listByResourceNext operation. */
|
|
1937
|
+
export declare type MhsmRegionsListByResourceNextResponse = MhsmRegionsListResult;
|
|
1938
|
+
|
|
1939
|
+
/** Optional parameters. */
|
|
1940
|
+
export declare interface MhsmRegionsListByResourceOptionalParams extends coreClient.OperationOptions {
|
|
1941
|
+
}
|
|
1942
|
+
|
|
1943
|
+
/** Contains response data for the listByResource operation. */
|
|
1944
|
+
export declare type MhsmRegionsListByResourceResponse = MhsmRegionsListResult;
|
|
1945
|
+
|
|
1946
|
+
/** List of regions associated with a managed HSM Pools */
|
|
1947
|
+
export declare interface MhsmRegionsListResult {
|
|
1948
|
+
/** The region associated with a managed HSM Pools. */
|
|
1949
|
+
value?: MhsmGeoReplicatedRegion[];
|
|
1950
|
+
/** The URL to get the next set of managed HSM Pools. */
|
|
1951
|
+
nextLink?: string;
|
|
1952
|
+
}
|
|
1953
|
+
|
|
1397
1954
|
/** A rule governing the accessibility of a managed hsm pool from a specific virtual network. */
|
|
1398
1955
|
export declare interface MhsmVirtualNetworkRule {
|
|
1399
1956
|
/** Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. */
|
|
@@ -1512,7 +2069,7 @@ export declare interface PrivateEndpoint {
|
|
|
1512
2069
|
}
|
|
1513
2070
|
|
|
1514
2071
|
/** Private endpoint connection resource. */
|
|
1515
|
-
export declare
|
|
2072
|
+
export declare interface PrivateEndpointConnection extends Resource {
|
|
1516
2073
|
/** Modified whenever there is a change in the state of private endpoint connection. */
|
|
1517
2074
|
etag?: string;
|
|
1518
2075
|
/** Properties of the private endpoint object. */
|
|
@@ -1521,7 +2078,7 @@ export declare type PrivateEndpointConnection = Resource & {
|
|
|
1521
2078
|
privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
|
|
1522
2079
|
/** Provisioning state of the private endpoint connection. */
|
|
1523
2080
|
provisioningState?: PrivateEndpointConnectionProvisioningState;
|
|
1524
|
-
}
|
|
2081
|
+
}
|
|
1525
2082
|
|
|
1526
2083
|
/** Private endpoint connection item. */
|
|
1527
2084
|
export declare interface PrivateEndpointConnectionItem {
|
|
@@ -1596,7 +2153,7 @@ export declare interface PrivateEndpointConnections {
|
|
|
1596
2153
|
* vault.
|
|
1597
2154
|
* @param options The options parameters.
|
|
1598
2155
|
*/
|
|
1599
|
-
beginDelete(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<
|
|
2156
|
+
beginDelete(resourceGroupName: string, vaultName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<PrivateEndpointConnectionsDeleteResponse>, PrivateEndpointConnectionsDeleteResponse>>;
|
|
1600
2157
|
/**
|
|
1601
2158
|
* Deletes the specified private endpoint connection associated with the key vault.
|
|
1602
2159
|
* @param resourceGroupName Name of the resource group that contains the key vault.
|
|
@@ -1676,7 +2233,7 @@ export declare type PrivateEndpointConnectionsPutResponse = PrivateEndpointConne
|
|
|
1676
2233
|
export declare type PrivateEndpointServiceConnectionStatus = string;
|
|
1677
2234
|
|
|
1678
2235
|
/** A private link resource */
|
|
1679
|
-
export declare
|
|
2236
|
+
export declare interface PrivateLinkResource extends Resource {
|
|
1680
2237
|
/**
|
|
1681
2238
|
* Group identifier of private link resource.
|
|
1682
2239
|
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
@@ -1689,7 +2246,7 @@ export declare type PrivateLinkResource = Resource & {
|
|
|
1689
2246
|
readonly requiredMembers?: string[];
|
|
1690
2247
|
/** Required DNS zone names of the the private link resource. */
|
|
1691
2248
|
requiredZoneNames?: string[];
|
|
1692
|
-
}
|
|
2249
|
+
}
|
|
1693
2250
|
|
|
1694
2251
|
/** A list of private link resources */
|
|
1695
2252
|
export declare interface PrivateLinkResourceListResult {
|
|
@@ -1741,6 +2298,29 @@ export declare interface PrivateLinkServiceConnectionState {
|
|
|
1741
2298
|
*/
|
|
1742
2299
|
export declare type ProvisioningState = string;
|
|
1743
2300
|
|
|
2301
|
+
/** Common fields that are returned in the response for all Azure Resource Manager resources */
|
|
2302
|
+
export declare interface ProxyResourceWithoutSystemData {
|
|
2303
|
+
/**
|
|
2304
|
+
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
2305
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2306
|
+
*/
|
|
2307
|
+
readonly id?: string;
|
|
2308
|
+
/**
|
|
2309
|
+
* The name of the resource
|
|
2310
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2311
|
+
*/
|
|
2312
|
+
readonly name?: string;
|
|
2313
|
+
/**
|
|
2314
|
+
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
|
|
2315
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2316
|
+
*/
|
|
2317
|
+
readonly type?: string;
|
|
2318
|
+
/** Resource tags. */
|
|
2319
|
+
tags?: {
|
|
2320
|
+
[propertyName: string]: string;
|
|
2321
|
+
};
|
|
2322
|
+
}
|
|
2323
|
+
|
|
1744
2324
|
/**
|
|
1745
2325
|
* Defines values for PublicNetworkAccess. \
|
|
1746
2326
|
* {@link KnownPublicNetworkAccess} can be used interchangeably with PublicNetworkAccess,
|
|
@@ -1801,13 +2381,14 @@ export declare interface RotationPolicy {
|
|
|
1801
2381
|
}
|
|
1802
2382
|
|
|
1803
2383
|
/** Resource information with extended details. */
|
|
1804
|
-
export declare
|
|
2384
|
+
export declare interface Secret extends Resource {
|
|
1805
2385
|
/** Properties of the secret */
|
|
1806
2386
|
properties: SecretProperties;
|
|
1807
|
-
}
|
|
2387
|
+
}
|
|
1808
2388
|
|
|
1809
2389
|
/** The secret management attributes. */
|
|
1810
|
-
export declare
|
|
2390
|
+
export declare interface SecretAttributes extends Attributes {
|
|
2391
|
+
}
|
|
1811
2392
|
|
|
1812
2393
|
/** Parameters for creating or updating a secret */
|
|
1813
2394
|
export declare interface SecretCreateOrUpdateParameters {
|
|
@@ -1901,7 +2482,9 @@ export declare interface Secrets {
|
|
|
1901
2482
|
* with vault secrets.
|
|
1902
2483
|
* @param resourceGroupName The name of the Resource Group to which the vault belongs.
|
|
1903
2484
|
* @param vaultName Name of the vault
|
|
1904
|
-
* @param secretName Name of the secret
|
|
2485
|
+
* @param secretName Name of the secret. The value you provide may be copied globally for the purpose
|
|
2486
|
+
* of running the service. The value provided should not include personally identifiable or sensitive
|
|
2487
|
+
* information.
|
|
1905
2488
|
* @param parameters Parameters to create or update the secret
|
|
1906
2489
|
* @param options The options parameters.
|
|
1907
2490
|
*/
|
|
@@ -1943,8 +2526,6 @@ export declare type SecretsGetResponse = Secret;
|
|
|
1943
2526
|
|
|
1944
2527
|
/** Optional parameters. */
|
|
1945
2528
|
export declare interface SecretsListNextOptionalParams extends coreClient.OperationOptions {
|
|
1946
|
-
/** Maximum number of results to return. */
|
|
1947
|
-
top?: number;
|
|
1948
2529
|
}
|
|
1949
2530
|
|
|
1950
2531
|
/** Contains response data for the listNext operation. */
|
|
@@ -2158,7 +2739,7 @@ export declare interface VaultPatchProperties {
|
|
|
2158
2739
|
enabledForTemplateDeployment?: boolean;
|
|
2159
2740
|
/** Property to specify whether the 'soft delete' functionality is enabled for this key vault. Once set to true, it cannot be reverted to false. */
|
|
2160
2741
|
enableSoftDelete?: boolean;
|
|
2161
|
-
/** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored
|
|
2742
|
+
/** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the value of this property will not change. */
|
|
2162
2743
|
enableRbacAuthorization?: boolean;
|
|
2163
2744
|
/** softDelete data retention days. It accepts >=7 and <=90. */
|
|
2164
2745
|
softDeleteRetentionInDays?: number;
|
|
@@ -2197,7 +2778,7 @@ export declare interface VaultProperties {
|
|
|
2197
2778
|
enableSoftDelete?: boolean;
|
|
2198
2779
|
/** softDelete data retention days. It accepts >=7 and <=90. */
|
|
2199
2780
|
softDeleteRetentionInDays?: number;
|
|
2200
|
-
/** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored
|
|
2781
|
+
/** Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC. */
|
|
2201
2782
|
enableRbacAuthorization?: boolean;
|
|
2202
2783
|
/** The vault's create mode to indicate whether the vault need to be recovered or not. */
|
|
2203
2784
|
createMode?: CreateMode;
|
|
@@ -2257,7 +2838,7 @@ export declare interface Vaults {
|
|
|
2257
2838
|
* @param parameters Parameters to create or update the vault
|
|
2258
2839
|
* @param options The options parameters.
|
|
2259
2840
|
*/
|
|
2260
|
-
beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<
|
|
2841
|
+
beginCreateOrUpdate(resourceGroupName: string, vaultName: string, parameters: VaultCreateOrUpdateParameters, options?: VaultsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VaultsCreateOrUpdateResponse>, VaultsCreateOrUpdateResponse>>;
|
|
2261
2842
|
/**
|
|
2262
2843
|
* Create or update a key vault in the specified subscription.
|
|
2263
2844
|
* @param resourceGroupName The name of the Resource Group to which the server belongs.
|
|
@@ -2310,7 +2891,7 @@ export declare interface Vaults {
|
|
|
2310
2891
|
* @param location The location of the soft-deleted vault.
|
|
2311
2892
|
* @param options The options parameters.
|
|
2312
2893
|
*/
|
|
2313
|
-
beginPurgeDeleted(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<
|
|
2894
|
+
beginPurgeDeleted(vaultName: string, location: string, options?: VaultsPurgeDeletedOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
|
|
2314
2895
|
/**
|
|
2315
2896
|
* Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
|
|
2316
2897
|
* @param vaultName The name of the soft-deleted vault.
|
|
@@ -2364,8 +2945,6 @@ export declare type VaultsGetResponse = Vault;
|
|
|
2364
2945
|
|
|
2365
2946
|
/** Optional parameters. */
|
|
2366
2947
|
export declare interface VaultsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
|
|
2367
|
-
/** Maximum number of results to return. */
|
|
2368
|
-
top?: number;
|
|
2369
2948
|
}
|
|
2370
2949
|
|
|
2371
2950
|
/** Contains response data for the listByResourceGroupNext operation. */
|
|
@@ -2382,8 +2961,6 @@ export declare type VaultsListByResourceGroupResponse = VaultListResult;
|
|
|
2382
2961
|
|
|
2383
2962
|
/** Optional parameters. */
|
|
2384
2963
|
export declare interface VaultsListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
|
|
2385
|
-
/** Maximum number of results to return. */
|
|
2386
|
-
top?: number;
|
|
2387
2964
|
}
|
|
2388
2965
|
|
|
2389
2966
|
/** Contains response data for the listBySubscriptionNext operation. */
|
|
@@ -2414,8 +2991,6 @@ export declare type VaultsListDeletedResponse = DeletedVaultListResult;
|
|
|
2414
2991
|
|
|
2415
2992
|
/** Optional parameters. */
|
|
2416
2993
|
export declare interface VaultsListNextOptionalParams extends coreClient.OperationOptions {
|
|
2417
|
-
/** Maximum number of results to return. */
|
|
2418
|
-
top?: number;
|
|
2419
2994
|
}
|
|
2420
2995
|
|
|
2421
2996
|
/** Contains response data for the listNext operation. */
|