@azure/arm-batch 4.0.0 → 7.0.0-beta.1
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 +14 -0
- package/{LICENSE.txt → LICENSE} +2 -2
- package/README.md +75 -77
- package/dist/index.js +6873 -0
- package/dist/index.js.map +1 -0
- package/dist/index.min.js +1 -0
- package/dist/index.min.js.map +1 -0
- package/dist-esm/src/batchManagementClient.d.ts +24 -0
- package/dist-esm/src/batchManagementClient.d.ts.map +1 -0
- package/dist-esm/src/batchManagementClient.js +31 -0
- package/dist-esm/src/batchManagementClient.js.map +1 -0
- package/dist-esm/src/batchManagementClientContext.d.ts +17 -0
- package/dist-esm/src/batchManagementClientContext.d.ts.map +1 -0
- package/dist-esm/src/batchManagementClientContext.js +50 -0
- package/dist-esm/src/batchManagementClientContext.js.map +1 -0
- package/dist-esm/src/index.d.ts +6 -0
- package/dist-esm/src/index.d.ts.map +1 -0
- package/dist-esm/src/index.js +13 -0
- package/dist-esm/src/index.js.map +1 -0
- package/dist-esm/src/lroImpl.d.ts +16 -0
- package/dist-esm/src/lroImpl.d.ts.map +1 -0
- package/dist-esm/src/lroImpl.js +29 -0
- package/dist-esm/src/lroImpl.js.map +1 -0
- package/dist-esm/src/models/index.d.ts +1780 -0
- package/dist-esm/src/models/index.d.ts.map +1 -0
- package/dist-esm/src/models/index.js +9 -0
- package/dist-esm/src/models/index.js.map +1 -0
- package/dist-esm/src/models/mappers.d.ts +112 -0
- package/dist-esm/src/models/mappers.d.ts.map +1 -0
- package/{esm → dist-esm/src}/models/mappers.js +2357 -1248
- package/dist-esm/src/models/mappers.js.map +1 -0
- package/dist-esm/src/models/parameters.d.ts +34 -0
- package/dist-esm/src/models/parameters.d.ts.map +1 -0
- package/dist-esm/src/models/parameters.js +303 -0
- package/dist-esm/src/models/parameters.js.map +1 -0
- package/dist-esm/src/operations/applicationOperations.d.ts +71 -0
- package/dist-esm/src/operations/applicationOperations.d.ts.map +1 -0
- package/dist-esm/src/operations/applicationOperations.js +269 -0
- package/dist-esm/src/operations/applicationOperations.js.map +1 -0
- package/dist-esm/src/operations/applicationPackageOperations.d.ts +83 -0
- package/dist-esm/src/operations/applicationPackageOperations.d.ts.map +1 -0
- package/dist-esm/src/operations/applicationPackageOperations.js +294 -0
- package/dist-esm/src/operations/applicationPackageOperations.js.map +1 -0
- package/dist-esm/src/operations/batchAccountOperations.d.ts +171 -0
- package/dist-esm/src/operations/batchAccountOperations.d.ts.map +1 -0
- package/dist-esm/src/operations/batchAccountOperations.js +681 -0
- package/dist-esm/src/operations/batchAccountOperations.js.map +1 -0
- package/dist-esm/src/operations/certificateOperations.d.ts +106 -0
- package/dist-esm/src/operations/certificateOperations.d.ts.map +1 -0
- package/dist-esm/src/operations/certificateOperations.js +388 -0
- package/dist-esm/src/operations/certificateOperations.js.map +1 -0
- package/{esm → dist-esm/src}/operations/index.d.ts +2 -0
- package/dist-esm/src/operations/index.d.ts.map +1 -0
- package/dist-esm/src/operations/index.js +17 -0
- package/dist-esm/src/operations/index.js.map +1 -0
- package/dist-esm/src/operations/location.d.ts +71 -0
- package/dist-esm/src/operations/location.d.ts.map +1 -0
- package/dist-esm/src/operations/location.js +316 -0
- package/dist-esm/src/operations/location.js.map +1 -0
- package/dist-esm/src/operations/operations.d.ts +32 -0
- package/dist-esm/src/operations/operations.d.ts.map +1 -0
- package/dist-esm/src/operations/operations.js +120 -0
- package/dist-esm/src/operations/operations.js.map +1 -0
- package/dist-esm/src/operations/poolOperations.d.ts +103 -0
- package/dist-esm/src/operations/poolOperations.d.ts.map +1 -0
- package/dist-esm/src/operations/poolOperations.js +410 -0
- package/dist-esm/src/operations/poolOperations.js.map +1 -0
- package/dist-esm/src/operations/privateEndpointConnectionOperations.d.ts +70 -0
- package/dist-esm/src/operations/privateEndpointConnectionOperations.d.ts.map +1 -0
- package/dist-esm/src/operations/privateEndpointConnectionOperations.js +278 -0
- package/dist-esm/src/operations/privateEndpointConnectionOperations.js.map +1 -0
- package/dist-esm/src/operations/privateLinkResourceOperations.d.ts +47 -0
- package/dist-esm/src/operations/privateLinkResourceOperations.d.ts.map +1 -0
- package/dist-esm/src/operations/privateLinkResourceOperations.js +170 -0
- package/dist-esm/src/operations/privateLinkResourceOperations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/applicationOperations.d.ts +46 -0
- package/dist-esm/src/operationsInterfaces/applicationOperations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/applicationOperations.js +9 -0
- package/dist-esm/src/operationsInterfaces/applicationOperations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/applicationPackageOperations.d.ts +56 -0
- package/dist-esm/src/operationsInterfaces/applicationPackageOperations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/applicationPackageOperations.js +9 -0
- package/dist-esm/src/operationsInterfaces/applicationPackageOperations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/batchAccountOperations.d.ts +112 -0
- package/dist-esm/src/operationsInterfaces/batchAccountOperations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/batchAccountOperations.js +9 -0
- package/dist-esm/src/operationsInterfaces/batchAccountOperations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/certificateOperations.d.ts +81 -0
- package/dist-esm/src/operationsInterfaces/certificateOperations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/certificateOperations.js +9 -0
- package/dist-esm/src/operationsInterfaces/certificateOperations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts +10 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.js +17 -0
- package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/location.d.ts +31 -0
- package/dist-esm/src/operationsInterfaces/location.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/location.js +9 -0
- package/dist-esm/src/operationsInterfaces/location.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
- package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/operations.js +9 -0
- package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/poolOperations.d.ts +78 -0
- package/dist-esm/src/operationsInterfaces/poolOperations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/poolOperations.js +9 -0
- package/dist-esm/src/operationsInterfaces/poolOperations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnectionOperations.d.ts +45 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnectionOperations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnectionOperations.js +9 -0
- package/dist-esm/src/operationsInterfaces/privateEndpointConnectionOperations.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateLinkResourceOperations.d.ts +22 -0
- package/dist-esm/src/operationsInterfaces/privateLinkResourceOperations.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/privateLinkResourceOperations.js +9 -0
- package/dist-esm/src/operationsInterfaces/privateLinkResourceOperations.js.map +1 -0
- package/dist-esm/test/sampleTest.d.ts +4 -0
- package/dist-esm/test/sampleTest.d.ts.map +1 -0
- package/dist-esm/test/sampleTest.js +479 -0
- package/dist-esm/test/sampleTest.js.map +1 -0
- package/package.json +71 -34
- package/review/arm-batch.api.md +1459 -0
- package/rollup.config.js +184 -27
- package/src/batchManagementClient.ts +75 -0
- package/src/batchManagementClientContext.ts +71 -0
- package/src/index.ts +13 -0
- package/src/lroImpl.ts +34 -0
- package/src/models/index.ts +2045 -0
- package/{lib → src}/models/mappers.ts +2413 -1223
- package/src/models/parameters.ts +351 -0
- package/src/operations/applicationOperations.ts +357 -0
- package/src/operations/applicationPackageOperations.ts +410 -0
- package/src/operations/batchAccountOperations.ts +901 -0
- package/src/operations/certificateOperations.ts +527 -0
- package/{lib → src}/operations/index.ts +5 -5
- package/src/operations/location.ts +413 -0
- package/src/operations/operations.ts +137 -0
- package/src/operations/poolOperations.ts +560 -0
- package/src/operations/privateEndpointConnectionOperations.ts +388 -0
- package/src/operations/privateLinkResourceOperations.ts +235 -0
- package/src/operationsInterfaces/applicationOperations.ts +90 -0
- package/src/operationsInterfaces/applicationPackageOperations.ts +106 -0
- package/src/operationsInterfaces/batchAccountOperations.ts +196 -0
- package/src/operationsInterfaces/certificateOperations.ts +139 -0
- package/{esm/operations/index.js → src/operationsInterfaces/index.ts} +6 -6
- package/src/operationsInterfaces/location.ts +62 -0
- package/src/operationsInterfaces/operations.ts +22 -0
- package/src/operationsInterfaces/poolOperations.ts +142 -0
- package/src/operationsInterfaces/privateEndpointConnectionOperations.ts +87 -0
- package/src/operationsInterfaces/privateLinkResourceOperations.ts +45 -0
- package/tsconfig.json +4 -4
- package/types/arm-batch.d.ts +2528 -0
- package/types/tsdoc-metadata.json +11 -0
- package/dist/arm-batch.js +0 -4689
- package/dist/arm-batch.js.map +0 -1
- package/dist/arm-batch.min.js +0 -1
- package/dist/arm-batch.min.js.map +0 -1
- package/esm/batchManagementClient.d.ts +0 -25
- package/esm/batchManagementClient.d.ts.map +0 -1
- package/esm/batchManagementClient.js +0 -40
- package/esm/batchManagementClient.js.map +0 -1
- package/esm/batchManagementClientContext.d.ts +0 -17
- package/esm/batchManagementClientContext.d.ts.map +0 -1
- package/esm/batchManagementClientContext.js +0 -57
- package/esm/batchManagementClientContext.js.map +0 -1
- package/esm/models/applicationOperationsMappers.d.ts +0 -2
- package/esm/models/applicationOperationsMappers.d.ts.map +0 -1
- package/esm/models/applicationOperationsMappers.js +0 -11
- package/esm/models/applicationOperationsMappers.js.map +0 -1
- package/esm/models/applicationPackageOperationsMappers.d.ts +0 -2
- package/esm/models/applicationPackageOperationsMappers.d.ts.map +0 -1
- package/esm/models/applicationPackageOperationsMappers.js +0 -11
- package/esm/models/applicationPackageOperationsMappers.js.map +0 -1
- package/esm/models/batchAccountOperationsMappers.d.ts +0 -2
- package/esm/models/batchAccountOperationsMappers.d.ts.map +0 -1
- package/esm/models/batchAccountOperationsMappers.js +0 -11
- package/esm/models/batchAccountOperationsMappers.js.map +0 -1
- package/esm/models/certificateOperationsMappers.d.ts +0 -2
- package/esm/models/certificateOperationsMappers.d.ts.map +0 -1
- package/esm/models/certificateOperationsMappers.js +0 -11
- package/esm/models/certificateOperationsMappers.js.map +0 -1
- package/esm/models/index.d.ts +0 -3108
- package/esm/models/index.d.ts.map +0 -1
- package/esm/models/index.js +0 -10
- package/esm/models/index.js.map +0 -1
- package/esm/models/locationMappers.d.ts +0 -2
- package/esm/models/locationMappers.d.ts.map +0 -1
- package/esm/models/locationMappers.js +0 -11
- package/esm/models/locationMappers.js.map +0 -1
- package/esm/models/mappers.d.ts +0 -76
- package/esm/models/mappers.d.ts.map +0 -1
- package/esm/models/mappers.js.map +0 -1
- package/esm/models/operationsMappers.d.ts +0 -2
- package/esm/models/operationsMappers.d.ts.map +0 -1
- package/esm/models/operationsMappers.js +0 -11
- package/esm/models/operationsMappers.js.map +0 -1
- package/esm/models/parameters.d.ts +0 -18
- package/esm/models/parameters.d.ts.map +0 -1
- package/esm/models/parameters.js +0 -196
- package/esm/models/parameters.js.map +0 -1
- package/esm/models/poolOperationsMappers.d.ts +0 -2
- package/esm/models/poolOperationsMappers.d.ts.map +0 -1
- package/esm/models/poolOperationsMappers.js +0 -11
- package/esm/models/poolOperationsMappers.js.map +0 -1
- package/esm/operations/applicationOperations.d.ts +0 -151
- package/esm/operations/applicationOperations.d.ts.map +0 -1
- package/esm/operations/applicationOperations.js +0 -226
- package/esm/operations/applicationOperations.js.map +0 -1
- package/esm/operations/applicationPackageOperations.d.ts +0 -124
- package/esm/operations/applicationPackageOperations.d.ts.map +0 -1
- package/esm/operations/applicationPackageOperations.js +0 -171
- package/esm/operations/applicationPackageOperations.js.map +0 -1
- package/esm/operations/batchAccountOperations.d.ts +0 -246
- package/esm/operations/batchAccountOperations.d.ts.map +0 -1
- package/esm/operations/batchAccountOperations.js +0 -426
- package/esm/operations/batchAccountOperations.js.map +0 -1
- package/esm/operations/certificateOperations.d.ts +0 -198
- package/esm/operations/certificateOperations.d.ts.map +0 -1
- package/esm/operations/certificateOperations.js +0 -326
- package/esm/operations/certificateOperations.js.map +0 -1
- package/esm/operations/index.d.ts.map +0 -1
- package/esm/operations/index.js.map +0 -1
- package/esm/operations/location.d.ts +0 -52
- package/esm/operations/location.d.ts.map +0 -1
- package/esm/operations/location.js +0 -93
- package/esm/operations/location.js.map +0 -1
- package/esm/operations/operations.d.ts +0 -46
- package/esm/operations/operations.d.ts.map +0 -1
- package/esm/operations/operations.js +0 -77
- package/esm/operations/operations.js.map +0 -1
- package/esm/operations/poolOperations.d.ts +0 -199
- package/esm/operations/poolOperations.d.ts.map +0 -1
- package/esm/operations/poolOperations.js +0 -352
- package/esm/operations/poolOperations.js.map +0 -1
- package/lib/batchManagementClient.ts +0 -55
- package/lib/batchManagementClientContext.ts +0 -63
- package/lib/models/applicationOperationsMappers.ts +0 -19
- package/lib/models/applicationPackageOperationsMappers.ts +0 -16
- package/lib/models/batchAccountOperationsMappers.ts +0 -61
- package/lib/models/certificateOperationsMappers.ts +0 -60
- package/lib/models/index.ts +0 -3252
- package/lib/models/locationMappers.ts +0 -17
- package/lib/models/operationsMappers.ts +0 -17
- package/lib/models/parameters.ts +0 -198
- package/lib/models/poolOperationsMappers.ts +0 -61
- package/lib/operations/applicationOperations.ts +0 -399
- package/lib/operations/applicationPackageOperations.ts +0 -307
- package/lib/operations/batchAccountOperations.ts +0 -683
- package/lib/operations/certificateOperations.ts +0 -510
- package/lib/operations/location.ts +0 -147
- package/lib/operations/operations.ts +0 -123
- package/lib/operations/poolOperations.ts +0 -550
|
@@ -0,0 +1,1780 @@
|
|
|
1
|
+
import * as coreClient from "@azure/core-client";
|
|
2
|
+
/** Parameters supplied to the Create operation. */
|
|
3
|
+
export interface BatchAccountCreateParameters {
|
|
4
|
+
/** The region in which to create the account. */
|
|
5
|
+
location: string;
|
|
6
|
+
/** The user-specified tags associated with the account. */
|
|
7
|
+
tags?: {
|
|
8
|
+
[propertyName: string]: string;
|
|
9
|
+
};
|
|
10
|
+
/** The identity of the Batch account. */
|
|
11
|
+
identity?: BatchAccountIdentity;
|
|
12
|
+
/** The properties related to the auto-storage account. */
|
|
13
|
+
autoStorage?: AutoStorageBaseProperties;
|
|
14
|
+
/** The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. */
|
|
15
|
+
poolAllocationMode?: PoolAllocationMode;
|
|
16
|
+
/** A reference to the Azure key vault associated with the Batch account. */
|
|
17
|
+
keyVaultReference?: KeyVaultReference;
|
|
18
|
+
/** If not specified, the default value is 'enabled'. */
|
|
19
|
+
publicNetworkAccess?: PublicNetworkAccessType;
|
|
20
|
+
/** Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. */
|
|
21
|
+
encryption?: EncryptionProperties;
|
|
22
|
+
/** List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. */
|
|
23
|
+
allowedAuthenticationModes?: AuthenticationMode[];
|
|
24
|
+
}
|
|
25
|
+
/** The properties related to the auto-storage account. */
|
|
26
|
+
export interface AutoStorageBaseProperties {
|
|
27
|
+
/** The resource ID of the storage account to be used for auto-storage account. */
|
|
28
|
+
storageAccountId: string;
|
|
29
|
+
/** The authentication mode which the Batch service will use to manage the auto-storage account. */
|
|
30
|
+
authenticationMode?: AutoStorageAuthenticationMode;
|
|
31
|
+
/** The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage. */
|
|
32
|
+
nodeIdentityReference?: ComputeNodeIdentityReference;
|
|
33
|
+
}
|
|
34
|
+
/** The reference to a user assigned identity associated with the Batch pool which a compute node will use. */
|
|
35
|
+
export interface ComputeNodeIdentityReference {
|
|
36
|
+
/** The ARM resource id of the user assigned identity. */
|
|
37
|
+
resourceId?: string;
|
|
38
|
+
}
|
|
39
|
+
/** Identifies the Azure key vault associated with a Batch account. */
|
|
40
|
+
export interface KeyVaultReference {
|
|
41
|
+
/** The resource ID of the Azure key vault associated with the Batch account. */
|
|
42
|
+
id: string;
|
|
43
|
+
/** The URL of the Azure key vault associated with the Batch account. */
|
|
44
|
+
url: string;
|
|
45
|
+
}
|
|
46
|
+
/** Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. */
|
|
47
|
+
export interface EncryptionProperties {
|
|
48
|
+
/** Type of the key source. */
|
|
49
|
+
keySource?: KeySource;
|
|
50
|
+
/** Additional details when using Microsoft.KeyVault */
|
|
51
|
+
keyVaultProperties?: KeyVaultProperties;
|
|
52
|
+
}
|
|
53
|
+
/** KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. */
|
|
54
|
+
export interface KeyVaultProperties {
|
|
55
|
+
/**
|
|
56
|
+
* Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met:
|
|
57
|
+
*
|
|
58
|
+
* The Batch Account has a System Assigned identity
|
|
59
|
+
* The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions
|
|
60
|
+
* The KeyVault has soft-delete and purge protection enabled
|
|
61
|
+
*/
|
|
62
|
+
keyIdentifier?: string;
|
|
63
|
+
}
|
|
64
|
+
/** The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity` is selected as the auto-storage authentication mode. */
|
|
65
|
+
export interface BatchAccountIdentity {
|
|
66
|
+
/**
|
|
67
|
+
* The principal id of the Batch account. This property will only be provided for a system assigned identity.
|
|
68
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
69
|
+
*/
|
|
70
|
+
readonly principalId?: string;
|
|
71
|
+
/**
|
|
72
|
+
* The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.
|
|
73
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
74
|
+
*/
|
|
75
|
+
readonly tenantId?: string;
|
|
76
|
+
/** The type of identity used for the Batch account. */
|
|
77
|
+
type: ResourceIdentityType;
|
|
78
|
+
/** The list of user identities associated with the Batch account. */
|
|
79
|
+
userAssignedIdentities?: {
|
|
80
|
+
[propertyName: string]: UserAssignedIdentities;
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
/** The list of associated user identities. */
|
|
84
|
+
export interface UserAssignedIdentities {
|
|
85
|
+
/**
|
|
86
|
+
* The principal id of user assigned identity.
|
|
87
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
88
|
+
*/
|
|
89
|
+
readonly principalId?: string;
|
|
90
|
+
/**
|
|
91
|
+
* The client id of user assigned identity.
|
|
92
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
93
|
+
*/
|
|
94
|
+
readonly clientId?: string;
|
|
95
|
+
}
|
|
96
|
+
/** The private endpoint of the private endpoint connection. */
|
|
97
|
+
export interface PrivateEndpoint {
|
|
98
|
+
/**
|
|
99
|
+
* The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.
|
|
100
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
101
|
+
*/
|
|
102
|
+
readonly id?: string;
|
|
103
|
+
}
|
|
104
|
+
/** The private link service connection state of the private endpoint connection */
|
|
105
|
+
export interface PrivateLinkServiceConnectionState {
|
|
106
|
+
/** The status of the Batch private endpoint connection */
|
|
107
|
+
status: PrivateLinkServiceConnectionStatus;
|
|
108
|
+
/** Description of the private Connection state */
|
|
109
|
+
description?: string;
|
|
110
|
+
/**
|
|
111
|
+
* Action required on the private connection state
|
|
112
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
113
|
+
*/
|
|
114
|
+
readonly actionRequired?: string;
|
|
115
|
+
}
|
|
116
|
+
/** A definition of an Azure resource. */
|
|
117
|
+
export interface ProxyResource {
|
|
118
|
+
/**
|
|
119
|
+
* The ID of the resource.
|
|
120
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
121
|
+
*/
|
|
122
|
+
readonly id?: string;
|
|
123
|
+
/**
|
|
124
|
+
* The name of the resource.
|
|
125
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
126
|
+
*/
|
|
127
|
+
readonly name?: string;
|
|
128
|
+
/**
|
|
129
|
+
* The type of the resource.
|
|
130
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
131
|
+
*/
|
|
132
|
+
readonly type?: string;
|
|
133
|
+
/**
|
|
134
|
+
* The ETag of the resource, used for concurrency statements.
|
|
135
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
136
|
+
*/
|
|
137
|
+
readonly etag?: string;
|
|
138
|
+
}
|
|
139
|
+
/** A VM Family and its associated core quota for the Batch account. */
|
|
140
|
+
export interface VirtualMachineFamilyCoreQuota {
|
|
141
|
+
/**
|
|
142
|
+
* The Virtual Machine family name.
|
|
143
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
144
|
+
*/
|
|
145
|
+
readonly name?: string;
|
|
146
|
+
/**
|
|
147
|
+
* The core quota for the VM family for the Batch account.
|
|
148
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
149
|
+
*/
|
|
150
|
+
readonly coreQuota?: number;
|
|
151
|
+
}
|
|
152
|
+
/** A definition of an Azure resource. */
|
|
153
|
+
export interface Resource {
|
|
154
|
+
/**
|
|
155
|
+
* The ID of the resource.
|
|
156
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
157
|
+
*/
|
|
158
|
+
readonly id?: string;
|
|
159
|
+
/**
|
|
160
|
+
* The name of the resource.
|
|
161
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
162
|
+
*/
|
|
163
|
+
readonly name?: string;
|
|
164
|
+
/**
|
|
165
|
+
* The type of the resource.
|
|
166
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
167
|
+
*/
|
|
168
|
+
readonly type?: string;
|
|
169
|
+
/**
|
|
170
|
+
* The location of the resource.
|
|
171
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
172
|
+
*/
|
|
173
|
+
readonly location?: string;
|
|
174
|
+
/**
|
|
175
|
+
* The tags of the resource.
|
|
176
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
177
|
+
*/
|
|
178
|
+
readonly tags?: {
|
|
179
|
+
[propertyName: string]: string;
|
|
180
|
+
};
|
|
181
|
+
}
|
|
182
|
+
/** An error response from the Batch service. */
|
|
183
|
+
export interface CloudError {
|
|
184
|
+
/** The body of the error response. */
|
|
185
|
+
error?: CloudErrorBody;
|
|
186
|
+
}
|
|
187
|
+
/** An error response from the Batch service. */
|
|
188
|
+
export interface CloudErrorBody {
|
|
189
|
+
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
|
|
190
|
+
code?: string;
|
|
191
|
+
/** A message describing the error, intended to be suitable for display in a user interface. */
|
|
192
|
+
message?: string;
|
|
193
|
+
/** The target of the particular error. For example, the name of the property in error. */
|
|
194
|
+
target?: string;
|
|
195
|
+
/** A list of additional details about the error. */
|
|
196
|
+
details?: CloudErrorBody[];
|
|
197
|
+
}
|
|
198
|
+
/** Parameters for updating an Azure Batch account. */
|
|
199
|
+
export interface BatchAccountUpdateParameters {
|
|
200
|
+
/** The user-specified tags associated with the account. */
|
|
201
|
+
tags?: {
|
|
202
|
+
[propertyName: string]: string;
|
|
203
|
+
};
|
|
204
|
+
/** The identity of the Batch account. */
|
|
205
|
+
identity?: BatchAccountIdentity;
|
|
206
|
+
/** The properties related to the auto-storage account. */
|
|
207
|
+
autoStorage?: AutoStorageBaseProperties;
|
|
208
|
+
/** Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. */
|
|
209
|
+
encryption?: EncryptionProperties;
|
|
210
|
+
/** List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. */
|
|
211
|
+
allowedAuthenticationModes?: AuthenticationMode[];
|
|
212
|
+
}
|
|
213
|
+
/** Values returned by the List operation. */
|
|
214
|
+
export interface BatchAccountListResult {
|
|
215
|
+
/** The collection of Batch accounts returned by the listing operation. */
|
|
216
|
+
value?: BatchAccount[];
|
|
217
|
+
/** The continuation token. */
|
|
218
|
+
nextLink?: string;
|
|
219
|
+
}
|
|
220
|
+
/** Parameters supplied to the RegenerateKey operation. */
|
|
221
|
+
export interface BatchAccountRegenerateKeyParameters {
|
|
222
|
+
/** The type of account key to regenerate. */
|
|
223
|
+
keyName: AccountKeyType;
|
|
224
|
+
}
|
|
225
|
+
/** A set of Azure Batch account keys. */
|
|
226
|
+
export interface BatchAccountKeys {
|
|
227
|
+
/**
|
|
228
|
+
* The Batch account name.
|
|
229
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
230
|
+
*/
|
|
231
|
+
readonly accountName?: string;
|
|
232
|
+
/**
|
|
233
|
+
* The primary key associated with the account.
|
|
234
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
235
|
+
*/
|
|
236
|
+
readonly primary?: string;
|
|
237
|
+
/**
|
|
238
|
+
* The secondary key associated with the account.
|
|
239
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
240
|
+
*/
|
|
241
|
+
readonly secondary?: string;
|
|
242
|
+
}
|
|
243
|
+
/** Parameters for an activating an application package. */
|
|
244
|
+
export interface ActivateApplicationPackageParameters {
|
|
245
|
+
/** The format of the application package binary file. */
|
|
246
|
+
format: string;
|
|
247
|
+
}
|
|
248
|
+
/** The result of performing list applications. */
|
|
249
|
+
export interface ListApplicationsResult {
|
|
250
|
+
/** The list of applications. */
|
|
251
|
+
value?: Application[];
|
|
252
|
+
/** The URL to get the next set of results. */
|
|
253
|
+
nextLink?: string;
|
|
254
|
+
}
|
|
255
|
+
/** The result of performing list application packages. */
|
|
256
|
+
export interface ListApplicationPackagesResult {
|
|
257
|
+
/** The list of application packages. */
|
|
258
|
+
value?: ApplicationPackage[];
|
|
259
|
+
/** The URL to get the next set of results. */
|
|
260
|
+
nextLink?: string;
|
|
261
|
+
}
|
|
262
|
+
/** Quotas associated with a Batch region for a particular subscription. */
|
|
263
|
+
export interface BatchLocationQuota {
|
|
264
|
+
/**
|
|
265
|
+
* The number of Batch accounts that may be created under the subscription in the specified region.
|
|
266
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
267
|
+
*/
|
|
268
|
+
readonly accountQuota?: number;
|
|
269
|
+
}
|
|
270
|
+
/** The Batch List supported SKUs operation response. */
|
|
271
|
+
export interface SupportedSkusResult {
|
|
272
|
+
/** The list of SKUs available for the Batch service in the location. */
|
|
273
|
+
value: SupportedSku[];
|
|
274
|
+
/**
|
|
275
|
+
* The URL to use for getting the next set of results.
|
|
276
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
277
|
+
*/
|
|
278
|
+
readonly nextLink?: string;
|
|
279
|
+
}
|
|
280
|
+
/** Describes a Batch supported SKU. */
|
|
281
|
+
export interface SupportedSku {
|
|
282
|
+
/**
|
|
283
|
+
* The name of the SKU.
|
|
284
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
285
|
+
*/
|
|
286
|
+
readonly name?: string;
|
|
287
|
+
/**
|
|
288
|
+
* The family name of the SKU.
|
|
289
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
290
|
+
*/
|
|
291
|
+
readonly familyName?: string;
|
|
292
|
+
/**
|
|
293
|
+
* A collection of capabilities which this SKU supports.
|
|
294
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
295
|
+
*/
|
|
296
|
+
readonly capabilities?: SkuCapability[];
|
|
297
|
+
}
|
|
298
|
+
/** A SKU capability, such as the number of cores. */
|
|
299
|
+
export interface SkuCapability {
|
|
300
|
+
/**
|
|
301
|
+
* The name of the feature.
|
|
302
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
303
|
+
*/
|
|
304
|
+
readonly name?: string;
|
|
305
|
+
/**
|
|
306
|
+
* The value of the feature.
|
|
307
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
308
|
+
*/
|
|
309
|
+
readonly value?: string;
|
|
310
|
+
}
|
|
311
|
+
/** Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results. */
|
|
312
|
+
export interface OperationListResult {
|
|
313
|
+
/** The list of operations supported by the resource provider. */
|
|
314
|
+
value?: Operation[];
|
|
315
|
+
/** The URL to get the next set of operation list results if there are any. */
|
|
316
|
+
nextLink?: string;
|
|
317
|
+
}
|
|
318
|
+
/** A REST API operation */
|
|
319
|
+
export interface Operation {
|
|
320
|
+
/** This is of the format {provider}/{resource}/{operation} */
|
|
321
|
+
name?: string;
|
|
322
|
+
/** Indicates whether the operation is a data action */
|
|
323
|
+
isDataAction?: boolean;
|
|
324
|
+
/** The object that describes the operation. */
|
|
325
|
+
display?: OperationDisplay;
|
|
326
|
+
/** The intended executor of the operation. */
|
|
327
|
+
origin?: string;
|
|
328
|
+
/** Any object */
|
|
329
|
+
properties?: Record<string, unknown>;
|
|
330
|
+
}
|
|
331
|
+
/** The object that describes the operation. */
|
|
332
|
+
export interface OperationDisplay {
|
|
333
|
+
/** Friendly name of the resource provider. */
|
|
334
|
+
provider?: string;
|
|
335
|
+
/** For example: read, write, delete, or listKeys/action */
|
|
336
|
+
operation?: string;
|
|
337
|
+
/** The resource type on which the operation is performed. */
|
|
338
|
+
resource?: string;
|
|
339
|
+
/** The friendly name of the operation */
|
|
340
|
+
description?: string;
|
|
341
|
+
}
|
|
342
|
+
/** Parameters for a check name availability request. */
|
|
343
|
+
export interface CheckNameAvailabilityParameters {
|
|
344
|
+
/** The name to check for availability */
|
|
345
|
+
name: string;
|
|
346
|
+
/** The resource type. */
|
|
347
|
+
type: "Microsoft.Batch/batchAccounts";
|
|
348
|
+
}
|
|
349
|
+
/** The CheckNameAvailability operation response. */
|
|
350
|
+
export interface CheckNameAvailabilityResult {
|
|
351
|
+
/**
|
|
352
|
+
* Gets 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 invalid and cannot be used.
|
|
353
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
354
|
+
*/
|
|
355
|
+
readonly nameAvailable?: boolean;
|
|
356
|
+
/**
|
|
357
|
+
* Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.
|
|
358
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
359
|
+
*/
|
|
360
|
+
readonly reason?: NameAvailabilityReason;
|
|
361
|
+
/**
|
|
362
|
+
* Gets an error message explaining the Reason value in more detail.
|
|
363
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
364
|
+
*/
|
|
365
|
+
readonly message?: string;
|
|
366
|
+
}
|
|
367
|
+
/** Values returned by the List operation. */
|
|
368
|
+
export interface ListCertificatesResult {
|
|
369
|
+
/** The collection of returned certificates. */
|
|
370
|
+
value?: Certificate[];
|
|
371
|
+
/** The continuation token. */
|
|
372
|
+
nextLink?: string;
|
|
373
|
+
}
|
|
374
|
+
/** An error response from the Batch service. */
|
|
375
|
+
export interface DeleteCertificateError {
|
|
376
|
+
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
|
|
377
|
+
code: string;
|
|
378
|
+
/** A message describing the error, intended to be suitable for display in a user interface. */
|
|
379
|
+
message: string;
|
|
380
|
+
/** The target of the particular error. For example, the name of the property in error. */
|
|
381
|
+
target?: string;
|
|
382
|
+
/** A list of additional details about the error. */
|
|
383
|
+
details?: DeleteCertificateError[];
|
|
384
|
+
}
|
|
385
|
+
/** Base certificate properties. */
|
|
386
|
+
export interface CertificateBaseProperties {
|
|
387
|
+
/** This must match the first portion of the certificate name. Currently required to be 'SHA1'. */
|
|
388
|
+
thumbprintAlgorithm?: string;
|
|
389
|
+
/** This must match the thumbprint from the name. */
|
|
390
|
+
thumbprint?: string;
|
|
391
|
+
/** The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. */
|
|
392
|
+
format?: CertificateFormat;
|
|
393
|
+
}
|
|
394
|
+
/** Values returned by the List operation. */
|
|
395
|
+
export interface ListPrivateLinkResourcesResult {
|
|
396
|
+
/** The collection of returned private link resources. */
|
|
397
|
+
value?: PrivateLinkResource[];
|
|
398
|
+
/** The continuation token. */
|
|
399
|
+
nextLink?: string;
|
|
400
|
+
}
|
|
401
|
+
/** Values returned by the List operation. */
|
|
402
|
+
export interface ListPrivateEndpointConnectionsResult {
|
|
403
|
+
/** The collection of returned private endpoint connection. */
|
|
404
|
+
value?: PrivateEndpointConnection[];
|
|
405
|
+
/** The continuation token. */
|
|
406
|
+
nextLink?: string;
|
|
407
|
+
}
|
|
408
|
+
/** Values returned by the List operation. */
|
|
409
|
+
export interface ListPoolsResult {
|
|
410
|
+
/** The collection of returned pools. */
|
|
411
|
+
value?: Pool[];
|
|
412
|
+
/** The continuation token. */
|
|
413
|
+
nextLink?: string;
|
|
414
|
+
}
|
|
415
|
+
/** Deployment configuration properties. */
|
|
416
|
+
export interface DeploymentConfiguration {
|
|
417
|
+
/** This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'. */
|
|
418
|
+
cloudServiceConfiguration?: CloudServiceConfiguration;
|
|
419
|
+
/** This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. */
|
|
420
|
+
virtualMachineConfiguration?: VirtualMachineConfiguration;
|
|
421
|
+
}
|
|
422
|
+
/** The configuration for nodes in a pool based on the Azure Cloud Services platform. */
|
|
423
|
+
export interface CloudServiceConfiguration {
|
|
424
|
+
/** Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. 6 - OS Family 6, equivalent to Windows Server 2019. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases). */
|
|
425
|
+
osFamily: string;
|
|
426
|
+
/** The default value is * which specifies the latest operating system version for the specified OS family. */
|
|
427
|
+
osVersion?: string;
|
|
428
|
+
}
|
|
429
|
+
/** The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. */
|
|
430
|
+
export interface VirtualMachineConfiguration {
|
|
431
|
+
/** A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. */
|
|
432
|
+
imageReference: ImageReference;
|
|
433
|
+
/** The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. */
|
|
434
|
+
nodeAgentSkuId: string;
|
|
435
|
+
/** This property must not be specified if the imageReference specifies a Linux OS image. */
|
|
436
|
+
windowsConfiguration?: WindowsConfiguration;
|
|
437
|
+
/** This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. */
|
|
438
|
+
dataDisks?: DataDisk[];
|
|
439
|
+
/**
|
|
440
|
+
* This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:
|
|
441
|
+
*
|
|
442
|
+
* Windows_Server - The on-premises license is for Windows Server.
|
|
443
|
+
* Windows_Client - The on-premises license is for Windows Client.
|
|
444
|
+
*
|
|
445
|
+
*/
|
|
446
|
+
licenseType?: string;
|
|
447
|
+
/** If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. */
|
|
448
|
+
containerConfiguration?: ContainerConfiguration;
|
|
449
|
+
/** If specified, encryption is performed on each node in the pool during node provisioning. */
|
|
450
|
+
diskEncryptionConfiguration?: DiskEncryptionConfiguration;
|
|
451
|
+
/** This configuration will specify rules on how nodes in the pool will be physically allocated. */
|
|
452
|
+
nodePlacementConfiguration?: NodePlacementConfiguration;
|
|
453
|
+
/** If specified, the extensions mentioned in this configuration will be installed on each node. */
|
|
454
|
+
extensions?: VMExtension[];
|
|
455
|
+
/** Contains configuration for ephemeral OSDisk settings. */
|
|
456
|
+
osDisk?: OSDisk;
|
|
457
|
+
}
|
|
458
|
+
/** A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. */
|
|
459
|
+
export interface ImageReference {
|
|
460
|
+
/** For example, Canonical or MicrosoftWindowsServer. */
|
|
461
|
+
publisher?: string;
|
|
462
|
+
/** For example, UbuntuServer or WindowsServer. */
|
|
463
|
+
offer?: string;
|
|
464
|
+
/** For example, 18.04-LTS or 2019-Datacenter. */
|
|
465
|
+
sku?: string;
|
|
466
|
+
/** A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. */
|
|
467
|
+
version?: string;
|
|
468
|
+
/** This property is mutually exclusive with other properties. The Shared Image Gallery image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */
|
|
469
|
+
id?: string;
|
|
470
|
+
}
|
|
471
|
+
/** Windows operating system settings to apply to the virtual machine. */
|
|
472
|
+
export interface WindowsConfiguration {
|
|
473
|
+
/** If omitted, the default value is true. */
|
|
474
|
+
enableAutomaticUpdates?: boolean;
|
|
475
|
+
}
|
|
476
|
+
/** Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them. */
|
|
477
|
+
export interface DataDisk {
|
|
478
|
+
/** The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. */
|
|
479
|
+
lun: number;
|
|
480
|
+
/**
|
|
481
|
+
* Values are:
|
|
482
|
+
*
|
|
483
|
+
* none - The caching mode for the disk is not enabled.
|
|
484
|
+
* readOnly - The caching mode for the disk is read only.
|
|
485
|
+
* readWrite - The caching mode for the disk is read and write.
|
|
486
|
+
*
|
|
487
|
+
* The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
|
|
488
|
+
*/
|
|
489
|
+
caching?: CachingType;
|
|
490
|
+
/** The initial disk size in GB when creating new data disk. */
|
|
491
|
+
diskSizeGB: number;
|
|
492
|
+
/**
|
|
493
|
+
* If omitted, the default is "Standard_LRS". Values are:
|
|
494
|
+
*
|
|
495
|
+
* Standard_LRS - The data disk should use standard locally redundant storage.
|
|
496
|
+
* Premium_LRS - The data disk should use premium locally redundant storage.
|
|
497
|
+
*/
|
|
498
|
+
storageAccountType?: StorageAccountType;
|
|
499
|
+
}
|
|
500
|
+
/** The configuration for container-enabled pools. */
|
|
501
|
+
export interface ContainerConfiguration {
|
|
502
|
+
/** The container technology to be used. */
|
|
503
|
+
type: "DockerCompatible";
|
|
504
|
+
/** This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. */
|
|
505
|
+
containerImageNames?: string[];
|
|
506
|
+
/** If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. */
|
|
507
|
+
containerRegistries?: ContainerRegistry[];
|
|
508
|
+
}
|
|
509
|
+
/** A private container registry. */
|
|
510
|
+
export interface ContainerRegistry {
|
|
511
|
+
/** The user name to log into the registry server. */
|
|
512
|
+
userName?: string;
|
|
513
|
+
/** The password to log into the registry server. */
|
|
514
|
+
password?: string;
|
|
515
|
+
/** If omitted, the default is "docker.io". */
|
|
516
|
+
registryServer?: string;
|
|
517
|
+
/** The reference to a user assigned identity associated with the Batch pool which a compute node will use. */
|
|
518
|
+
identityReference?: ComputeNodeIdentityReference;
|
|
519
|
+
}
|
|
520
|
+
/** The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image. */
|
|
521
|
+
export interface DiskEncryptionConfiguration {
|
|
522
|
+
/** On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. */
|
|
523
|
+
targets?: DiskEncryptionTarget[];
|
|
524
|
+
}
|
|
525
|
+
/** Allocation configuration used by Batch Service to provision the nodes. */
|
|
526
|
+
export interface NodePlacementConfiguration {
|
|
527
|
+
/** Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. */
|
|
528
|
+
policy?: NodePlacementPolicyType;
|
|
529
|
+
}
|
|
530
|
+
/** The configuration for virtual machine extensions. */
|
|
531
|
+
export interface VMExtension {
|
|
532
|
+
/** The name of the virtual machine extension. */
|
|
533
|
+
name: string;
|
|
534
|
+
/** The name of the extension handler publisher. */
|
|
535
|
+
publisher: string;
|
|
536
|
+
/** The type of the extensions. */
|
|
537
|
+
type: string;
|
|
538
|
+
/** The version of script handler. */
|
|
539
|
+
typeHandlerVersion?: string;
|
|
540
|
+
/** Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */
|
|
541
|
+
autoUpgradeMinorVersion?: boolean;
|
|
542
|
+
/** Any object */
|
|
543
|
+
settings?: Record<string, unknown>;
|
|
544
|
+
/** The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */
|
|
545
|
+
protectedSettings?: Record<string, unknown>;
|
|
546
|
+
/** Collection of extension names after which this extension needs to be provisioned. */
|
|
547
|
+
provisionAfterExtensions?: string[];
|
|
548
|
+
}
|
|
549
|
+
/** Settings for the operating system disk of the virtual machine. */
|
|
550
|
+
export interface OSDisk {
|
|
551
|
+
/** Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */
|
|
552
|
+
ephemeralOSDiskSettings?: DiffDiskSettings;
|
|
553
|
+
}
|
|
554
|
+
/** Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */
|
|
555
|
+
export interface DiffDiskSettings {
|
|
556
|
+
/** This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. */
|
|
557
|
+
placement?: "CacheDisk";
|
|
558
|
+
}
|
|
559
|
+
/** Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. */
|
|
560
|
+
export interface ScaleSettings {
|
|
561
|
+
/** This property and autoScale are mutually exclusive and one of the properties must be specified. */
|
|
562
|
+
fixedScale?: FixedScaleSettings;
|
|
563
|
+
/** This property and fixedScale are mutually exclusive and one of the properties must be specified. */
|
|
564
|
+
autoScale?: AutoScaleSettings;
|
|
565
|
+
}
|
|
566
|
+
/** Fixed scale settings for the pool. */
|
|
567
|
+
export interface FixedScaleSettings {
|
|
568
|
+
/** The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */
|
|
569
|
+
resizeTimeout?: string;
|
|
570
|
+
/** At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. */
|
|
571
|
+
targetDedicatedNodes?: number;
|
|
572
|
+
/** At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. */
|
|
573
|
+
targetLowPriorityNodes?: number;
|
|
574
|
+
/** If omitted, the default value is Requeue. */
|
|
575
|
+
nodeDeallocationOption?: ComputeNodeDeallocationOption;
|
|
576
|
+
}
|
|
577
|
+
/** AutoScale settings for the pool. */
|
|
578
|
+
export interface AutoScaleSettings {
|
|
579
|
+
/** A formula for the desired number of compute nodes in the pool. */
|
|
580
|
+
formula: string;
|
|
581
|
+
/** If omitted, the default value is 15 minutes (PT15M). */
|
|
582
|
+
evaluationInterval?: string;
|
|
583
|
+
}
|
|
584
|
+
/** The results and errors from an execution of a pool autoscale formula. */
|
|
585
|
+
export interface AutoScaleRun {
|
|
586
|
+
/** The time at which the autoscale formula was last evaluated. */
|
|
587
|
+
evaluationTime: Date;
|
|
588
|
+
/** Each variable value is returned in the form $variable=value, and variables are separated by semicolons. */
|
|
589
|
+
results?: string;
|
|
590
|
+
/** An error that occurred when autoscaling a pool. */
|
|
591
|
+
error?: AutoScaleRunError;
|
|
592
|
+
}
|
|
593
|
+
/** An error that occurred when autoscaling a pool. */
|
|
594
|
+
export interface AutoScaleRunError {
|
|
595
|
+
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
|
|
596
|
+
code: string;
|
|
597
|
+
/** A message describing the error, intended to be suitable for display in a user interface. */
|
|
598
|
+
message: string;
|
|
599
|
+
/** Additional details about the error. */
|
|
600
|
+
details?: AutoScaleRunError[];
|
|
601
|
+
}
|
|
602
|
+
/** The network configuration for a pool. */
|
|
603
|
+
export interface NetworkConfiguration {
|
|
604
|
+
/** The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For cloudServiceConfiguration pools, only 'classic' VNETs are supported. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration */
|
|
605
|
+
subnetId?: string;
|
|
606
|
+
/** Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property. */
|
|
607
|
+
endpointConfiguration?: PoolEndpointConfiguration;
|
|
608
|
+
/** This property is only supported on Pools with the virtualMachineConfiguration property. */
|
|
609
|
+
publicIPAddressConfiguration?: PublicIPAddressConfiguration;
|
|
610
|
+
}
|
|
611
|
+
/** The endpoint configuration for a pool. */
|
|
612
|
+
export interface PoolEndpointConfiguration {
|
|
613
|
+
/** The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. */
|
|
614
|
+
inboundNatPools: InboundNatPool[];
|
|
615
|
+
}
|
|
616
|
+
/** A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally. */
|
|
617
|
+
export interface InboundNatPool {
|
|
618
|
+
/** The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. */
|
|
619
|
+
name: string;
|
|
620
|
+
/** The protocol of the endpoint. */
|
|
621
|
+
protocol: InboundEndpointProtocol;
|
|
622
|
+
/** This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. */
|
|
623
|
+
backendPort: number;
|
|
624
|
+
/** Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. */
|
|
625
|
+
frontendPortRangeStart: number;
|
|
626
|
+
/** Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. */
|
|
627
|
+
frontendPortRangeEnd: number;
|
|
628
|
+
/** The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. */
|
|
629
|
+
networkSecurityGroupRules?: NetworkSecurityGroupRule[];
|
|
630
|
+
}
|
|
631
|
+
/** A network security group rule to apply to an inbound endpoint. */
|
|
632
|
+
export interface NetworkSecurityGroupRule {
|
|
633
|
+
/** Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. */
|
|
634
|
+
priority: number;
|
|
635
|
+
/** The action that should be taken for a specified IP address, subnet range or tag. */
|
|
636
|
+
access: NetworkSecurityGroupRuleAccess;
|
|
637
|
+
/** Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. */
|
|
638
|
+
sourceAddressPrefix: string;
|
|
639
|
+
/** Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. */
|
|
640
|
+
sourcePortRanges?: string[];
|
|
641
|
+
}
|
|
642
|
+
/** The public IP Address configuration of the networking configuration of a Pool. */
|
|
643
|
+
export interface PublicIPAddressConfiguration {
|
|
644
|
+
/** The default value is BatchManaged */
|
|
645
|
+
provision?: IPAddressProvisioningType;
|
|
646
|
+
/** The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. */
|
|
647
|
+
ipAddressIds?: string[];
|
|
648
|
+
}
|
|
649
|
+
/** Specifies how tasks should be distributed across compute nodes. */
|
|
650
|
+
export interface TaskSchedulingPolicy {
|
|
651
|
+
/** How tasks should be distributed across compute nodes. */
|
|
652
|
+
nodeFillType: ComputeNodeFillType;
|
|
653
|
+
}
|
|
654
|
+
/** Properties used to create a user on an Azure Batch node. */
|
|
655
|
+
export interface UserAccount {
|
|
656
|
+
/** The name of the user account. */
|
|
657
|
+
name: string;
|
|
658
|
+
/** The password for the user account. */
|
|
659
|
+
password: string;
|
|
660
|
+
/** nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. */
|
|
661
|
+
elevationLevel?: ElevationLevel;
|
|
662
|
+
/** This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. */
|
|
663
|
+
linuxUserConfiguration?: LinuxUserConfiguration;
|
|
664
|
+
/** This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. */
|
|
665
|
+
windowsUserConfiguration?: WindowsUserConfiguration;
|
|
666
|
+
}
|
|
667
|
+
/** Properties used to create a user account on a Linux node. */
|
|
668
|
+
export interface LinuxUserConfiguration {
|
|
669
|
+
/** The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. */
|
|
670
|
+
uid?: number;
|
|
671
|
+
/** The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. */
|
|
672
|
+
gid?: number;
|
|
673
|
+
/** The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). */
|
|
674
|
+
sshPrivateKey?: string;
|
|
675
|
+
}
|
|
676
|
+
/** Properties used to create a user account on a Windows node. */
|
|
677
|
+
export interface WindowsUserConfiguration {
|
|
678
|
+
/** Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode. */
|
|
679
|
+
loginMode?: LoginMode;
|
|
680
|
+
}
|
|
681
|
+
/** The Batch service does not assign any meaning to this metadata; it is solely for the use of user code. */
|
|
682
|
+
export interface MetadataItem {
|
|
683
|
+
/** The name of the metadata item. */
|
|
684
|
+
name: string;
|
|
685
|
+
/** The value of the metadata item. */
|
|
686
|
+
value: string;
|
|
687
|
+
}
|
|
688
|
+
/** In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. */
|
|
689
|
+
export interface StartTask {
|
|
690
|
+
/** The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. */
|
|
691
|
+
commandLine?: string;
|
|
692
|
+
/** A list of files that the Batch service will download to the compute node before running the command line. */
|
|
693
|
+
resourceFiles?: ResourceFile[];
|
|
694
|
+
/** A list of environment variable settings for the start task. */
|
|
695
|
+
environmentSettings?: EnvironmentSetting[];
|
|
696
|
+
/** If omitted, the task runs as a non-administrative user unique to the task. */
|
|
697
|
+
userIdentity?: UserIdentity;
|
|
698
|
+
/** The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. */
|
|
699
|
+
maxTaskRetryCount?: number;
|
|
700
|
+
/** If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. */
|
|
701
|
+
waitForSuccess?: boolean;
|
|
702
|
+
/** When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. */
|
|
703
|
+
containerSettings?: TaskContainerSettings;
|
|
704
|
+
}
|
|
705
|
+
/** A single file or multiple files to be downloaded to a compute node. */
|
|
706
|
+
export interface ResourceFile {
|
|
707
|
+
/** The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. */
|
|
708
|
+
autoStorageContainerName?: string;
|
|
709
|
+
/** The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. */
|
|
710
|
+
storageContainerUrl?: string;
|
|
711
|
+
/** The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. */
|
|
712
|
+
httpUrl?: string;
|
|
713
|
+
/** The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. */
|
|
714
|
+
blobPrefix?: string;
|
|
715
|
+
/** If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). */
|
|
716
|
+
filePath?: string;
|
|
717
|
+
/** This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. */
|
|
718
|
+
fileMode?: string;
|
|
719
|
+
/** The reference to a user assigned identity associated with the Batch pool which a compute node will use. */
|
|
720
|
+
identityReference?: ComputeNodeIdentityReference;
|
|
721
|
+
}
|
|
722
|
+
/** An environment variable to be set on a task process. */
|
|
723
|
+
export interface EnvironmentSetting {
|
|
724
|
+
/** The name of the environment variable. */
|
|
725
|
+
name: string;
|
|
726
|
+
/** The value of the environment variable. */
|
|
727
|
+
value?: string;
|
|
728
|
+
}
|
|
729
|
+
/** Specify either the userName or autoUser property, but not both. */
|
|
730
|
+
export interface UserIdentity {
|
|
731
|
+
/** The userName and autoUser properties are mutually exclusive; you must specify one but not both. */
|
|
732
|
+
userName?: string;
|
|
733
|
+
/** The userName and autoUser properties are mutually exclusive; you must specify one but not both. */
|
|
734
|
+
autoUser?: AutoUserSpecification;
|
|
735
|
+
}
|
|
736
|
+
/** Specifies the parameters for the auto user that runs a task on the Batch service. */
|
|
737
|
+
export interface AutoUserSpecification {
|
|
738
|
+
/** The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. */
|
|
739
|
+
scope?: AutoUserScope;
|
|
740
|
+
/** The default value is nonAdmin. */
|
|
741
|
+
elevationLevel?: ElevationLevel;
|
|
742
|
+
}
|
|
743
|
+
/** The container settings for a task. */
|
|
744
|
+
export interface TaskContainerSettings {
|
|
745
|
+
/** These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. */
|
|
746
|
+
containerRunOptions?: string;
|
|
747
|
+
/** This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. */
|
|
748
|
+
imageName: string;
|
|
749
|
+
/** This setting can be omitted if was already provided at pool creation. */
|
|
750
|
+
registry?: ContainerRegistry;
|
|
751
|
+
/** A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. */
|
|
752
|
+
workingDirectory?: ContainerWorkingDirectory;
|
|
753
|
+
}
|
|
754
|
+
/** A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool. */
|
|
755
|
+
export interface CertificateReference {
|
|
756
|
+
/** The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. */
|
|
757
|
+
id: string;
|
|
758
|
+
/** The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. */
|
|
759
|
+
storeLocation?: CertificateStoreLocation;
|
|
760
|
+
/** This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My. */
|
|
761
|
+
storeName?: string;
|
|
762
|
+
/** Which user accounts on the compute node should have access to the private data of the certificate. */
|
|
763
|
+
visibility?: CertificateVisibility[];
|
|
764
|
+
}
|
|
765
|
+
/** Link to an application package inside the batch account */
|
|
766
|
+
export interface ApplicationPackageReference {
|
|
767
|
+
/** The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. */
|
|
768
|
+
id: string;
|
|
769
|
+
/** If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. */
|
|
770
|
+
version?: string;
|
|
771
|
+
}
|
|
772
|
+
/** Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). */
|
|
773
|
+
export interface ResizeOperationStatus {
|
|
774
|
+
/** The desired number of dedicated compute nodes in the pool. */
|
|
775
|
+
targetDedicatedNodes?: number;
|
|
776
|
+
/** The desired number of low-priority compute nodes in the pool. */
|
|
777
|
+
targetLowPriorityNodes?: number;
|
|
778
|
+
/** The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */
|
|
779
|
+
resizeTimeout?: string;
|
|
780
|
+
/** The default value is requeue. */
|
|
781
|
+
nodeDeallocationOption?: ComputeNodeDeallocationOption;
|
|
782
|
+
/** The time when this resize operation was started. */
|
|
783
|
+
startTime?: Date;
|
|
784
|
+
/** This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. */
|
|
785
|
+
errors?: ResizeError[];
|
|
786
|
+
}
|
|
787
|
+
/** An error that occurred when resizing a pool. */
|
|
788
|
+
export interface ResizeError {
|
|
789
|
+
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
|
|
790
|
+
code: string;
|
|
791
|
+
/** A message describing the error, intended to be suitable for display in a user interface. */
|
|
792
|
+
message: string;
|
|
793
|
+
/** Additional details about the error. */
|
|
794
|
+
details?: ResizeError[];
|
|
795
|
+
}
|
|
796
|
+
/** The file system to mount on each node. */
|
|
797
|
+
export interface MountConfiguration {
|
|
798
|
+
/** This property is mutually exclusive with all other properties. */
|
|
799
|
+
azureBlobFileSystemConfiguration?: AzureBlobFileSystemConfiguration;
|
|
800
|
+
/** This property is mutually exclusive with all other properties. */
|
|
801
|
+
nfsMountConfiguration?: NFSMountConfiguration;
|
|
802
|
+
/** This property is mutually exclusive with all other properties. */
|
|
803
|
+
cifsMountConfiguration?: CifsMountConfiguration;
|
|
804
|
+
/** This property is mutually exclusive with all other properties. */
|
|
805
|
+
azureFileShareConfiguration?: AzureFileShareConfiguration;
|
|
806
|
+
}
|
|
807
|
+
/** Information used to connect to an Azure Storage Container using Blobfuse. */
|
|
808
|
+
export interface AzureBlobFileSystemConfiguration {
|
|
809
|
+
/** The Azure Storage Account name. */
|
|
810
|
+
accountName: string;
|
|
811
|
+
/** The Azure Blob Storage Container name. */
|
|
812
|
+
containerName: string;
|
|
813
|
+
/** This property is mutually exclusive with both sasKey and identity; exactly one must be specified. */
|
|
814
|
+
accountKey?: string;
|
|
815
|
+
/** This property is mutually exclusive with both accountKey and identity; exactly one must be specified. */
|
|
816
|
+
sasKey?: string;
|
|
817
|
+
/** These are 'net use' options in Windows and 'mount' options in Linux. */
|
|
818
|
+
blobfuseOptions?: string;
|
|
819
|
+
/** All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */
|
|
820
|
+
relativeMountPath: string;
|
|
821
|
+
/** This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. */
|
|
822
|
+
identityReference?: ComputeNodeIdentityReference;
|
|
823
|
+
}
|
|
824
|
+
/** Information used to connect to an NFS file system. */
|
|
825
|
+
export interface NFSMountConfiguration {
|
|
826
|
+
/** The URI of the file system to mount. */
|
|
827
|
+
source: string;
|
|
828
|
+
/** All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */
|
|
829
|
+
relativeMountPath: string;
|
|
830
|
+
/** These are 'net use' options in Windows and 'mount' options in Linux. */
|
|
831
|
+
mountOptions?: string;
|
|
832
|
+
}
|
|
833
|
+
/** Information used to connect to a CIFS file system. */
|
|
834
|
+
export interface CifsMountConfiguration {
|
|
835
|
+
/** The user to use for authentication against the CIFS file system. */
|
|
836
|
+
username: string;
|
|
837
|
+
/** The URI of the file system to mount. */
|
|
838
|
+
source: string;
|
|
839
|
+
/** All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */
|
|
840
|
+
relativeMountPath: string;
|
|
841
|
+
/** These are 'net use' options in Windows and 'mount' options in Linux. */
|
|
842
|
+
mountOptions?: string;
|
|
843
|
+
/** The password to use for authentication against the CIFS file system. */
|
|
844
|
+
password: string;
|
|
845
|
+
}
|
|
846
|
+
/** Information used to connect to an Azure Fileshare. */
|
|
847
|
+
export interface AzureFileShareConfiguration {
|
|
848
|
+
/** The Azure Storage account name. */
|
|
849
|
+
accountName: string;
|
|
850
|
+
/** This is of the form 'https://{account}.file.core.windows.net/'. */
|
|
851
|
+
azureFileUrl: string;
|
|
852
|
+
/** The Azure Storage account key. */
|
|
853
|
+
accountKey: string;
|
|
854
|
+
/** All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */
|
|
855
|
+
relativeMountPath: string;
|
|
856
|
+
/** These are 'net use' options in Windows and 'mount' options in Linux. */
|
|
857
|
+
mountOptions?: string;
|
|
858
|
+
}
|
|
859
|
+
/** The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities */
|
|
860
|
+
export interface BatchPoolIdentity {
|
|
861
|
+
/** The type of identity used for the Batch Pool. */
|
|
862
|
+
type: PoolIdentityType;
|
|
863
|
+
/** The list of user identities associated with the Batch pool. */
|
|
864
|
+
userAssignedIdentities?: {
|
|
865
|
+
[propertyName: string]: UserAssignedIdentities;
|
|
866
|
+
};
|
|
867
|
+
}
|
|
868
|
+
/** Values returned by the List operation. */
|
|
869
|
+
export interface OutboundEnvironmentEndpointCollection {
|
|
870
|
+
/**
|
|
871
|
+
* The collection of outbound network dependency endpoints returned by the listing operation.
|
|
872
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
873
|
+
*/
|
|
874
|
+
readonly value?: OutboundEnvironmentEndpoint[];
|
|
875
|
+
/** The continuation token. */
|
|
876
|
+
nextLink?: string;
|
|
877
|
+
}
|
|
878
|
+
/** A collection of related endpoints from the same service for which the Batch service requires outbound access. */
|
|
879
|
+
export interface OutboundEnvironmentEndpoint {
|
|
880
|
+
/**
|
|
881
|
+
* The type of service that the Batch service connects to.
|
|
882
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
883
|
+
*/
|
|
884
|
+
readonly category?: string;
|
|
885
|
+
/**
|
|
886
|
+
* The endpoints for this service to which the Batch service makes outbound calls.
|
|
887
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
888
|
+
*/
|
|
889
|
+
readonly endpoints?: EndpointDependency[];
|
|
890
|
+
}
|
|
891
|
+
/** A domain name and connection details used to access a dependency. */
|
|
892
|
+
export interface EndpointDependency {
|
|
893
|
+
/**
|
|
894
|
+
* The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard.
|
|
895
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
896
|
+
*/
|
|
897
|
+
readonly domainName?: string;
|
|
898
|
+
/**
|
|
899
|
+
* Human-readable supplemental information about the dependency and when it is applicable.
|
|
900
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
901
|
+
*/
|
|
902
|
+
readonly description?: string;
|
|
903
|
+
/**
|
|
904
|
+
* The list of connection details for this endpoint.
|
|
905
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
906
|
+
*/
|
|
907
|
+
readonly endpointDetails?: EndpointDetail[];
|
|
908
|
+
}
|
|
909
|
+
/** Details about the connection between the Batch service and the endpoint. */
|
|
910
|
+
export interface EndpointDetail {
|
|
911
|
+
/**
|
|
912
|
+
* The port an endpoint is connected to.
|
|
913
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
914
|
+
*/
|
|
915
|
+
readonly port?: number;
|
|
916
|
+
}
|
|
917
|
+
/** Contains information about the auto-storage account associated with a Batch account. */
|
|
918
|
+
export declare type AutoStorageProperties = AutoStorageBaseProperties & {
|
|
919
|
+
/** The UTC time at which storage keys were last synchronized with the Batch account. */
|
|
920
|
+
lastKeySync: Date;
|
|
921
|
+
};
|
|
922
|
+
/** Contains information about a private link resource. */
|
|
923
|
+
export declare type PrivateEndpointConnection = ProxyResource & {
|
|
924
|
+
/**
|
|
925
|
+
* The provisioning state of the private endpoint connection.
|
|
926
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
927
|
+
*/
|
|
928
|
+
readonly provisioningState?: PrivateEndpointConnectionProvisioningState;
|
|
929
|
+
/** The private endpoint of the private endpoint connection. */
|
|
930
|
+
privateEndpoint?: PrivateEndpoint;
|
|
931
|
+
/** The private link service connection state of the private endpoint connection */
|
|
932
|
+
privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
|
|
933
|
+
};
|
|
934
|
+
/** An application package which represents a particular version of an application. */
|
|
935
|
+
export declare type ApplicationPackage = ProxyResource & {
|
|
936
|
+
/**
|
|
937
|
+
* The current state of the application package.
|
|
938
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
939
|
+
*/
|
|
940
|
+
readonly state?: PackageState;
|
|
941
|
+
/**
|
|
942
|
+
* The format of the application package, if the package is active.
|
|
943
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
944
|
+
*/
|
|
945
|
+
readonly format?: string;
|
|
946
|
+
/**
|
|
947
|
+
* The URL for the application package in Azure Storage.
|
|
948
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
949
|
+
*/
|
|
950
|
+
readonly storageUrl?: string;
|
|
951
|
+
/**
|
|
952
|
+
* The UTC time at which the Azure Storage URL will expire.
|
|
953
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
954
|
+
*/
|
|
955
|
+
readonly storageUrlExpiry?: Date;
|
|
956
|
+
/**
|
|
957
|
+
* The time at which the package was last activated, if the package is active.
|
|
958
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
959
|
+
*/
|
|
960
|
+
readonly lastActivationTime?: Date;
|
|
961
|
+
};
|
|
962
|
+
/** Contains information about an application in a Batch account. */
|
|
963
|
+
export declare type Application = ProxyResource & {
|
|
964
|
+
/** The display name for the application. */
|
|
965
|
+
displayName?: string;
|
|
966
|
+
/** A value indicating whether packages within the application may be overwritten using the same version string. */
|
|
967
|
+
allowUpdates?: boolean;
|
|
968
|
+
/** The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package. */
|
|
969
|
+
defaultVersion?: string;
|
|
970
|
+
};
|
|
971
|
+
/** Contains information about a certificate. */
|
|
972
|
+
export declare type Certificate = ProxyResource & {
|
|
973
|
+
/** This must match the first portion of the certificate name. Currently required to be 'SHA1'. */
|
|
974
|
+
thumbprintAlgorithm?: string;
|
|
975
|
+
/** This must match the thumbprint from the name. */
|
|
976
|
+
thumbprint?: string;
|
|
977
|
+
/** The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. */
|
|
978
|
+
format?: CertificateFormat;
|
|
979
|
+
/** NOTE: This property will not be serialized. It can only be populated by the server. */
|
|
980
|
+
readonly provisioningState?: CertificateProvisioningState;
|
|
981
|
+
/**
|
|
982
|
+
* The time at which the certificate entered its current state.
|
|
983
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
984
|
+
*/
|
|
985
|
+
readonly provisioningStateTransitionTime?: Date;
|
|
986
|
+
/**
|
|
987
|
+
* The previous provisioned state of the resource
|
|
988
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
989
|
+
*/
|
|
990
|
+
readonly previousProvisioningState?: CertificateProvisioningState;
|
|
991
|
+
/**
|
|
992
|
+
* The time at which the certificate entered its previous state.
|
|
993
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
994
|
+
*/
|
|
995
|
+
readonly previousProvisioningStateTransitionTime?: Date;
|
|
996
|
+
/**
|
|
997
|
+
* The public key of the certificate.
|
|
998
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
999
|
+
*/
|
|
1000
|
+
readonly publicData?: string;
|
|
1001
|
+
/**
|
|
1002
|
+
* This is only returned when the certificate provisioningState is 'Failed'.
|
|
1003
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1004
|
+
*/
|
|
1005
|
+
readonly deleteCertificateError?: DeleteCertificateError;
|
|
1006
|
+
};
|
|
1007
|
+
/** Contains information about a certificate. */
|
|
1008
|
+
export declare type CertificateCreateOrUpdateParameters = ProxyResource & {
|
|
1009
|
+
/** This must match the first portion of the certificate name. Currently required to be 'SHA1'. */
|
|
1010
|
+
thumbprintAlgorithm?: string;
|
|
1011
|
+
/** This must match the thumbprint from the name. */
|
|
1012
|
+
thumbprint?: string;
|
|
1013
|
+
/** The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. */
|
|
1014
|
+
format?: CertificateFormat;
|
|
1015
|
+
/** The maximum size is 10KB. */
|
|
1016
|
+
data?: string;
|
|
1017
|
+
/** This must not be specified if the certificate format is Cer. */
|
|
1018
|
+
password?: string;
|
|
1019
|
+
};
|
|
1020
|
+
/** Contains information about a private link resource. */
|
|
1021
|
+
export declare type PrivateLinkResource = ProxyResource & {
|
|
1022
|
+
/**
|
|
1023
|
+
* The group id is used to establish the private link connection.
|
|
1024
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1025
|
+
*/
|
|
1026
|
+
readonly groupId?: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* The list of required members that are used to establish the private link connection.
|
|
1029
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1030
|
+
*/
|
|
1031
|
+
readonly requiredMembers?: string[];
|
|
1032
|
+
/**
|
|
1033
|
+
* The list of required zone names for the private DNS resource name
|
|
1034
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1035
|
+
*/
|
|
1036
|
+
readonly requiredZoneNames?: string[];
|
|
1037
|
+
};
|
|
1038
|
+
/** Contains information about a pool. */
|
|
1039
|
+
export declare type Pool = ProxyResource & {
|
|
1040
|
+
/** The type of identity used for the Batch Pool. */
|
|
1041
|
+
identity?: BatchPoolIdentity;
|
|
1042
|
+
/** The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. */
|
|
1043
|
+
displayName?: string;
|
|
1044
|
+
/**
|
|
1045
|
+
* This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.
|
|
1046
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1047
|
+
*/
|
|
1048
|
+
readonly lastModified?: Date;
|
|
1049
|
+
/**
|
|
1050
|
+
* The creation time of the pool.
|
|
1051
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1052
|
+
*/
|
|
1053
|
+
readonly creationTime?: Date;
|
|
1054
|
+
/**
|
|
1055
|
+
* The current state of the pool.
|
|
1056
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1057
|
+
*/
|
|
1058
|
+
readonly provisioningState?: PoolProvisioningState;
|
|
1059
|
+
/**
|
|
1060
|
+
* The time at which the pool entered its current state.
|
|
1061
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1062
|
+
*/
|
|
1063
|
+
readonly provisioningStateTransitionTime?: Date;
|
|
1064
|
+
/**
|
|
1065
|
+
* Whether the pool is resizing.
|
|
1066
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1067
|
+
*/
|
|
1068
|
+
readonly allocationState?: AllocationState;
|
|
1069
|
+
/**
|
|
1070
|
+
* The time at which the pool entered its current allocation state.
|
|
1071
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1072
|
+
*/
|
|
1073
|
+
readonly allocationStateTransitionTime?: Date;
|
|
1074
|
+
/** For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). */
|
|
1075
|
+
vmSize?: string;
|
|
1076
|
+
/** Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS). */
|
|
1077
|
+
deploymentConfiguration?: DeploymentConfiguration;
|
|
1078
|
+
/**
|
|
1079
|
+
* The number of compute nodes currently in the pool.
|
|
1080
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1081
|
+
*/
|
|
1082
|
+
readonly currentDedicatedNodes?: number;
|
|
1083
|
+
/**
|
|
1084
|
+
* The number of low-priority compute nodes currently in the pool.
|
|
1085
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1086
|
+
*/
|
|
1087
|
+
readonly currentLowPriorityNodes?: number;
|
|
1088
|
+
/** Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. */
|
|
1089
|
+
scaleSettings?: ScaleSettings;
|
|
1090
|
+
/**
|
|
1091
|
+
* This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.
|
|
1092
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1093
|
+
*/
|
|
1094
|
+
readonly autoScaleRun?: AutoScaleRun;
|
|
1095
|
+
/** This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. */
|
|
1096
|
+
interNodeCommunication?: InterNodeCommunicationState;
|
|
1097
|
+
/** The network configuration for a pool. */
|
|
1098
|
+
networkConfiguration?: NetworkConfiguration;
|
|
1099
|
+
/** The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. */
|
|
1100
|
+
taskSlotsPerNode?: number;
|
|
1101
|
+
/** If not specified, the default is spread. */
|
|
1102
|
+
taskSchedulingPolicy?: TaskSchedulingPolicy;
|
|
1103
|
+
/** The list of user accounts to be created on each node in the pool. */
|
|
1104
|
+
userAccounts?: UserAccount[];
|
|
1105
|
+
/** The Batch service does not assign any meaning to metadata; it is solely for the use of user code. */
|
|
1106
|
+
metadata?: MetadataItem[];
|
|
1107
|
+
/** In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool. */
|
|
1108
|
+
startTask?: StartTask;
|
|
1109
|
+
/** For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. */
|
|
1110
|
+
certificates?: CertificateReference[];
|
|
1111
|
+
/** Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool. */
|
|
1112
|
+
applicationPackages?: ApplicationPackageReference[];
|
|
1113
|
+
/** The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail. */
|
|
1114
|
+
applicationLicenses?: string[];
|
|
1115
|
+
/**
|
|
1116
|
+
* Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
|
|
1117
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1118
|
+
*/
|
|
1119
|
+
readonly resizeOperationStatus?: ResizeOperationStatus;
|
|
1120
|
+
/** This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. */
|
|
1121
|
+
mountConfiguration?: MountConfiguration[];
|
|
1122
|
+
};
|
|
1123
|
+
/** Contains information about an Azure Batch account. */
|
|
1124
|
+
export declare type BatchAccount = Resource & {
|
|
1125
|
+
/** The identity of the Batch account. */
|
|
1126
|
+
identity?: BatchAccountIdentity;
|
|
1127
|
+
/**
|
|
1128
|
+
* The account endpoint used to interact with the Batch service.
|
|
1129
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1130
|
+
*/
|
|
1131
|
+
readonly accountEndpoint?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* The provisioned state of the resource
|
|
1134
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1135
|
+
*/
|
|
1136
|
+
readonly provisioningState?: ProvisioningState;
|
|
1137
|
+
/**
|
|
1138
|
+
* The allocation mode for creating pools in the Batch account.
|
|
1139
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1140
|
+
*/
|
|
1141
|
+
readonly poolAllocationMode?: PoolAllocationMode;
|
|
1142
|
+
/**
|
|
1143
|
+
* Identifies the Azure key vault associated with a Batch account.
|
|
1144
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1145
|
+
*/
|
|
1146
|
+
readonly keyVaultReference?: KeyVaultReference;
|
|
1147
|
+
/**
|
|
1148
|
+
* If not specified, the default value is 'enabled'.
|
|
1149
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1150
|
+
*/
|
|
1151
|
+
readonly publicNetworkAccess?: PublicNetworkAccessType;
|
|
1152
|
+
/**
|
|
1153
|
+
* List of private endpoint connections associated with the Batch account
|
|
1154
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1155
|
+
*/
|
|
1156
|
+
readonly privateEndpointConnections?: PrivateEndpointConnection[];
|
|
1157
|
+
/**
|
|
1158
|
+
* Contains information about the auto-storage account associated with a Batch account.
|
|
1159
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1160
|
+
*/
|
|
1161
|
+
readonly autoStorage?: AutoStorageProperties;
|
|
1162
|
+
/**
|
|
1163
|
+
* Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
|
|
1164
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1165
|
+
*/
|
|
1166
|
+
readonly encryption?: EncryptionProperties;
|
|
1167
|
+
/**
|
|
1168
|
+
* For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
|
|
1169
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1170
|
+
*/
|
|
1171
|
+
readonly dedicatedCoreQuota?: number;
|
|
1172
|
+
/**
|
|
1173
|
+
* For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
|
|
1174
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1175
|
+
*/
|
|
1176
|
+
readonly lowPriorityCoreQuota?: number;
|
|
1177
|
+
/**
|
|
1178
|
+
* A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
|
|
1179
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1180
|
+
*/
|
|
1181
|
+
readonly dedicatedCoreQuotaPerVMFamily?: VirtualMachineFamilyCoreQuota[];
|
|
1182
|
+
/**
|
|
1183
|
+
* Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.
|
|
1184
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1185
|
+
*/
|
|
1186
|
+
readonly dedicatedCoreQuotaPerVMFamilyEnforced?: boolean;
|
|
1187
|
+
/**
|
|
1188
|
+
* The pool quota for the Batch account.
|
|
1189
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1190
|
+
*/
|
|
1191
|
+
readonly poolQuota?: number;
|
|
1192
|
+
/**
|
|
1193
|
+
* The active job and job schedule quota for the Batch account.
|
|
1194
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1195
|
+
*/
|
|
1196
|
+
readonly activeJobAndJobScheduleQuota?: number;
|
|
1197
|
+
/**
|
|
1198
|
+
* List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
|
|
1199
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1200
|
+
*/
|
|
1201
|
+
readonly allowedAuthenticationModes?: AuthenticationMode[];
|
|
1202
|
+
};
|
|
1203
|
+
/** Certificate properties. */
|
|
1204
|
+
export declare type CertificateProperties = CertificateBaseProperties & {
|
|
1205
|
+
/** NOTE: This property will not be serialized. It can only be populated by the server. */
|
|
1206
|
+
readonly provisioningState?: CertificateProvisioningState;
|
|
1207
|
+
/**
|
|
1208
|
+
* The time at which the certificate entered its current state.
|
|
1209
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1210
|
+
*/
|
|
1211
|
+
readonly provisioningStateTransitionTime?: Date;
|
|
1212
|
+
/**
|
|
1213
|
+
* The previous provisioned state of the resource
|
|
1214
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1215
|
+
*/
|
|
1216
|
+
readonly previousProvisioningState?: CertificateProvisioningState;
|
|
1217
|
+
/**
|
|
1218
|
+
* The time at which the certificate entered its previous state.
|
|
1219
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1220
|
+
*/
|
|
1221
|
+
readonly previousProvisioningStateTransitionTime?: Date;
|
|
1222
|
+
/**
|
|
1223
|
+
* The public key of the certificate.
|
|
1224
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1225
|
+
*/
|
|
1226
|
+
readonly publicData?: string;
|
|
1227
|
+
/**
|
|
1228
|
+
* This is only returned when the certificate provisioningState is 'Failed'.
|
|
1229
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1230
|
+
*/
|
|
1231
|
+
readonly deleteCertificateError?: DeleteCertificateError;
|
|
1232
|
+
};
|
|
1233
|
+
/** Certificate properties for create operations */
|
|
1234
|
+
export declare type CertificateCreateOrUpdateProperties = CertificateBaseProperties & {
|
|
1235
|
+
/** The maximum size is 10KB. */
|
|
1236
|
+
data: string;
|
|
1237
|
+
/** This must not be specified if the certificate format is Cer. */
|
|
1238
|
+
password?: string;
|
|
1239
|
+
};
|
|
1240
|
+
/** Defines headers for BatchAccount_create operation. */
|
|
1241
|
+
export interface BatchAccountCreateHeaders {
|
|
1242
|
+
/** The URL of the resource used to check the status of the asynchronous operation. */
|
|
1243
|
+
location?: string;
|
|
1244
|
+
/** Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds. */
|
|
1245
|
+
retryAfter?: number;
|
|
1246
|
+
}
|
|
1247
|
+
/** Defines headers for BatchAccount_delete operation. */
|
|
1248
|
+
export interface BatchAccountDeleteHeaders {
|
|
1249
|
+
/** The URL of the resource used to check the status of the asynchronous operation. */
|
|
1250
|
+
location?: string;
|
|
1251
|
+
/** Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds. */
|
|
1252
|
+
retryAfter?: number;
|
|
1253
|
+
}
|
|
1254
|
+
/** Defines headers for Certificate_create operation. */
|
|
1255
|
+
export interface CertificateCreateHeaders {
|
|
1256
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1257
|
+
eTag?: string;
|
|
1258
|
+
}
|
|
1259
|
+
/** Defines headers for Certificate_update operation. */
|
|
1260
|
+
export interface CertificateUpdateHeaders {
|
|
1261
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1262
|
+
eTag?: string;
|
|
1263
|
+
}
|
|
1264
|
+
/** Defines headers for Certificate_delete operation. */
|
|
1265
|
+
export interface CertificateDeleteHeaders {
|
|
1266
|
+
/** The URL of the resource used to check the status of the asynchronous operation. */
|
|
1267
|
+
location?: string;
|
|
1268
|
+
/** Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. */
|
|
1269
|
+
retryAfter?: number;
|
|
1270
|
+
}
|
|
1271
|
+
/** Defines headers for Certificate_get operation. */
|
|
1272
|
+
export interface CertificateGetHeaders {
|
|
1273
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1274
|
+
eTag?: string;
|
|
1275
|
+
}
|
|
1276
|
+
/** Defines headers for Certificate_cancelDeletion operation. */
|
|
1277
|
+
export interface CertificateCancelDeletionHeaders {
|
|
1278
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1279
|
+
eTag?: string;
|
|
1280
|
+
}
|
|
1281
|
+
/** Defines headers for PrivateEndpointConnection_update operation. */
|
|
1282
|
+
export interface PrivateEndpointConnectionUpdateHeaders {
|
|
1283
|
+
/** The URL of the resource used to check the status of the asynchronous operation. */
|
|
1284
|
+
location?: string;
|
|
1285
|
+
/** Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. */
|
|
1286
|
+
retryAfter?: number;
|
|
1287
|
+
}
|
|
1288
|
+
/** Defines headers for Pool_create operation. */
|
|
1289
|
+
export interface PoolCreateHeaders {
|
|
1290
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1291
|
+
eTag?: string;
|
|
1292
|
+
}
|
|
1293
|
+
/** Defines headers for Pool_update operation. */
|
|
1294
|
+
export interface PoolUpdateHeaders {
|
|
1295
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1296
|
+
eTag?: string;
|
|
1297
|
+
}
|
|
1298
|
+
/** Defines headers for Pool_delete operation. */
|
|
1299
|
+
export interface PoolDeleteHeaders {
|
|
1300
|
+
/** The URL of the resource used to check the status of the asynchronous operation. */
|
|
1301
|
+
location?: string;
|
|
1302
|
+
/** Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds. */
|
|
1303
|
+
retryAfter?: number;
|
|
1304
|
+
}
|
|
1305
|
+
/** Defines headers for Pool_get operation. */
|
|
1306
|
+
export interface PoolGetHeaders {
|
|
1307
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1308
|
+
eTag?: string;
|
|
1309
|
+
}
|
|
1310
|
+
/** Defines headers for Pool_disableAutoScale operation. */
|
|
1311
|
+
export interface PoolDisableAutoScaleHeaders {
|
|
1312
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1313
|
+
eTag?: string;
|
|
1314
|
+
}
|
|
1315
|
+
/** Defines headers for Pool_stopResize operation. */
|
|
1316
|
+
export interface PoolStopResizeHeaders {
|
|
1317
|
+
/** The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers. */
|
|
1318
|
+
eTag?: string;
|
|
1319
|
+
}
|
|
1320
|
+
/** Defines values for AutoStorageAuthenticationMode. */
|
|
1321
|
+
export declare type AutoStorageAuthenticationMode = "StorageKeys" | "BatchAccountManagedIdentity";
|
|
1322
|
+
/** Defines values for PoolAllocationMode. */
|
|
1323
|
+
export declare type PoolAllocationMode = "BatchService" | "UserSubscription";
|
|
1324
|
+
/** Defines values for PublicNetworkAccessType. */
|
|
1325
|
+
export declare type PublicNetworkAccessType = "Enabled" | "Disabled";
|
|
1326
|
+
/** Defines values for KeySource. */
|
|
1327
|
+
export declare type KeySource = "Microsoft.Batch" | "Microsoft.KeyVault";
|
|
1328
|
+
/** Defines values for AuthenticationMode. */
|
|
1329
|
+
export declare type AuthenticationMode = "SharedKey" | "AAD" | "TaskAuthenticationToken";
|
|
1330
|
+
/** Defines values for ResourceIdentityType. */
|
|
1331
|
+
export declare type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "None";
|
|
1332
|
+
/** Defines values for ProvisioningState. */
|
|
1333
|
+
export declare type ProvisioningState = "Invalid" | "Creating" | "Deleting" | "Succeeded" | "Failed" | "Cancelled";
|
|
1334
|
+
/** Defines values for PrivateEndpointConnectionProvisioningState. */
|
|
1335
|
+
export declare type PrivateEndpointConnectionProvisioningState = "Succeeded" | "Updating" | "Failed";
|
|
1336
|
+
/** Defines values for PrivateLinkServiceConnectionStatus. */
|
|
1337
|
+
export declare type PrivateLinkServiceConnectionStatus = "Approved" | "Pending" | "Rejected" | "Disconnected";
|
|
1338
|
+
/** Defines values for AccountKeyType. */
|
|
1339
|
+
export declare type AccountKeyType = "Primary" | "Secondary";
|
|
1340
|
+
/** Defines values for PackageState. */
|
|
1341
|
+
export declare type PackageState = "Pending" | "Active";
|
|
1342
|
+
/** Defines values for NameAvailabilityReason. */
|
|
1343
|
+
export declare type NameAvailabilityReason = "Invalid" | "AlreadyExists";
|
|
1344
|
+
/** Defines values for CertificateProvisioningState. */
|
|
1345
|
+
export declare type CertificateProvisioningState = "Succeeded" | "Deleting" | "Failed";
|
|
1346
|
+
/** Defines values for CertificateFormat. */
|
|
1347
|
+
export declare type CertificateFormat = "Pfx" | "Cer";
|
|
1348
|
+
/** Defines values for PoolProvisioningState. */
|
|
1349
|
+
export declare type PoolProvisioningState = "Succeeded" | "Deleting";
|
|
1350
|
+
/** Defines values for AllocationState. */
|
|
1351
|
+
export declare type AllocationState = "Steady" | "Resizing" | "Stopping";
|
|
1352
|
+
/** Defines values for CachingType. */
|
|
1353
|
+
export declare type CachingType = "None" | "ReadOnly" | "ReadWrite";
|
|
1354
|
+
/** Defines values for StorageAccountType. */
|
|
1355
|
+
export declare type StorageAccountType = "Standard_LRS" | "Premium_LRS";
|
|
1356
|
+
/** Defines values for DiskEncryptionTarget. */
|
|
1357
|
+
export declare type DiskEncryptionTarget = "OsDisk" | "TemporaryDisk";
|
|
1358
|
+
/** Defines values for NodePlacementPolicyType. */
|
|
1359
|
+
export declare type NodePlacementPolicyType = "Regional" | "Zonal";
|
|
1360
|
+
/** Defines values for ComputeNodeDeallocationOption. */
|
|
1361
|
+
export declare type ComputeNodeDeallocationOption = "Requeue" | "Terminate" | "TaskCompletion" | "RetainedData";
|
|
1362
|
+
/** Defines values for InterNodeCommunicationState. */
|
|
1363
|
+
export declare type InterNodeCommunicationState = "Enabled" | "Disabled";
|
|
1364
|
+
/** Defines values for InboundEndpointProtocol. */
|
|
1365
|
+
export declare type InboundEndpointProtocol = "TCP" | "UDP";
|
|
1366
|
+
/** Defines values for NetworkSecurityGroupRuleAccess. */
|
|
1367
|
+
export declare type NetworkSecurityGroupRuleAccess = "Allow" | "Deny";
|
|
1368
|
+
/** Defines values for IPAddressProvisioningType. */
|
|
1369
|
+
export declare type IPAddressProvisioningType = "BatchManaged" | "UserManaged" | "NoPublicIPAddresses";
|
|
1370
|
+
/** Defines values for ComputeNodeFillType. */
|
|
1371
|
+
export declare type ComputeNodeFillType = "Spread" | "Pack";
|
|
1372
|
+
/** Defines values for ElevationLevel. */
|
|
1373
|
+
export declare type ElevationLevel = "NonAdmin" | "Admin";
|
|
1374
|
+
/** Defines values for LoginMode. */
|
|
1375
|
+
export declare type LoginMode = "Batch" | "Interactive";
|
|
1376
|
+
/** Defines values for AutoUserScope. */
|
|
1377
|
+
export declare type AutoUserScope = "Task" | "Pool";
|
|
1378
|
+
/** Defines values for ContainerWorkingDirectory. */
|
|
1379
|
+
export declare type ContainerWorkingDirectory = "TaskWorkingDirectory" | "ContainerImageDefault";
|
|
1380
|
+
/** Defines values for CertificateStoreLocation. */
|
|
1381
|
+
export declare type CertificateStoreLocation = "CurrentUser" | "LocalMachine";
|
|
1382
|
+
/** Defines values for CertificateVisibility. */
|
|
1383
|
+
export declare type CertificateVisibility = "StartTask" | "Task" | "RemoteUser";
|
|
1384
|
+
/** Defines values for PoolIdentityType. */
|
|
1385
|
+
export declare type PoolIdentityType = "UserAssigned" | "None";
|
|
1386
|
+
/** Optional parameters. */
|
|
1387
|
+
export interface BatchAccountCreateOptionalParams extends coreClient.OperationOptions {
|
|
1388
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1389
|
+
updateIntervalInMs?: number;
|
|
1390
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1391
|
+
resumeFrom?: string;
|
|
1392
|
+
}
|
|
1393
|
+
/** Contains response data for the create operation. */
|
|
1394
|
+
export declare type BatchAccountCreateResponse = BatchAccount;
|
|
1395
|
+
/** Optional parameters. */
|
|
1396
|
+
export interface BatchAccountUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1397
|
+
}
|
|
1398
|
+
/** Contains response data for the update operation. */
|
|
1399
|
+
export declare type BatchAccountUpdateResponse = BatchAccount;
|
|
1400
|
+
/** Optional parameters. */
|
|
1401
|
+
export interface BatchAccountDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1402
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1403
|
+
updateIntervalInMs?: number;
|
|
1404
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1405
|
+
resumeFrom?: string;
|
|
1406
|
+
}
|
|
1407
|
+
/** Optional parameters. */
|
|
1408
|
+
export interface BatchAccountGetOptionalParams extends coreClient.OperationOptions {
|
|
1409
|
+
}
|
|
1410
|
+
/** Contains response data for the get operation. */
|
|
1411
|
+
export declare type BatchAccountGetResponse = BatchAccount;
|
|
1412
|
+
/** Optional parameters. */
|
|
1413
|
+
export interface BatchAccountListOptionalParams extends coreClient.OperationOptions {
|
|
1414
|
+
}
|
|
1415
|
+
/** Contains response data for the list operation. */
|
|
1416
|
+
export declare type BatchAccountListResponse = BatchAccountListResult;
|
|
1417
|
+
/** Optional parameters. */
|
|
1418
|
+
export interface BatchAccountListByResourceGroupOptionalParams extends coreClient.OperationOptions {
|
|
1419
|
+
}
|
|
1420
|
+
/** Contains response data for the listByResourceGroup operation. */
|
|
1421
|
+
export declare type BatchAccountListByResourceGroupResponse = BatchAccountListResult;
|
|
1422
|
+
/** Optional parameters. */
|
|
1423
|
+
export interface BatchAccountSynchronizeAutoStorageKeysOptionalParams extends coreClient.OperationOptions {
|
|
1424
|
+
}
|
|
1425
|
+
/** Optional parameters. */
|
|
1426
|
+
export interface BatchAccountRegenerateKeyOptionalParams extends coreClient.OperationOptions {
|
|
1427
|
+
}
|
|
1428
|
+
/** Contains response data for the regenerateKey operation. */
|
|
1429
|
+
export declare type BatchAccountRegenerateKeyResponse = BatchAccountKeys;
|
|
1430
|
+
/** Optional parameters. */
|
|
1431
|
+
export interface BatchAccountGetKeysOptionalParams extends coreClient.OperationOptions {
|
|
1432
|
+
}
|
|
1433
|
+
/** Contains response data for the getKeys operation. */
|
|
1434
|
+
export declare type BatchAccountGetKeysResponse = BatchAccountKeys;
|
|
1435
|
+
/** Optional parameters. */
|
|
1436
|
+
export interface BatchAccountListOutboundNetworkDependenciesEndpointsOptionalParams extends coreClient.OperationOptions {
|
|
1437
|
+
}
|
|
1438
|
+
/** Contains response data for the listOutboundNetworkDependenciesEndpoints operation. */
|
|
1439
|
+
export declare type BatchAccountListOutboundNetworkDependenciesEndpointsResponse = OutboundEnvironmentEndpointCollection;
|
|
1440
|
+
/** Optional parameters. */
|
|
1441
|
+
export interface BatchAccountListNextOptionalParams extends coreClient.OperationOptions {
|
|
1442
|
+
}
|
|
1443
|
+
/** Contains response data for the listNext operation. */
|
|
1444
|
+
export declare type BatchAccountListNextResponse = BatchAccountListResult;
|
|
1445
|
+
/** Optional parameters. */
|
|
1446
|
+
export interface BatchAccountListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
|
|
1447
|
+
}
|
|
1448
|
+
/** Contains response data for the listByResourceGroupNext operation. */
|
|
1449
|
+
export declare type BatchAccountListByResourceGroupNextResponse = BatchAccountListResult;
|
|
1450
|
+
/** Optional parameters. */
|
|
1451
|
+
export interface BatchAccountListOutboundNetworkDependenciesEndpointsNextOptionalParams extends coreClient.OperationOptions {
|
|
1452
|
+
}
|
|
1453
|
+
/** Contains response data for the listOutboundNetworkDependenciesEndpointsNext operation. */
|
|
1454
|
+
export declare type BatchAccountListOutboundNetworkDependenciesEndpointsNextResponse = OutboundEnvironmentEndpointCollection;
|
|
1455
|
+
/** Optional parameters. */
|
|
1456
|
+
export interface ApplicationPackageActivateOptionalParams extends coreClient.OperationOptions {
|
|
1457
|
+
}
|
|
1458
|
+
/** Contains response data for the activate operation. */
|
|
1459
|
+
export declare type ApplicationPackageActivateResponse = ApplicationPackage;
|
|
1460
|
+
/** Optional parameters. */
|
|
1461
|
+
export interface ApplicationPackageCreateOptionalParams extends coreClient.OperationOptions {
|
|
1462
|
+
/** The parameters for the request. */
|
|
1463
|
+
parameters?: ApplicationPackage;
|
|
1464
|
+
}
|
|
1465
|
+
/** Contains response data for the create operation. */
|
|
1466
|
+
export declare type ApplicationPackageCreateResponse = ApplicationPackage;
|
|
1467
|
+
/** Optional parameters. */
|
|
1468
|
+
export interface ApplicationPackageDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1469
|
+
}
|
|
1470
|
+
/** Optional parameters. */
|
|
1471
|
+
export interface ApplicationPackageGetOptionalParams extends coreClient.OperationOptions {
|
|
1472
|
+
}
|
|
1473
|
+
/** Contains response data for the get operation. */
|
|
1474
|
+
export declare type ApplicationPackageGetResponse = ApplicationPackage;
|
|
1475
|
+
/** Optional parameters. */
|
|
1476
|
+
export interface ApplicationPackageListOptionalParams extends coreClient.OperationOptions {
|
|
1477
|
+
/** The maximum number of items to return in the response. */
|
|
1478
|
+
maxresults?: number;
|
|
1479
|
+
}
|
|
1480
|
+
/** Contains response data for the list operation. */
|
|
1481
|
+
export declare type ApplicationPackageListResponse = ListApplicationPackagesResult;
|
|
1482
|
+
/** Optional parameters. */
|
|
1483
|
+
export interface ApplicationPackageListNextOptionalParams extends coreClient.OperationOptions {
|
|
1484
|
+
/** The maximum number of items to return in the response. */
|
|
1485
|
+
maxresults?: number;
|
|
1486
|
+
}
|
|
1487
|
+
/** Contains response data for the listNext operation. */
|
|
1488
|
+
export declare type ApplicationPackageListNextResponse = ListApplicationPackagesResult;
|
|
1489
|
+
/** Optional parameters. */
|
|
1490
|
+
export interface ApplicationCreateOptionalParams extends coreClient.OperationOptions {
|
|
1491
|
+
/** The parameters for the request. */
|
|
1492
|
+
parameters?: Application;
|
|
1493
|
+
}
|
|
1494
|
+
/** Contains response data for the create operation. */
|
|
1495
|
+
export declare type ApplicationCreateResponse = Application;
|
|
1496
|
+
/** Optional parameters. */
|
|
1497
|
+
export interface ApplicationDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1498
|
+
}
|
|
1499
|
+
/** Optional parameters. */
|
|
1500
|
+
export interface ApplicationGetOptionalParams extends coreClient.OperationOptions {
|
|
1501
|
+
}
|
|
1502
|
+
/** Contains response data for the get operation. */
|
|
1503
|
+
export declare type ApplicationGetResponse = Application;
|
|
1504
|
+
/** Optional parameters. */
|
|
1505
|
+
export interface ApplicationUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1506
|
+
}
|
|
1507
|
+
/** Contains response data for the update operation. */
|
|
1508
|
+
export declare type ApplicationUpdateResponse = Application;
|
|
1509
|
+
/** Optional parameters. */
|
|
1510
|
+
export interface ApplicationListOptionalParams extends coreClient.OperationOptions {
|
|
1511
|
+
/** The maximum number of items to return in the response. */
|
|
1512
|
+
maxresults?: number;
|
|
1513
|
+
}
|
|
1514
|
+
/** Contains response data for the list operation. */
|
|
1515
|
+
export declare type ApplicationListResponse = ListApplicationsResult;
|
|
1516
|
+
/** Optional parameters. */
|
|
1517
|
+
export interface ApplicationListNextOptionalParams extends coreClient.OperationOptions {
|
|
1518
|
+
/** The maximum number of items to return in the response. */
|
|
1519
|
+
maxresults?: number;
|
|
1520
|
+
}
|
|
1521
|
+
/** Contains response data for the listNext operation. */
|
|
1522
|
+
export declare type ApplicationListNextResponse = ListApplicationsResult;
|
|
1523
|
+
/** Optional parameters. */
|
|
1524
|
+
export interface LocationGetQuotasOptionalParams extends coreClient.OperationOptions {
|
|
1525
|
+
}
|
|
1526
|
+
/** Contains response data for the getQuotas operation. */
|
|
1527
|
+
export declare type LocationGetQuotasResponse = BatchLocationQuota;
|
|
1528
|
+
/** Optional parameters. */
|
|
1529
|
+
export interface LocationListSupportedVirtualMachineSkusOptionalParams extends coreClient.OperationOptions {
|
|
1530
|
+
/** The maximum number of items to return in the response. */
|
|
1531
|
+
maxresults?: number;
|
|
1532
|
+
/** OData filter expression. Valid properties for filtering are "familyName". */
|
|
1533
|
+
filter?: string;
|
|
1534
|
+
}
|
|
1535
|
+
/** Contains response data for the listSupportedVirtualMachineSkus operation. */
|
|
1536
|
+
export declare type LocationListSupportedVirtualMachineSkusResponse = SupportedSkusResult;
|
|
1537
|
+
/** Optional parameters. */
|
|
1538
|
+
export interface LocationListSupportedCloudServiceSkusOptionalParams extends coreClient.OperationOptions {
|
|
1539
|
+
/** The maximum number of items to return in the response. */
|
|
1540
|
+
maxresults?: number;
|
|
1541
|
+
/** OData filter expression. Valid properties for filtering are "familyName". */
|
|
1542
|
+
filter?: string;
|
|
1543
|
+
}
|
|
1544
|
+
/** Contains response data for the listSupportedCloudServiceSkus operation. */
|
|
1545
|
+
export declare type LocationListSupportedCloudServiceSkusResponse = SupportedSkusResult;
|
|
1546
|
+
/** Optional parameters. */
|
|
1547
|
+
export interface LocationCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
|
|
1548
|
+
}
|
|
1549
|
+
/** Contains response data for the checkNameAvailability operation. */
|
|
1550
|
+
export declare type LocationCheckNameAvailabilityResponse = CheckNameAvailabilityResult;
|
|
1551
|
+
/** Optional parameters. */
|
|
1552
|
+
export interface LocationListSupportedVirtualMachineSkusNextOptionalParams extends coreClient.OperationOptions {
|
|
1553
|
+
/** The maximum number of items to return in the response. */
|
|
1554
|
+
maxresults?: number;
|
|
1555
|
+
/** OData filter expression. Valid properties for filtering are "familyName". */
|
|
1556
|
+
filter?: string;
|
|
1557
|
+
}
|
|
1558
|
+
/** Contains response data for the listSupportedVirtualMachineSkusNext operation. */
|
|
1559
|
+
export declare type LocationListSupportedVirtualMachineSkusNextResponse = SupportedSkusResult;
|
|
1560
|
+
/** Optional parameters. */
|
|
1561
|
+
export interface LocationListSupportedCloudServiceSkusNextOptionalParams extends coreClient.OperationOptions {
|
|
1562
|
+
/** The maximum number of items to return in the response. */
|
|
1563
|
+
maxresults?: number;
|
|
1564
|
+
/** OData filter expression. Valid properties for filtering are "familyName". */
|
|
1565
|
+
filter?: string;
|
|
1566
|
+
}
|
|
1567
|
+
/** Contains response data for the listSupportedCloudServiceSkusNext operation. */
|
|
1568
|
+
export declare type LocationListSupportedCloudServiceSkusNextResponse = SupportedSkusResult;
|
|
1569
|
+
/** Optional parameters. */
|
|
1570
|
+
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
|
|
1571
|
+
}
|
|
1572
|
+
/** Contains response data for the list operation. */
|
|
1573
|
+
export declare type OperationsListResponse = OperationListResult;
|
|
1574
|
+
/** Optional parameters. */
|
|
1575
|
+
export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
|
|
1576
|
+
}
|
|
1577
|
+
/** Contains response data for the listNext operation. */
|
|
1578
|
+
export declare type OperationsListNextResponse = OperationListResult;
|
|
1579
|
+
/** Optional parameters. */
|
|
1580
|
+
export interface CertificateListByBatchAccountOptionalParams extends coreClient.OperationOptions {
|
|
1581
|
+
/** The maximum number of items to return in the response. */
|
|
1582
|
+
maxresults?: number;
|
|
1583
|
+
/** OData filter expression. Valid properties for filtering are "properties/provisioningState", "properties/provisioningStateTransitionTime", "name". */
|
|
1584
|
+
filter?: string;
|
|
1585
|
+
/** Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. */
|
|
1586
|
+
select?: string;
|
|
1587
|
+
}
|
|
1588
|
+
/** Contains response data for the listByBatchAccount operation. */
|
|
1589
|
+
export declare type CertificateListByBatchAccountResponse = ListCertificatesResult;
|
|
1590
|
+
/** Optional parameters. */
|
|
1591
|
+
export interface CertificateCreateOptionalParams extends coreClient.OperationOptions {
|
|
1592
|
+
/** The entity state (ETag) version of the certificate to update. A value of "*" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied. */
|
|
1593
|
+
ifMatch?: string;
|
|
1594
|
+
/** Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored. */
|
|
1595
|
+
ifNoneMatch?: string;
|
|
1596
|
+
}
|
|
1597
|
+
/** Contains response data for the create operation. */
|
|
1598
|
+
export declare type CertificateCreateResponse = CertificateCreateHeaders & Certificate;
|
|
1599
|
+
/** Optional parameters. */
|
|
1600
|
+
export interface CertificateUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1601
|
+
/** The entity state (ETag) version of the certificate to update. This value can be omitted or set to "*" to apply the operation unconditionally. */
|
|
1602
|
+
ifMatch?: string;
|
|
1603
|
+
}
|
|
1604
|
+
/** Contains response data for the update operation. */
|
|
1605
|
+
export declare type CertificateUpdateResponse = CertificateUpdateHeaders & Certificate;
|
|
1606
|
+
/** Optional parameters. */
|
|
1607
|
+
export interface CertificateDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1608
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1609
|
+
updateIntervalInMs?: number;
|
|
1610
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1611
|
+
resumeFrom?: string;
|
|
1612
|
+
}
|
|
1613
|
+
/** Optional parameters. */
|
|
1614
|
+
export interface CertificateGetOptionalParams extends coreClient.OperationOptions {
|
|
1615
|
+
}
|
|
1616
|
+
/** Contains response data for the get operation. */
|
|
1617
|
+
export declare type CertificateGetResponse = CertificateGetHeaders & Certificate;
|
|
1618
|
+
/** Optional parameters. */
|
|
1619
|
+
export interface CertificateCancelDeletionOptionalParams extends coreClient.OperationOptions {
|
|
1620
|
+
}
|
|
1621
|
+
/** Contains response data for the cancelDeletion operation. */
|
|
1622
|
+
export declare type CertificateCancelDeletionResponse = CertificateCancelDeletionHeaders & Certificate;
|
|
1623
|
+
/** Optional parameters. */
|
|
1624
|
+
export interface CertificateListByBatchAccountNextOptionalParams extends coreClient.OperationOptions {
|
|
1625
|
+
/** The maximum number of items to return in the response. */
|
|
1626
|
+
maxresults?: number;
|
|
1627
|
+
/** OData filter expression. Valid properties for filtering are "properties/provisioningState", "properties/provisioningStateTransitionTime", "name". */
|
|
1628
|
+
filter?: string;
|
|
1629
|
+
/** Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. */
|
|
1630
|
+
select?: string;
|
|
1631
|
+
}
|
|
1632
|
+
/** Contains response data for the listByBatchAccountNext operation. */
|
|
1633
|
+
export declare type CertificateListByBatchAccountNextResponse = ListCertificatesResult;
|
|
1634
|
+
/** Optional parameters. */
|
|
1635
|
+
export interface PrivateLinkResourceListByBatchAccountOptionalParams extends coreClient.OperationOptions {
|
|
1636
|
+
/** The maximum number of items to return in the response. */
|
|
1637
|
+
maxresults?: number;
|
|
1638
|
+
}
|
|
1639
|
+
/** Contains response data for the listByBatchAccount operation. */
|
|
1640
|
+
export declare type PrivateLinkResourceListByBatchAccountResponse = ListPrivateLinkResourcesResult;
|
|
1641
|
+
/** Optional parameters. */
|
|
1642
|
+
export interface PrivateLinkResourceGetOptionalParams extends coreClient.OperationOptions {
|
|
1643
|
+
}
|
|
1644
|
+
/** Contains response data for the get operation. */
|
|
1645
|
+
export declare type PrivateLinkResourceGetResponse = PrivateLinkResource;
|
|
1646
|
+
/** Optional parameters. */
|
|
1647
|
+
export interface PrivateLinkResourceListByBatchAccountNextOptionalParams extends coreClient.OperationOptions {
|
|
1648
|
+
/** The maximum number of items to return in the response. */
|
|
1649
|
+
maxresults?: number;
|
|
1650
|
+
}
|
|
1651
|
+
/** Contains response data for the listByBatchAccountNext operation. */
|
|
1652
|
+
export declare type PrivateLinkResourceListByBatchAccountNextResponse = ListPrivateLinkResourcesResult;
|
|
1653
|
+
/** Optional parameters. */
|
|
1654
|
+
export interface PrivateEndpointConnectionListByBatchAccountOptionalParams extends coreClient.OperationOptions {
|
|
1655
|
+
/** The maximum number of items to return in the response. */
|
|
1656
|
+
maxresults?: number;
|
|
1657
|
+
}
|
|
1658
|
+
/** Contains response data for the listByBatchAccount operation. */
|
|
1659
|
+
export declare type PrivateEndpointConnectionListByBatchAccountResponse = ListPrivateEndpointConnectionsResult;
|
|
1660
|
+
/** Optional parameters. */
|
|
1661
|
+
export interface PrivateEndpointConnectionGetOptionalParams extends coreClient.OperationOptions {
|
|
1662
|
+
}
|
|
1663
|
+
/** Contains response data for the get operation. */
|
|
1664
|
+
export declare type PrivateEndpointConnectionGetResponse = PrivateEndpointConnection;
|
|
1665
|
+
/** Optional parameters. */
|
|
1666
|
+
export interface PrivateEndpointConnectionUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1667
|
+
/** The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to "*" to apply the operation unconditionally. */
|
|
1668
|
+
ifMatch?: string;
|
|
1669
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1670
|
+
updateIntervalInMs?: number;
|
|
1671
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1672
|
+
resumeFrom?: string;
|
|
1673
|
+
}
|
|
1674
|
+
/** Contains response data for the update operation. */
|
|
1675
|
+
export declare type PrivateEndpointConnectionUpdateResponse = PrivateEndpointConnection;
|
|
1676
|
+
/** Optional parameters. */
|
|
1677
|
+
export interface PrivateEndpointConnectionListByBatchAccountNextOptionalParams extends coreClient.OperationOptions {
|
|
1678
|
+
/** The maximum number of items to return in the response. */
|
|
1679
|
+
maxresults?: number;
|
|
1680
|
+
}
|
|
1681
|
+
/** Contains response data for the listByBatchAccountNext operation. */
|
|
1682
|
+
export declare type PrivateEndpointConnectionListByBatchAccountNextResponse = ListPrivateEndpointConnectionsResult;
|
|
1683
|
+
/** Optional parameters. */
|
|
1684
|
+
export interface PoolListByBatchAccountOptionalParams extends coreClient.OperationOptions {
|
|
1685
|
+
/** The maximum number of items to return in the response. */
|
|
1686
|
+
maxresults?: number;
|
|
1687
|
+
/**
|
|
1688
|
+
* OData filter expression. Valid properties for filtering are:
|
|
1689
|
+
*
|
|
1690
|
+
* name
|
|
1691
|
+
* properties/allocationState
|
|
1692
|
+
* properties/allocationStateTransitionTime
|
|
1693
|
+
* properties/creationTime
|
|
1694
|
+
* properties/provisioningState
|
|
1695
|
+
* properties/provisioningStateTransitionTime
|
|
1696
|
+
* properties/lastModified
|
|
1697
|
+
* properties/vmSize
|
|
1698
|
+
* properties/interNodeCommunication
|
|
1699
|
+
* properties/scaleSettings/autoScale
|
|
1700
|
+
* properties/scaleSettings/fixedScale
|
|
1701
|
+
*/
|
|
1702
|
+
filter?: string;
|
|
1703
|
+
/** Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. */
|
|
1704
|
+
select?: string;
|
|
1705
|
+
}
|
|
1706
|
+
/** Contains response data for the listByBatchAccount operation. */
|
|
1707
|
+
export declare type PoolListByBatchAccountResponse = ListPoolsResult;
|
|
1708
|
+
/** Optional parameters. */
|
|
1709
|
+
export interface PoolCreateOptionalParams extends coreClient.OperationOptions {
|
|
1710
|
+
/** The entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. */
|
|
1711
|
+
ifMatch?: string;
|
|
1712
|
+
/** Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored. */
|
|
1713
|
+
ifNoneMatch?: string;
|
|
1714
|
+
}
|
|
1715
|
+
/** Contains response data for the create operation. */
|
|
1716
|
+
export declare type PoolCreateResponse = PoolCreateHeaders & Pool;
|
|
1717
|
+
/** Optional parameters. */
|
|
1718
|
+
export interface PoolUpdateOptionalParams extends coreClient.OperationOptions {
|
|
1719
|
+
/** The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally. */
|
|
1720
|
+
ifMatch?: string;
|
|
1721
|
+
}
|
|
1722
|
+
/** Contains response data for the update operation. */
|
|
1723
|
+
export declare type PoolUpdateResponse = PoolUpdateHeaders & Pool;
|
|
1724
|
+
/** Optional parameters. */
|
|
1725
|
+
export interface PoolDeleteOptionalParams extends coreClient.OperationOptions {
|
|
1726
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
1727
|
+
updateIntervalInMs?: number;
|
|
1728
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
1729
|
+
resumeFrom?: string;
|
|
1730
|
+
}
|
|
1731
|
+
/** Optional parameters. */
|
|
1732
|
+
export interface PoolGetOptionalParams extends coreClient.OperationOptions {
|
|
1733
|
+
}
|
|
1734
|
+
/** Contains response data for the get operation. */
|
|
1735
|
+
export declare type PoolGetResponse = PoolGetHeaders & Pool;
|
|
1736
|
+
/** Optional parameters. */
|
|
1737
|
+
export interface PoolDisableAutoScaleOptionalParams extends coreClient.OperationOptions {
|
|
1738
|
+
}
|
|
1739
|
+
/** Contains response data for the disableAutoScale operation. */
|
|
1740
|
+
export declare type PoolDisableAutoScaleResponse = PoolDisableAutoScaleHeaders & Pool;
|
|
1741
|
+
/** Optional parameters. */
|
|
1742
|
+
export interface PoolStopResizeOptionalParams extends coreClient.OperationOptions {
|
|
1743
|
+
}
|
|
1744
|
+
/** Contains response data for the stopResize operation. */
|
|
1745
|
+
export declare type PoolStopResizeResponse = PoolStopResizeHeaders & Pool;
|
|
1746
|
+
/** Optional parameters. */
|
|
1747
|
+
export interface PoolListByBatchAccountNextOptionalParams extends coreClient.OperationOptions {
|
|
1748
|
+
/** The maximum number of items to return in the response. */
|
|
1749
|
+
maxresults?: number;
|
|
1750
|
+
/**
|
|
1751
|
+
* OData filter expression. Valid properties for filtering are:
|
|
1752
|
+
*
|
|
1753
|
+
* name
|
|
1754
|
+
* properties/allocationState
|
|
1755
|
+
* properties/allocationStateTransitionTime
|
|
1756
|
+
* properties/creationTime
|
|
1757
|
+
* properties/provisioningState
|
|
1758
|
+
* properties/provisioningStateTransitionTime
|
|
1759
|
+
* properties/lastModified
|
|
1760
|
+
* properties/vmSize
|
|
1761
|
+
* properties/interNodeCommunication
|
|
1762
|
+
* properties/scaleSettings/autoScale
|
|
1763
|
+
* properties/scaleSettings/fixedScale
|
|
1764
|
+
*/
|
|
1765
|
+
filter?: string;
|
|
1766
|
+
/** Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection. */
|
|
1767
|
+
select?: string;
|
|
1768
|
+
}
|
|
1769
|
+
/** Contains response data for the listByBatchAccountNext operation. */
|
|
1770
|
+
export declare type PoolListByBatchAccountNextResponse = ListPoolsResult;
|
|
1771
|
+
/** Optional parameters. */
|
|
1772
|
+
export interface BatchManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
1773
|
+
/** server parameter */
|
|
1774
|
+
$host?: string;
|
|
1775
|
+
/** Api Version */
|
|
1776
|
+
apiVersion?: string;
|
|
1777
|
+
/** Overrides client endpoint. */
|
|
1778
|
+
endpoint?: string;
|
|
1779
|
+
}
|
|
1780
|
+
//# sourceMappingURL=index.d.ts.map
|