@azure/arm-containerinstance 6.3.0 → 8.0.0
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 +11 -0
- package/{LICENSE.txt → LICENSE} +2 -2
- package/README.md +70 -78
- package/dist/index.js +3335 -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/containerInstanceManagementClient.d.ts +22 -0
- package/dist-esm/src/containerInstanceManagementClient.d.ts.map +1 -0
- package/dist-esm/src/containerInstanceManagementClient.js +55 -0
- package/dist-esm/src/containerInstanceManagementClient.js.map +1 -0
- package/dist-esm/src/index.d.ts +5 -0
- package/dist-esm/src/index.d.ts.map +1 -0
- package/dist-esm/src/index.js +12 -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 +964 -0
- package/dist-esm/src/models/index.d.ts.map +1 -0
- package/dist-esm/src/models/index.js +70 -0
- package/dist-esm/src/models/index.js.map +1 -0
- package/dist-esm/src/models/mappers.d.ts +54 -0
- package/dist-esm/src/models/mappers.d.ts.map +1 -0
- package/{esm → dist-esm/src}/models/mappers.js +799 -788
- package/dist-esm/src/models/mappers.js.map +1 -0
- package/dist-esm/src/models/parameters.d.ts +17 -0
- package/dist-esm/src/models/parameters.d.ts.map +1 -0
- package/{esm → dist-esm/src}/models/parameters.js +67 -37
- package/dist-esm/src/models/parameters.js.map +1 -0
- package/dist-esm/src/operations/containerGroups.d.ts +159 -0
- package/dist-esm/src/operations/containerGroups.d.ts.map +1 -0
- package/dist-esm/src/operations/containerGroups.js +678 -0
- package/dist-esm/src/operations/containerGroups.js.map +1 -0
- package/dist-esm/src/operations/containers.d.ts +40 -0
- package/dist-esm/src/operations/containers.d.ts.map +1 -0
- package/dist-esm/src/operations/containers.js +134 -0
- package/dist-esm/src/operations/containers.js.map +1 -0
- package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
- package/dist-esm/src/operations/index.d.ts.map +1 -0
- package/{esm → dist-esm/src}/operations/index.js +1 -2
- package/dist-esm/src/operations/index.js.map +1 -0
- package/dist-esm/src/operations/location.d.ts +70 -0
- package/dist-esm/src/operations/location.d.ts.map +1 -0
- package/dist-esm/src/operations/location.js +310 -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/operationsInterfaces/containerGroups.d.ts +119 -0
- package/dist-esm/src/operationsInterfaces/containerGroups.d.ts.map +1 -0
- package/{src/models/operationsMappers.ts → dist-esm/src/operationsInterfaces/containerGroups.js} +2 -7
- package/dist-esm/src/operationsInterfaces/containerGroups.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/containers.d.ts +32 -0
- package/dist-esm/src/operationsInterfaces/containers.d.ts.map +1 -0
- package/{esm/models/operationsMappers.js → dist-esm/src/operationsInterfaces/containers.js} +2 -2
- package/dist-esm/src/operationsInterfaces/containers.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts +5 -0
- package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
- package/dist-esm/src/operationsInterfaces/index.js +12 -0
- package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/src/operationsInterfaces/location.d.ts +24 -0
- package/dist-esm/src/operationsInterfaces/location.d.ts.map +1 -0
- package/{esm/models/index.js → dist-esm/src/operationsInterfaces/location.js} +2 -1
- 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/{src/models/containersMappers.ts → dist-esm/src/operationsInterfaces/operations.js} +2 -9
- package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
- package/dist-esm/test/containerinstance_examples.d.ts +4 -0
- package/dist-esm/test/containerinstance_examples.d.ts.map +1 -0
- package/dist-esm/test/containerinstance_examples.js +156 -0
- package/dist-esm/test/containerinstance_examples.js.map +1 -0
- package/package.json +65 -32
- package/review/arm-containerinstance.api.md +752 -0
- package/rollup.config.js +181 -30
- package/src/containerInstanceManagementClient.ts +78 -40
- package/src/index.ts +12 -0
- package/src/lroImpl.ts +34 -0
- package/src/models/index.ts +734 -1215
- package/src/models/mappers.ts +808 -793
- package/src/models/parameters.ts +90 -38
- package/src/operations/containerGroups.ts +660 -424
- package/src/operations/containers.ts +89 -143
- package/src/operations/index.ts +1 -2
- package/src/operations/location.ts +262 -179
- package/src/operations/operations.ts +85 -73
- package/src/operationsInterfaces/containerGroups.ts +212 -0
- package/src/operationsInterfaces/containers.ts +64 -0
- package/src/operationsInterfaces/index.ts +12 -0
- package/src/operationsInterfaces/location.ts +49 -0
- package/src/operationsInterfaces/operations.ts +22 -0
- package/tsconfig.json +3 -3
- package/types/arm-containerinstance.d.ts +1282 -0
- package/types/tsdoc-metadata.json +11 -0
- package/dist/arm-containerinstance.js +0 -3019
- package/dist/arm-containerinstance.js.map +0 -1
- package/dist/arm-containerinstance.min.js +0 -1
- package/dist/arm-containerinstance.min.js.map +0 -1
- package/esm/containerInstanceManagementClient.d.ts +0 -28
- package/esm/containerInstanceManagementClient.d.ts.map +0 -1
- package/esm/containerInstanceManagementClient.js +0 -41
- package/esm/containerInstanceManagementClient.js.map +0 -1
- package/esm/containerInstanceManagementClientContext.d.ts +0 -23
- package/esm/containerInstanceManagementClientContext.d.ts.map +0 -1
- package/esm/containerInstanceManagementClientContext.js +0 -61
- package/esm/containerInstanceManagementClientContext.js.map +0 -1
- package/esm/models/containerGroupsMappers.d.ts +0 -2
- package/esm/models/containerGroupsMappers.d.ts.map +0 -1
- package/esm/models/containerGroupsMappers.js +0 -9
- package/esm/models/containerGroupsMappers.js.map +0 -1
- package/esm/models/containersMappers.d.ts +0 -2
- package/esm/models/containersMappers.d.ts.map +0 -1
- package/esm/models/containersMappers.js +0 -9
- package/esm/models/containersMappers.js.map +0 -1
- package/esm/models/index.d.ts +0 -1469
- package/esm/models/index.d.ts.map +0 -1
- 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 -9
- package/esm/models/locationMappers.js.map +0 -1
- package/esm/models/mappers.d.ts +0 -54
- 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.map +0 -1
- package/esm/models/parameters.d.ts +0 -12
- package/esm/models/parameters.d.ts.map +0 -1
- package/esm/models/parameters.js.map +0 -1
- package/esm/operations/containerGroups.d.ts +0 -247
- package/esm/operations/containerGroups.d.ts.map +0 -1
- package/esm/operations/containerGroups.js +0 -455
- package/esm/operations/containerGroups.js.map +0 -1
- package/esm/operations/containers.d.ts +0 -94
- package/esm/operations/containers.d.ts.map +0 -1
- package/esm/operations/containers.js +0 -133
- package/esm/operations/containers.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 -107
- package/esm/operations/location.d.ts.map +0 -1
- package/esm/operations/location.js +0 -171
- 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 -79
- package/esm/operations/operations.js.map +0 -1
- package/src/containerInstanceManagementClientContext.ts +0 -68
- package/src/models/containerGroupsMappers.ts +0 -46
- package/src/models/locationMappers.ts +0 -19
|
@@ -0,0 +1,1282 @@
|
|
|
1
|
+
import * as coreAuth from '@azure/core-auth';
|
|
2
|
+
import * as coreClient from '@azure/core-client';
|
|
3
|
+
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
|
4
|
+
import { PollerLike } from '@azure/core-lro';
|
|
5
|
+
import { PollOperationState } from '@azure/core-lro';
|
|
6
|
+
|
|
7
|
+
/** The properties of the Azure File volume. Azure File shares are mounted as volumes. */
|
|
8
|
+
export declare interface AzureFileVolume {
|
|
9
|
+
/** The name of the Azure File share to be mounted as a volume. */
|
|
10
|
+
shareName: string;
|
|
11
|
+
/** The flag indicating whether the Azure File shared mounted as a volume is read-only. */
|
|
12
|
+
readOnly?: boolean;
|
|
13
|
+
/** The name of the storage account that contains the Azure File share. */
|
|
14
|
+
storageAccountName: string;
|
|
15
|
+
/** The storage account access key used to access the Azure File share. */
|
|
16
|
+
storageAccountKey?: string;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/** The cached image and OS type. */
|
|
20
|
+
export declare interface CachedImages {
|
|
21
|
+
/** The OS type of the cached image. */
|
|
22
|
+
osType: string;
|
|
23
|
+
/** The cached image name. */
|
|
24
|
+
image: string;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/** The response containing cached images. */
|
|
28
|
+
export declare interface CachedImagesListResult {
|
|
29
|
+
/** The list of cached images. */
|
|
30
|
+
value?: CachedImages[];
|
|
31
|
+
/** The URI to fetch the next page of cached images. */
|
|
32
|
+
nextLink?: string;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/** The regional capabilities. */
|
|
36
|
+
export declare interface Capabilities {
|
|
37
|
+
/**
|
|
38
|
+
* The resource type that this capability describes.
|
|
39
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
40
|
+
*/
|
|
41
|
+
readonly resourceType?: string;
|
|
42
|
+
/**
|
|
43
|
+
* The OS type that this capability describes.
|
|
44
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
45
|
+
*/
|
|
46
|
+
readonly osType?: string;
|
|
47
|
+
/**
|
|
48
|
+
* The resource location.
|
|
49
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
50
|
+
*/
|
|
51
|
+
readonly location?: string;
|
|
52
|
+
/**
|
|
53
|
+
* The ip address type that this capability describes.
|
|
54
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
55
|
+
*/
|
|
56
|
+
readonly ipAddressType?: string;
|
|
57
|
+
/**
|
|
58
|
+
* The GPU sku that this capability describes.
|
|
59
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
60
|
+
*/
|
|
61
|
+
readonly gpu?: string;
|
|
62
|
+
/**
|
|
63
|
+
* The supported capabilities.
|
|
64
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
65
|
+
*/
|
|
66
|
+
readonly capabilities?: CapabilitiesCapabilities;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/** The supported capabilities. */
|
|
70
|
+
export declare interface CapabilitiesCapabilities {
|
|
71
|
+
/**
|
|
72
|
+
* The maximum allowed memory request in GB.
|
|
73
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
74
|
+
*/
|
|
75
|
+
readonly maxMemoryInGB?: number;
|
|
76
|
+
/**
|
|
77
|
+
* The maximum allowed CPU request in cores.
|
|
78
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
79
|
+
*/
|
|
80
|
+
readonly maxCpu?: number;
|
|
81
|
+
/**
|
|
82
|
+
* The maximum allowed GPU count.
|
|
83
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
84
|
+
*/
|
|
85
|
+
readonly maxGpuCount?: number;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/** The response containing list of capabilities. */
|
|
89
|
+
export declare interface CapabilitiesListResult {
|
|
90
|
+
/** The list of capabilities. */
|
|
91
|
+
value?: Capabilities[];
|
|
92
|
+
/** The URI to fetch the next page of capabilities. */
|
|
93
|
+
nextLink?: string;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/** An error response from the Container Instance service. */
|
|
97
|
+
export declare interface CloudError {
|
|
98
|
+
/** An error response from the Container Instance service. */
|
|
99
|
+
error?: CloudErrorBody;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/** An error response from the Container Instance service. */
|
|
103
|
+
export declare interface CloudErrorBody {
|
|
104
|
+
/** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
|
|
105
|
+
code?: string;
|
|
106
|
+
/** A message describing the error, intended to be suitable for display in a user interface. */
|
|
107
|
+
message?: string;
|
|
108
|
+
/** The target of the particular error. For example, the name of the property in error. */
|
|
109
|
+
target?: string;
|
|
110
|
+
/** A list of additional details about the error. */
|
|
111
|
+
details?: CloudErrorBody[];
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export declare interface Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties {
|
|
115
|
+
/**
|
|
116
|
+
* The principal id of user assigned identity.
|
|
117
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
118
|
+
*/
|
|
119
|
+
readonly principalId?: string;
|
|
120
|
+
/**
|
|
121
|
+
* The client id of user assigned identity.
|
|
122
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
123
|
+
*/
|
|
124
|
+
readonly clientId?: string;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
/** A container instance. */
|
|
128
|
+
export declare interface Container {
|
|
129
|
+
/** The user-provided name of the container instance. */
|
|
130
|
+
name: string;
|
|
131
|
+
/** The name of the image used to create the container instance. */
|
|
132
|
+
image: string;
|
|
133
|
+
/** The commands to execute within the container instance in exec form. */
|
|
134
|
+
command?: string[];
|
|
135
|
+
/** The exposed ports on the container instance. */
|
|
136
|
+
ports?: ContainerPort[];
|
|
137
|
+
/** The environment variables to set in the container instance. */
|
|
138
|
+
environmentVariables?: EnvironmentVariable[];
|
|
139
|
+
/**
|
|
140
|
+
* The instance view of the container instance. Only valid in response.
|
|
141
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
142
|
+
*/
|
|
143
|
+
readonly instanceView?: ContainerPropertiesInstanceView;
|
|
144
|
+
/** The resource requirements of the container instance. */
|
|
145
|
+
resources: ResourceRequirements;
|
|
146
|
+
/** The volume mounts available to the container instance. */
|
|
147
|
+
volumeMounts?: VolumeMount[];
|
|
148
|
+
/** The liveness probe. */
|
|
149
|
+
livenessProbe?: ContainerProbe;
|
|
150
|
+
/** The readiness probe. */
|
|
151
|
+
readinessProbe?: ContainerProbe;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/** The information for the output stream from container attach. */
|
|
155
|
+
export declare interface ContainerAttachResponse {
|
|
156
|
+
/** The uri for the output stream from the attach. */
|
|
157
|
+
webSocketUri?: string;
|
|
158
|
+
/** The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri. */
|
|
159
|
+
password?: string;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
/** The container execution command, for liveness or readiness probe */
|
|
163
|
+
export declare interface ContainerExec {
|
|
164
|
+
/** The commands to execute within the container. */
|
|
165
|
+
command?: string[];
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
/** The container exec request. */
|
|
169
|
+
export declare interface ContainerExecRequest {
|
|
170
|
+
/** The command to be executed. */
|
|
171
|
+
command?: string;
|
|
172
|
+
/** The size of the terminal. */
|
|
173
|
+
terminalSize?: ContainerExecRequestTerminalSize;
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
/** The size of the terminal. */
|
|
177
|
+
export declare interface ContainerExecRequestTerminalSize {
|
|
178
|
+
/** The row size of the terminal */
|
|
179
|
+
rows?: number;
|
|
180
|
+
/** The column size of the terminal */
|
|
181
|
+
cols?: number;
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
/** The information for the container exec command. */
|
|
185
|
+
export declare interface ContainerExecResponse {
|
|
186
|
+
/** The uri for the exec websocket. */
|
|
187
|
+
webSocketUri?: string;
|
|
188
|
+
/** The password to start the exec command. */
|
|
189
|
+
password?: string;
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/** A container group. */
|
|
193
|
+
export declare type ContainerGroup = Resource & {
|
|
194
|
+
/** The identity of the container group, if configured. */
|
|
195
|
+
identity?: ContainerGroupIdentity;
|
|
196
|
+
/**
|
|
197
|
+
* The provisioning state of the container group. This only appears in the response.
|
|
198
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
199
|
+
*/
|
|
200
|
+
readonly provisioningState?: string;
|
|
201
|
+
/** The containers within the container group. */
|
|
202
|
+
containers: Container[];
|
|
203
|
+
/** The image registry credentials by which the container group is created from. */
|
|
204
|
+
imageRegistryCredentials?: ImageRegistryCredential[];
|
|
205
|
+
/**
|
|
206
|
+
* Restart policy for all containers within the container group.
|
|
207
|
+
* - `Always` Always restart
|
|
208
|
+
* - `OnFailure` Restart on failure
|
|
209
|
+
* - `Never` Never restart
|
|
210
|
+
*
|
|
211
|
+
*/
|
|
212
|
+
restartPolicy?: ContainerGroupRestartPolicy;
|
|
213
|
+
/** The IP address type of the container group. */
|
|
214
|
+
ipAddress?: IpAddress;
|
|
215
|
+
/** The operating system type required by the containers in the container group. */
|
|
216
|
+
osType: OperatingSystemTypes;
|
|
217
|
+
/** The list of volumes that can be mounted by containers in this container group. */
|
|
218
|
+
volumes?: Volume[];
|
|
219
|
+
/**
|
|
220
|
+
* The instance view of the container group. Only valid in response.
|
|
221
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
222
|
+
*/
|
|
223
|
+
readonly instanceView?: ContainerGroupPropertiesInstanceView;
|
|
224
|
+
/** The diagnostic information for a container group. */
|
|
225
|
+
diagnostics?: ContainerGroupDiagnostics;
|
|
226
|
+
/** The subnet resource IDs for a container group. */
|
|
227
|
+
subnetIds?: ContainerGroupSubnetId[];
|
|
228
|
+
/** The DNS config information for a container group. */
|
|
229
|
+
dnsConfig?: DnsConfiguration;
|
|
230
|
+
/** The SKU for a container group. */
|
|
231
|
+
sku?: ContainerGroupSku;
|
|
232
|
+
/** The encryption properties for a container group. */
|
|
233
|
+
encryptionProperties?: EncryptionProperties;
|
|
234
|
+
/** The init containers for a container group. */
|
|
235
|
+
initContainers?: InitContainerDefinition[];
|
|
236
|
+
};
|
|
237
|
+
|
|
238
|
+
/** Container group diagnostic information. */
|
|
239
|
+
export declare interface ContainerGroupDiagnostics {
|
|
240
|
+
/** Container group log analytics information. */
|
|
241
|
+
logAnalytics?: LogAnalytics;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
/** Identity for the container group. */
|
|
245
|
+
export declare interface ContainerGroupIdentity {
|
|
246
|
+
/**
|
|
247
|
+
* The principal id of the container group identity. This property will only be provided for a system assigned identity.
|
|
248
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
249
|
+
*/
|
|
250
|
+
readonly principalId?: string;
|
|
251
|
+
/**
|
|
252
|
+
* The tenant id associated with the container group. This property will only be provided for a system assigned identity.
|
|
253
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
254
|
+
*/
|
|
255
|
+
readonly tenantId?: string;
|
|
256
|
+
/** The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group. */
|
|
257
|
+
type?: ResourceIdentityType;
|
|
258
|
+
/** The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */
|
|
259
|
+
userAssignedIdentities?: {
|
|
260
|
+
[propertyName: string]: Components10Wh5UdSchemasContainergroupidentityPropertiesUserassignedidentitiesAdditionalproperties;
|
|
261
|
+
};
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Defines values for ContainerGroupIpAddressType. \
|
|
266
|
+
* {@link KnownContainerGroupIpAddressType} can be used interchangeably with ContainerGroupIpAddressType,
|
|
267
|
+
* this enum contains the known values that the service supports.
|
|
268
|
+
* ### Known values supported by the service
|
|
269
|
+
* **Public** \
|
|
270
|
+
* **Private**
|
|
271
|
+
*/
|
|
272
|
+
export declare type ContainerGroupIpAddressType = string;
|
|
273
|
+
|
|
274
|
+
/** The container group list response that contains the container group properties. */
|
|
275
|
+
export declare interface ContainerGroupListResult {
|
|
276
|
+
/** The list of container groups. */
|
|
277
|
+
value?: ContainerGroup[];
|
|
278
|
+
/** The URI to fetch the next page of container groups. */
|
|
279
|
+
nextLink?: string;
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* Defines values for ContainerGroupNetworkProtocol. \
|
|
284
|
+
* {@link KnownContainerGroupNetworkProtocol} can be used interchangeably with ContainerGroupNetworkProtocol,
|
|
285
|
+
* this enum contains the known values that the service supports.
|
|
286
|
+
* ### Known values supported by the service
|
|
287
|
+
* **TCP** \
|
|
288
|
+
* **UDP**
|
|
289
|
+
*/
|
|
290
|
+
export declare type ContainerGroupNetworkProtocol = string;
|
|
291
|
+
|
|
292
|
+
/** The instance view of the container group. Only valid in response. */
|
|
293
|
+
export declare interface ContainerGroupPropertiesInstanceView {
|
|
294
|
+
/**
|
|
295
|
+
* The events of this container group.
|
|
296
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
297
|
+
*/
|
|
298
|
+
readonly events?: Event_2[];
|
|
299
|
+
/**
|
|
300
|
+
* The state of the container group. Only valid in response.
|
|
301
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
302
|
+
*/
|
|
303
|
+
readonly state?: string;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* Defines values for ContainerGroupRestartPolicy. \
|
|
308
|
+
* {@link KnownContainerGroupRestartPolicy} can be used interchangeably with ContainerGroupRestartPolicy,
|
|
309
|
+
* this enum contains the known values that the service supports.
|
|
310
|
+
* ### Known values supported by the service
|
|
311
|
+
* **Always** \
|
|
312
|
+
* **OnFailure** \
|
|
313
|
+
* **Never**
|
|
314
|
+
*/
|
|
315
|
+
export declare type ContainerGroupRestartPolicy = string;
|
|
316
|
+
|
|
317
|
+
/** Interface representing a ContainerGroups. */
|
|
318
|
+
export declare interface ContainerGroups {
|
|
319
|
+
/**
|
|
320
|
+
* Get a list of container groups in the specified subscription. This operation returns properties of
|
|
321
|
+
* each container group including containers, image registry credentials, restart policy, IP address
|
|
322
|
+
* type, OS type, state, and volumes.
|
|
323
|
+
* @param options The options parameters.
|
|
324
|
+
*/
|
|
325
|
+
list(options?: ContainerGroupsListOptionalParams): PagedAsyncIterableIterator<ContainerGroup>;
|
|
326
|
+
/**
|
|
327
|
+
* Get a list of container groups in a specified subscription and resource group. This operation
|
|
328
|
+
* returns properties of each container group including containers, image registry credentials, restart
|
|
329
|
+
* policy, IP address type, OS type, state, and volumes.
|
|
330
|
+
* @param resourceGroupName The name of the resource group.
|
|
331
|
+
* @param options The options parameters.
|
|
332
|
+
*/
|
|
333
|
+
listByResourceGroup(resourceGroupName: string, options?: ContainerGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ContainerGroup>;
|
|
334
|
+
/**
|
|
335
|
+
* Gets the properties of the specified container group in the specified subscription and resource
|
|
336
|
+
* group. The operation returns the properties of each container group including containers, image
|
|
337
|
+
* registry credentials, restart policy, IP address type, OS type, state, and volumes.
|
|
338
|
+
* @param resourceGroupName The name of the resource group.
|
|
339
|
+
* @param containerGroupName The name of the container group.
|
|
340
|
+
* @param options The options parameters.
|
|
341
|
+
*/
|
|
342
|
+
get(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOptionalParams): Promise<ContainerGroupsGetResponse>;
|
|
343
|
+
/**
|
|
344
|
+
* Create or update container groups with specified configurations.
|
|
345
|
+
* @param resourceGroupName The name of the resource group.
|
|
346
|
+
* @param containerGroupName The name of the container group.
|
|
347
|
+
* @param containerGroup The properties of the container group to be created or updated.
|
|
348
|
+
* @param options The options parameters.
|
|
349
|
+
*/
|
|
350
|
+
beginCreateOrUpdate(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ContainerGroupsCreateOrUpdateResponse>, ContainerGroupsCreateOrUpdateResponse>>;
|
|
351
|
+
/**
|
|
352
|
+
* Create or update container groups with specified configurations.
|
|
353
|
+
* @param resourceGroupName The name of the resource group.
|
|
354
|
+
* @param containerGroupName The name of the container group.
|
|
355
|
+
* @param containerGroup The properties of the container group to be created or updated.
|
|
356
|
+
* @param options The options parameters.
|
|
357
|
+
*/
|
|
358
|
+
beginCreateOrUpdateAndWait(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams): Promise<ContainerGroupsCreateOrUpdateResponse>;
|
|
359
|
+
/**
|
|
360
|
+
* Updates container group tags with specified values.
|
|
361
|
+
* @param resourceGroupName The name of the resource group.
|
|
362
|
+
* @param containerGroupName The name of the container group.
|
|
363
|
+
* @param resource The container group resource with just the tags to be updated.
|
|
364
|
+
* @param options The options parameters.
|
|
365
|
+
*/
|
|
366
|
+
update(resourceGroupName: string, containerGroupName: string, resource: Resource, options?: ContainerGroupsUpdateOptionalParams): Promise<ContainerGroupsUpdateResponse>;
|
|
367
|
+
/**
|
|
368
|
+
* Delete the specified container group in the specified subscription and resource group. The operation
|
|
369
|
+
* does not delete other resources provided by the user, such as volumes.
|
|
370
|
+
* @param resourceGroupName The name of the resource group.
|
|
371
|
+
* @param containerGroupName The name of the container group.
|
|
372
|
+
* @param options The options parameters.
|
|
373
|
+
*/
|
|
374
|
+
beginDelete(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams): Promise<PollerLike<PollOperationState<ContainerGroupsDeleteResponse>, ContainerGroupsDeleteResponse>>;
|
|
375
|
+
/**
|
|
376
|
+
* Delete the specified container group in the specified subscription and resource group. The operation
|
|
377
|
+
* does not delete other resources provided by the user, such as volumes.
|
|
378
|
+
* @param resourceGroupName The name of the resource group.
|
|
379
|
+
* @param containerGroupName The name of the container group.
|
|
380
|
+
* @param options The options parameters.
|
|
381
|
+
*/
|
|
382
|
+
beginDeleteAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams): Promise<ContainerGroupsDeleteResponse>;
|
|
383
|
+
/**
|
|
384
|
+
* Restarts all containers in a container group in place. If container image has updates, new image
|
|
385
|
+
* will be downloaded.
|
|
386
|
+
* @param resourceGroupName The name of the resource group.
|
|
387
|
+
* @param containerGroupName The name of the container group.
|
|
388
|
+
* @param options The options parameters.
|
|
389
|
+
*/
|
|
390
|
+
beginRestart(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
|
|
391
|
+
/**
|
|
392
|
+
* Restarts all containers in a container group in place. If container image has updates, new image
|
|
393
|
+
* will be downloaded.
|
|
394
|
+
* @param resourceGroupName The name of the resource group.
|
|
395
|
+
* @param containerGroupName The name of the container group.
|
|
396
|
+
* @param options The options parameters.
|
|
397
|
+
*/
|
|
398
|
+
beginRestartAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams): Promise<void>;
|
|
399
|
+
/**
|
|
400
|
+
* Stops all containers in a container group. Compute resources will be deallocated and billing will
|
|
401
|
+
* stop.
|
|
402
|
+
* @param resourceGroupName The name of the resource group.
|
|
403
|
+
* @param containerGroupName The name of the container group.
|
|
404
|
+
* @param options The options parameters.
|
|
405
|
+
*/
|
|
406
|
+
stop(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStopOptionalParams): Promise<void>;
|
|
407
|
+
/**
|
|
408
|
+
* Starts all containers in a container group. Compute resources will be allocated and billing will
|
|
409
|
+
* start.
|
|
410
|
+
* @param resourceGroupName The name of the resource group.
|
|
411
|
+
* @param containerGroupName The name of the container group.
|
|
412
|
+
* @param options The options parameters.
|
|
413
|
+
*/
|
|
414
|
+
beginStart(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
|
|
415
|
+
/**
|
|
416
|
+
* Starts all containers in a container group. Compute resources will be allocated and billing will
|
|
417
|
+
* start.
|
|
418
|
+
* @param resourceGroupName The name of the resource group.
|
|
419
|
+
* @param containerGroupName The name of the container group.
|
|
420
|
+
* @param options The options parameters.
|
|
421
|
+
*/
|
|
422
|
+
beginStartAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams): Promise<void>;
|
|
423
|
+
/**
|
|
424
|
+
* Gets all the network dependencies for this container group to allow complete control of network
|
|
425
|
+
* setting and configuration. For container groups, this will always be an empty list.
|
|
426
|
+
* @param resourceGroupName The name of the resource group.
|
|
427
|
+
* @param containerGroupName The name of the container group.
|
|
428
|
+
* @param options The options parameters.
|
|
429
|
+
*/
|
|
430
|
+
getOutboundNetworkDependenciesEndpoints(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams): Promise<ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse>;
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
/** Optional parameters. */
|
|
434
|
+
export declare interface ContainerGroupsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
|
|
435
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
436
|
+
updateIntervalInMs?: number;
|
|
437
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
438
|
+
resumeFrom?: string;
|
|
439
|
+
}
|
|
440
|
+
|
|
441
|
+
/** Contains response data for the createOrUpdate operation. */
|
|
442
|
+
export declare type ContainerGroupsCreateOrUpdateResponse = ContainerGroup;
|
|
443
|
+
|
|
444
|
+
/** Optional parameters. */
|
|
445
|
+
export declare interface ContainerGroupsDeleteOptionalParams extends coreClient.OperationOptions {
|
|
446
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
447
|
+
updateIntervalInMs?: number;
|
|
448
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
449
|
+
resumeFrom?: string;
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
/** Contains response data for the delete operation. */
|
|
453
|
+
export declare type ContainerGroupsDeleteResponse = ContainerGroup;
|
|
454
|
+
|
|
455
|
+
/** Optional parameters. */
|
|
456
|
+
export declare interface ContainerGroupsGetOptionalParams extends coreClient.OperationOptions {
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
/** Optional parameters. */
|
|
460
|
+
export declare interface ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams extends coreClient.OperationOptions {
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
/** Contains response data for the getOutboundNetworkDependenciesEndpoints operation. */
|
|
464
|
+
export declare type ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse = {
|
|
465
|
+
/** The parsed response body. */
|
|
466
|
+
body: string[];
|
|
467
|
+
};
|
|
468
|
+
|
|
469
|
+
/** Contains response data for the get operation. */
|
|
470
|
+
export declare type ContainerGroupsGetResponse = ContainerGroup;
|
|
471
|
+
|
|
472
|
+
/**
|
|
473
|
+
* Defines values for ContainerGroupSku. \
|
|
474
|
+
* {@link KnownContainerGroupSku} can be used interchangeably with ContainerGroupSku,
|
|
475
|
+
* this enum contains the known values that the service supports.
|
|
476
|
+
* ### Known values supported by the service
|
|
477
|
+
* **Standard** \
|
|
478
|
+
* **Dedicated**
|
|
479
|
+
*/
|
|
480
|
+
export declare type ContainerGroupSku = string;
|
|
481
|
+
|
|
482
|
+
/** Optional parameters. */
|
|
483
|
+
export declare interface ContainerGroupsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
/** Contains response data for the listByResourceGroupNext operation. */
|
|
487
|
+
export declare type ContainerGroupsListByResourceGroupNextResponse = ContainerGroupListResult;
|
|
488
|
+
|
|
489
|
+
/** Optional parameters. */
|
|
490
|
+
export declare interface ContainerGroupsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
/** Contains response data for the listByResourceGroup operation. */
|
|
494
|
+
export declare type ContainerGroupsListByResourceGroupResponse = ContainerGroupListResult;
|
|
495
|
+
|
|
496
|
+
/** Optional parameters. */
|
|
497
|
+
export declare interface ContainerGroupsListNextOptionalParams extends coreClient.OperationOptions {
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
/** Contains response data for the listNext operation. */
|
|
501
|
+
export declare type ContainerGroupsListNextResponse = ContainerGroupListResult;
|
|
502
|
+
|
|
503
|
+
/** Optional parameters. */
|
|
504
|
+
export declare interface ContainerGroupsListOptionalParams extends coreClient.OperationOptions {
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
/** Contains response data for the list operation. */
|
|
508
|
+
export declare type ContainerGroupsListResponse = ContainerGroupListResult;
|
|
509
|
+
|
|
510
|
+
/** Optional parameters. */
|
|
511
|
+
export declare interface ContainerGroupsRestartOptionalParams extends coreClient.OperationOptions {
|
|
512
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
513
|
+
updateIntervalInMs?: number;
|
|
514
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
515
|
+
resumeFrom?: string;
|
|
516
|
+
}
|
|
517
|
+
|
|
518
|
+
/** Optional parameters. */
|
|
519
|
+
export declare interface ContainerGroupsStartOptionalParams extends coreClient.OperationOptions {
|
|
520
|
+
/** Delay to wait until next poll, in milliseconds. */
|
|
521
|
+
updateIntervalInMs?: number;
|
|
522
|
+
/** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
|
|
523
|
+
resumeFrom?: string;
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
/** Optional parameters. */
|
|
527
|
+
export declare interface ContainerGroupsStopOptionalParams extends coreClient.OperationOptions {
|
|
528
|
+
}
|
|
529
|
+
|
|
530
|
+
/** Container group subnet information. */
|
|
531
|
+
export declare interface ContainerGroupSubnetId {
|
|
532
|
+
/** Resource ID of virtual network and subnet. */
|
|
533
|
+
id: string;
|
|
534
|
+
/** Friendly name for the subnet. */
|
|
535
|
+
name?: string;
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
/** Optional parameters. */
|
|
539
|
+
export declare interface ContainerGroupsUpdateOptionalParams extends coreClient.OperationOptions {
|
|
540
|
+
}
|
|
541
|
+
|
|
542
|
+
/** Contains response data for the update operation. */
|
|
543
|
+
export declare type ContainerGroupsUpdateResponse = ContainerGroup;
|
|
544
|
+
|
|
545
|
+
/** The container Http Get settings, for liveness or readiness probe */
|
|
546
|
+
export declare interface ContainerHttpGet {
|
|
547
|
+
/** The path to probe. */
|
|
548
|
+
path?: string;
|
|
549
|
+
/** The port number to probe. */
|
|
550
|
+
port: number;
|
|
551
|
+
/** The scheme. */
|
|
552
|
+
scheme?: Scheme;
|
|
553
|
+
/** The HTTP headers. */
|
|
554
|
+
httpHeaders?: HttpHeader[];
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
export declare class ContainerInstanceManagementClient extends coreClient.ServiceClient {
|
|
558
|
+
$host: string;
|
|
559
|
+
subscriptionId: string;
|
|
560
|
+
apiVersion: string;
|
|
561
|
+
/**
|
|
562
|
+
* Initializes a new instance of the ContainerInstanceManagementClient class.
|
|
563
|
+
* @param credentials Subscription credentials which uniquely identify client subscription.
|
|
564
|
+
* @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription.
|
|
565
|
+
* The subscription ID forms part of the URI for every service call.
|
|
566
|
+
* @param options The parameter options
|
|
567
|
+
*/
|
|
568
|
+
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ContainerInstanceManagementClientOptionalParams);
|
|
569
|
+
containerGroups: ContainerGroups;
|
|
570
|
+
operations: Operations;
|
|
571
|
+
location: Location_2;
|
|
572
|
+
containers: Containers;
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
/** Optional parameters. */
|
|
576
|
+
export declare interface ContainerInstanceManagementClientOptionalParams extends coreClient.ServiceClientOptions {
|
|
577
|
+
/** server parameter */
|
|
578
|
+
$host?: string;
|
|
579
|
+
/** Api Version */
|
|
580
|
+
apiVersion?: string;
|
|
581
|
+
/** Overrides client endpoint. */
|
|
582
|
+
endpoint?: string;
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* Defines values for ContainerInstanceOperationsOrigin. \
|
|
587
|
+
* {@link KnownContainerInstanceOperationsOrigin} can be used interchangeably with ContainerInstanceOperationsOrigin,
|
|
588
|
+
* this enum contains the known values that the service supports.
|
|
589
|
+
* ### Known values supported by the service
|
|
590
|
+
* **User** \
|
|
591
|
+
* **System**
|
|
592
|
+
*/
|
|
593
|
+
export declare type ContainerInstanceOperationsOrigin = string;
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* Defines values for ContainerNetworkProtocol. \
|
|
597
|
+
* {@link KnownContainerNetworkProtocol} can be used interchangeably with ContainerNetworkProtocol,
|
|
598
|
+
* this enum contains the known values that the service supports.
|
|
599
|
+
* ### Known values supported by the service
|
|
600
|
+
* **TCP** \
|
|
601
|
+
* **UDP**
|
|
602
|
+
*/
|
|
603
|
+
export declare type ContainerNetworkProtocol = string;
|
|
604
|
+
|
|
605
|
+
/** The port exposed on the container instance. */
|
|
606
|
+
export declare interface ContainerPort {
|
|
607
|
+
/** The protocol associated with the port. */
|
|
608
|
+
protocol?: ContainerNetworkProtocol;
|
|
609
|
+
/** The port number exposed within the container group. */
|
|
610
|
+
port: number;
|
|
611
|
+
}
|
|
612
|
+
|
|
613
|
+
/** The container probe, for liveness or readiness */
|
|
614
|
+
export declare interface ContainerProbe {
|
|
615
|
+
/** The execution command to probe */
|
|
616
|
+
exec?: ContainerExec;
|
|
617
|
+
/** The Http Get settings to probe */
|
|
618
|
+
httpGet?: ContainerHttpGet;
|
|
619
|
+
/** The initial delay seconds. */
|
|
620
|
+
initialDelaySeconds?: number;
|
|
621
|
+
/** The period seconds. */
|
|
622
|
+
periodSeconds?: number;
|
|
623
|
+
/** The failure threshold. */
|
|
624
|
+
failureThreshold?: number;
|
|
625
|
+
/** The success threshold. */
|
|
626
|
+
successThreshold?: number;
|
|
627
|
+
/** The timeout seconds. */
|
|
628
|
+
timeoutSeconds?: number;
|
|
629
|
+
}
|
|
630
|
+
|
|
631
|
+
/** The instance view of the container instance. Only valid in response. */
|
|
632
|
+
export declare interface ContainerPropertiesInstanceView {
|
|
633
|
+
/**
|
|
634
|
+
* The number of times that the container instance has been restarted.
|
|
635
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
636
|
+
*/
|
|
637
|
+
readonly restartCount?: number;
|
|
638
|
+
/**
|
|
639
|
+
* Current container instance state.
|
|
640
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
641
|
+
*/
|
|
642
|
+
readonly currentState?: ContainerState;
|
|
643
|
+
/**
|
|
644
|
+
* Previous container instance state.
|
|
645
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
646
|
+
*/
|
|
647
|
+
readonly previousState?: ContainerState;
|
|
648
|
+
/**
|
|
649
|
+
* The events of the container instance.
|
|
650
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
651
|
+
*/
|
|
652
|
+
readonly events?: Event_2[];
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
/** Interface representing a Containers. */
|
|
656
|
+
export declare interface Containers {
|
|
657
|
+
/**
|
|
658
|
+
* Get the logs for a specified container instance in a specified resource group and container group.
|
|
659
|
+
* @param resourceGroupName The name of the resource group.
|
|
660
|
+
* @param containerGroupName The name of the container group.
|
|
661
|
+
* @param containerName The name of the container instance.
|
|
662
|
+
* @param options The options parameters.
|
|
663
|
+
*/
|
|
664
|
+
listLogs(resourceGroupName: string, containerGroupName: string, containerName: string, options?: ContainersListLogsOptionalParams): Promise<ContainersListLogsResponse>;
|
|
665
|
+
/**
|
|
666
|
+
* Executes a command for a specific container instance in a specified resource group and container
|
|
667
|
+
* group.
|
|
668
|
+
* @param resourceGroupName The name of the resource group.
|
|
669
|
+
* @param containerGroupName The name of the container group.
|
|
670
|
+
* @param containerName The name of the container instance.
|
|
671
|
+
* @param containerExecRequest The request for the exec command.
|
|
672
|
+
* @param options The options parameters.
|
|
673
|
+
*/
|
|
674
|
+
executeCommand(resourceGroupName: string, containerGroupName: string, containerName: string, containerExecRequest: ContainerExecRequest, options?: ContainersExecuteCommandOptionalParams): Promise<ContainersExecuteCommandResponse>;
|
|
675
|
+
/**
|
|
676
|
+
* Attach to the output stream of a specific container instance in a specified resource group and
|
|
677
|
+
* container group.
|
|
678
|
+
* @param resourceGroupName The name of the resource group.
|
|
679
|
+
* @param containerGroupName The name of the container group.
|
|
680
|
+
* @param containerName The name of the container instance.
|
|
681
|
+
* @param options The options parameters.
|
|
682
|
+
*/
|
|
683
|
+
attach(resourceGroupName: string, containerGroupName: string, containerName: string, options?: ContainersAttachOptionalParams): Promise<ContainersAttachResponse>;
|
|
684
|
+
}
|
|
685
|
+
|
|
686
|
+
/** Optional parameters. */
|
|
687
|
+
export declare interface ContainersAttachOptionalParams extends coreClient.OperationOptions {
|
|
688
|
+
}
|
|
689
|
+
|
|
690
|
+
/** Contains response data for the attach operation. */
|
|
691
|
+
export declare type ContainersAttachResponse = ContainerAttachResponse;
|
|
692
|
+
|
|
693
|
+
/** Optional parameters. */
|
|
694
|
+
export declare interface ContainersExecuteCommandOptionalParams extends coreClient.OperationOptions {
|
|
695
|
+
}
|
|
696
|
+
|
|
697
|
+
/** Contains response data for the executeCommand operation. */
|
|
698
|
+
export declare type ContainersExecuteCommandResponse = ContainerExecResponse;
|
|
699
|
+
|
|
700
|
+
/** Optional parameters. */
|
|
701
|
+
export declare interface ContainersListLogsOptionalParams extends coreClient.OperationOptions {
|
|
702
|
+
/** The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb. */
|
|
703
|
+
tail?: number;
|
|
704
|
+
/** If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false. */
|
|
705
|
+
timestamps?: boolean;
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
/** Contains response data for the listLogs operation. */
|
|
709
|
+
export declare type ContainersListLogsResponse = Logs;
|
|
710
|
+
|
|
711
|
+
/** The container instance state. */
|
|
712
|
+
export declare interface ContainerState {
|
|
713
|
+
/**
|
|
714
|
+
* The state of the container instance.
|
|
715
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
716
|
+
*/
|
|
717
|
+
readonly state?: string;
|
|
718
|
+
/**
|
|
719
|
+
* The date-time when the container instance state started.
|
|
720
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
721
|
+
*/
|
|
722
|
+
readonly startTime?: Date;
|
|
723
|
+
/**
|
|
724
|
+
* The container instance exit codes correspond to those from the `docker run` command.
|
|
725
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
726
|
+
*/
|
|
727
|
+
readonly exitCode?: number;
|
|
728
|
+
/**
|
|
729
|
+
* The date-time when the container instance state finished.
|
|
730
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
731
|
+
*/
|
|
732
|
+
readonly finishTime?: Date;
|
|
733
|
+
/**
|
|
734
|
+
* The human-readable status of the container instance state.
|
|
735
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
736
|
+
*/
|
|
737
|
+
readonly detailStatus?: string;
|
|
738
|
+
}
|
|
739
|
+
|
|
740
|
+
/** DNS configuration for the container group. */
|
|
741
|
+
export declare interface DnsConfiguration {
|
|
742
|
+
/** The DNS servers for the container group. */
|
|
743
|
+
nameServers: string[];
|
|
744
|
+
/** The DNS search domains for hostname lookup in the container group. */
|
|
745
|
+
searchDomains?: string;
|
|
746
|
+
/** The DNS options for the container group. */
|
|
747
|
+
options?: string;
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
/** The container group encryption properties. */
|
|
751
|
+
export declare interface EncryptionProperties {
|
|
752
|
+
/** The keyvault base url. */
|
|
753
|
+
vaultBaseUrl: string;
|
|
754
|
+
/** The encryption key name. */
|
|
755
|
+
keyName: string;
|
|
756
|
+
/** The encryption key version. */
|
|
757
|
+
keyVersion: string;
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
/** The environment variable to set within the container instance. */
|
|
761
|
+
export declare interface EnvironmentVariable {
|
|
762
|
+
/** The name of the environment variable. */
|
|
763
|
+
name: string;
|
|
764
|
+
/** The value of the environment variable. */
|
|
765
|
+
value?: string;
|
|
766
|
+
/** The value of the secure environment variable. */
|
|
767
|
+
secureValue?: string;
|
|
768
|
+
}
|
|
769
|
+
|
|
770
|
+
/** A container group or container instance event. */
|
|
771
|
+
declare interface Event_2 {
|
|
772
|
+
/**
|
|
773
|
+
* The count of the event.
|
|
774
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
775
|
+
*/
|
|
776
|
+
readonly count?: number;
|
|
777
|
+
/**
|
|
778
|
+
* The date-time of the earliest logged event.
|
|
779
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
780
|
+
*/
|
|
781
|
+
readonly firstTimestamp?: Date;
|
|
782
|
+
/**
|
|
783
|
+
* The date-time of the latest logged event.
|
|
784
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
785
|
+
*/
|
|
786
|
+
readonly lastTimestamp?: Date;
|
|
787
|
+
/**
|
|
788
|
+
* The event name.
|
|
789
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
790
|
+
*/
|
|
791
|
+
readonly name?: string;
|
|
792
|
+
/**
|
|
793
|
+
* The event message.
|
|
794
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
795
|
+
*/
|
|
796
|
+
readonly message?: string;
|
|
797
|
+
/**
|
|
798
|
+
* The event type.
|
|
799
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
800
|
+
*/
|
|
801
|
+
readonly type?: string;
|
|
802
|
+
}
|
|
803
|
+
export { Event_2 as Event }
|
|
804
|
+
|
|
805
|
+
/** Represents a volume that is populated with the contents of a git repository */
|
|
806
|
+
export declare interface GitRepoVolume {
|
|
807
|
+
/** Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */
|
|
808
|
+
directory?: string;
|
|
809
|
+
/** Repository URL */
|
|
810
|
+
repository: string;
|
|
811
|
+
/** Commit hash for the specified revision. */
|
|
812
|
+
revision?: string;
|
|
813
|
+
}
|
|
814
|
+
|
|
815
|
+
/** The GPU resource. */
|
|
816
|
+
export declare interface GpuResource {
|
|
817
|
+
/** The count of the GPU resource. */
|
|
818
|
+
count: number;
|
|
819
|
+
/** The SKU of the GPU resource. */
|
|
820
|
+
sku: GpuSku;
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
/**
|
|
824
|
+
* Defines values for GpuSku. \
|
|
825
|
+
* {@link KnownGpuSku} can be used interchangeably with GpuSku,
|
|
826
|
+
* this enum contains the known values that the service supports.
|
|
827
|
+
* ### Known values supported by the service
|
|
828
|
+
* **K80** \
|
|
829
|
+
* **P100** \
|
|
830
|
+
* **V100**
|
|
831
|
+
*/
|
|
832
|
+
export declare type GpuSku = string;
|
|
833
|
+
|
|
834
|
+
/** The HTTP header. */
|
|
835
|
+
export declare interface HttpHeader {
|
|
836
|
+
/** The header name. */
|
|
837
|
+
name?: string;
|
|
838
|
+
/** The header value. */
|
|
839
|
+
value?: string;
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
/** Image registry credential. */
|
|
843
|
+
export declare interface ImageRegistryCredential {
|
|
844
|
+
/** The Docker image registry server without a protocol such as "http" and "https". */
|
|
845
|
+
server: string;
|
|
846
|
+
/** The username for the private registry. */
|
|
847
|
+
username: string;
|
|
848
|
+
/** The password for the private registry. */
|
|
849
|
+
password?: string;
|
|
850
|
+
/** The identity for the private registry. */
|
|
851
|
+
identity?: string;
|
|
852
|
+
/** The identity URL for the private registry. */
|
|
853
|
+
identityUrl?: string;
|
|
854
|
+
}
|
|
855
|
+
|
|
856
|
+
/** The init container definition. */
|
|
857
|
+
export declare interface InitContainerDefinition {
|
|
858
|
+
/** The name for the init container. */
|
|
859
|
+
name: string;
|
|
860
|
+
/** The image of the init container. */
|
|
861
|
+
image?: string;
|
|
862
|
+
/** The command to execute within the init container in exec form. */
|
|
863
|
+
command?: string[];
|
|
864
|
+
/** The environment variables to set in the init container. */
|
|
865
|
+
environmentVariables?: EnvironmentVariable[];
|
|
866
|
+
/**
|
|
867
|
+
* The instance view of the init container. Only valid in response.
|
|
868
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
869
|
+
*/
|
|
870
|
+
readonly instanceView?: InitContainerPropertiesDefinitionInstanceView;
|
|
871
|
+
/** The volume mounts available to the init container. */
|
|
872
|
+
volumeMounts?: VolumeMount[];
|
|
873
|
+
}
|
|
874
|
+
|
|
875
|
+
/** The instance view of the init container. Only valid in response. */
|
|
876
|
+
export declare interface InitContainerPropertiesDefinitionInstanceView {
|
|
877
|
+
/**
|
|
878
|
+
* The number of times that the init container has been restarted.
|
|
879
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
880
|
+
*/
|
|
881
|
+
readonly restartCount?: number;
|
|
882
|
+
/**
|
|
883
|
+
* The current state of the init container.
|
|
884
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
885
|
+
*/
|
|
886
|
+
readonly currentState?: ContainerState;
|
|
887
|
+
/**
|
|
888
|
+
* The previous state of the init container.
|
|
889
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
890
|
+
*/
|
|
891
|
+
readonly previousState?: ContainerState;
|
|
892
|
+
/**
|
|
893
|
+
* The events of the init container.
|
|
894
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
895
|
+
*/
|
|
896
|
+
readonly events?: Event_2[];
|
|
897
|
+
}
|
|
898
|
+
|
|
899
|
+
/** IP address for the container group. */
|
|
900
|
+
export declare interface IpAddress {
|
|
901
|
+
/** The list of ports exposed on the container group. */
|
|
902
|
+
ports: Port[];
|
|
903
|
+
/** Specifies if the IP is exposed to the public internet or private VNET. */
|
|
904
|
+
type: ContainerGroupIpAddressType;
|
|
905
|
+
/** The IP exposed to the public internet. */
|
|
906
|
+
ip?: string;
|
|
907
|
+
/** The Dns name label for the IP. */
|
|
908
|
+
dnsNameLabel?: string;
|
|
909
|
+
/**
|
|
910
|
+
* The FQDN for the IP.
|
|
911
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
912
|
+
*/
|
|
913
|
+
readonly fqdn?: string;
|
|
914
|
+
}
|
|
915
|
+
|
|
916
|
+
/** Known values of {@link ContainerGroupIpAddressType} that the service accepts. */
|
|
917
|
+
export declare enum KnownContainerGroupIpAddressType {
|
|
918
|
+
Public = "Public",
|
|
919
|
+
Private = "Private"
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
/** Known values of {@link ContainerGroupNetworkProtocol} that the service accepts. */
|
|
923
|
+
export declare enum KnownContainerGroupNetworkProtocol {
|
|
924
|
+
TCP = "TCP",
|
|
925
|
+
UDP = "UDP"
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
/** Known values of {@link ContainerGroupRestartPolicy} that the service accepts. */
|
|
929
|
+
export declare enum KnownContainerGroupRestartPolicy {
|
|
930
|
+
Always = "Always",
|
|
931
|
+
OnFailure = "OnFailure",
|
|
932
|
+
Never = "Never"
|
|
933
|
+
}
|
|
934
|
+
|
|
935
|
+
/** Known values of {@link ContainerGroupSku} that the service accepts. */
|
|
936
|
+
export declare enum KnownContainerGroupSku {
|
|
937
|
+
Standard = "Standard",
|
|
938
|
+
Dedicated = "Dedicated"
|
|
939
|
+
}
|
|
940
|
+
|
|
941
|
+
/** Known values of {@link ContainerInstanceOperationsOrigin} that the service accepts. */
|
|
942
|
+
export declare enum KnownContainerInstanceOperationsOrigin {
|
|
943
|
+
User = "User",
|
|
944
|
+
System = "System"
|
|
945
|
+
}
|
|
946
|
+
|
|
947
|
+
/** Known values of {@link ContainerNetworkProtocol} that the service accepts. */
|
|
948
|
+
export declare enum KnownContainerNetworkProtocol {
|
|
949
|
+
TCP = "TCP",
|
|
950
|
+
UDP = "UDP"
|
|
951
|
+
}
|
|
952
|
+
|
|
953
|
+
/** Known values of {@link GpuSku} that the service accepts. */
|
|
954
|
+
export declare enum KnownGpuSku {
|
|
955
|
+
K80 = "K80",
|
|
956
|
+
P100 = "P100",
|
|
957
|
+
V100 = "V100"
|
|
958
|
+
}
|
|
959
|
+
|
|
960
|
+
/** Known values of {@link LogAnalyticsLogType} that the service accepts. */
|
|
961
|
+
export declare enum KnownLogAnalyticsLogType {
|
|
962
|
+
ContainerInsights = "ContainerInsights",
|
|
963
|
+
ContainerInstanceLogs = "ContainerInstanceLogs"
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
/** Known values of {@link OperatingSystemTypes} that the service accepts. */
|
|
967
|
+
export declare enum KnownOperatingSystemTypes {
|
|
968
|
+
Windows = "Windows",
|
|
969
|
+
Linux = "Linux"
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/** Known values of {@link Scheme} that the service accepts. */
|
|
973
|
+
export declare enum KnownScheme {
|
|
974
|
+
Http = "http",
|
|
975
|
+
Https = "https"
|
|
976
|
+
}
|
|
977
|
+
|
|
978
|
+
/** Interface representing a Location. */
|
|
979
|
+
declare interface Location_2 {
|
|
980
|
+
/**
|
|
981
|
+
* Get the usage for a subscription
|
|
982
|
+
* @param location The identifier for the physical azure location.
|
|
983
|
+
* @param options The options parameters.
|
|
984
|
+
*/
|
|
985
|
+
listUsage(location: string, options?: LocationListUsageOptionalParams): PagedAsyncIterableIterator<Usage>;
|
|
986
|
+
/**
|
|
987
|
+
* Get the list of cached images on specific OS type for a subscription in a region.
|
|
988
|
+
* @param location The identifier for the physical azure location.
|
|
989
|
+
* @param options The options parameters.
|
|
990
|
+
*/
|
|
991
|
+
listCachedImages(location: string, options?: LocationListCachedImagesOptionalParams): PagedAsyncIterableIterator<CachedImages>;
|
|
992
|
+
/**
|
|
993
|
+
* Get the list of CPU/memory/GPU capabilities of a region.
|
|
994
|
+
* @param location The identifier for the physical azure location.
|
|
995
|
+
* @param options The options parameters.
|
|
996
|
+
*/
|
|
997
|
+
listCapabilities(location: string, options?: LocationListCapabilitiesOptionalParams): PagedAsyncIterableIterator<Capabilities>;
|
|
998
|
+
}
|
|
999
|
+
export { Location_2 as Location }
|
|
1000
|
+
|
|
1001
|
+
/** Optional parameters. */
|
|
1002
|
+
export declare interface LocationListCachedImagesNextOptionalParams extends coreClient.OperationOptions {
|
|
1003
|
+
}
|
|
1004
|
+
|
|
1005
|
+
/** Contains response data for the listCachedImagesNext operation. */
|
|
1006
|
+
export declare type LocationListCachedImagesNextResponse = CachedImagesListResult;
|
|
1007
|
+
|
|
1008
|
+
/** Optional parameters. */
|
|
1009
|
+
export declare interface LocationListCachedImagesOptionalParams extends coreClient.OperationOptions {
|
|
1010
|
+
}
|
|
1011
|
+
|
|
1012
|
+
/** Contains response data for the listCachedImages operation. */
|
|
1013
|
+
export declare type LocationListCachedImagesResponse = CachedImagesListResult;
|
|
1014
|
+
|
|
1015
|
+
/** Optional parameters. */
|
|
1016
|
+
export declare interface LocationListCapabilitiesNextOptionalParams extends coreClient.OperationOptions {
|
|
1017
|
+
}
|
|
1018
|
+
|
|
1019
|
+
/** Contains response data for the listCapabilitiesNext operation. */
|
|
1020
|
+
export declare type LocationListCapabilitiesNextResponse = CapabilitiesListResult;
|
|
1021
|
+
|
|
1022
|
+
/** Optional parameters. */
|
|
1023
|
+
export declare interface LocationListCapabilitiesOptionalParams extends coreClient.OperationOptions {
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
/** Contains response data for the listCapabilities operation. */
|
|
1027
|
+
export declare type LocationListCapabilitiesResponse = CapabilitiesListResult;
|
|
1028
|
+
|
|
1029
|
+
/** Optional parameters. */
|
|
1030
|
+
export declare interface LocationListUsageOptionalParams extends coreClient.OperationOptions {
|
|
1031
|
+
}
|
|
1032
|
+
|
|
1033
|
+
/** Contains response data for the listUsage operation. */
|
|
1034
|
+
export declare type LocationListUsageResponse = UsageListResult;
|
|
1035
|
+
|
|
1036
|
+
/** Container group log analytics information. */
|
|
1037
|
+
export declare interface LogAnalytics {
|
|
1038
|
+
/** The workspace id for log analytics */
|
|
1039
|
+
workspaceId: string;
|
|
1040
|
+
/** The workspace key for log analytics */
|
|
1041
|
+
workspaceKey: string;
|
|
1042
|
+
/** The log type to be used. */
|
|
1043
|
+
logType?: LogAnalyticsLogType;
|
|
1044
|
+
/** Metadata for log analytics. */
|
|
1045
|
+
metadata?: {
|
|
1046
|
+
[propertyName: string]: string;
|
|
1047
|
+
};
|
|
1048
|
+
/** The workspace resource id for log analytics */
|
|
1049
|
+
workspaceResourceId?: string;
|
|
1050
|
+
}
|
|
1051
|
+
|
|
1052
|
+
/**
|
|
1053
|
+
* Defines values for LogAnalyticsLogType. \
|
|
1054
|
+
* {@link KnownLogAnalyticsLogType} can be used interchangeably with LogAnalyticsLogType,
|
|
1055
|
+
* this enum contains the known values that the service supports.
|
|
1056
|
+
* ### Known values supported by the service
|
|
1057
|
+
* **ContainerInsights** \
|
|
1058
|
+
* **ContainerInstanceLogs**
|
|
1059
|
+
*/
|
|
1060
|
+
export declare type LogAnalyticsLogType = string;
|
|
1061
|
+
|
|
1062
|
+
/** The logs. */
|
|
1063
|
+
export declare interface Logs {
|
|
1064
|
+
/** The content of the log. */
|
|
1065
|
+
content?: string;
|
|
1066
|
+
}
|
|
1067
|
+
|
|
1068
|
+
/**
|
|
1069
|
+
* Defines values for OperatingSystemTypes. \
|
|
1070
|
+
* {@link KnownOperatingSystemTypes} can be used interchangeably with OperatingSystemTypes,
|
|
1071
|
+
* this enum contains the known values that the service supports.
|
|
1072
|
+
* ### Known values supported by the service
|
|
1073
|
+
* **Windows** \
|
|
1074
|
+
* **Linux**
|
|
1075
|
+
*/
|
|
1076
|
+
export declare type OperatingSystemTypes = string;
|
|
1077
|
+
|
|
1078
|
+
/** An operation for Azure Container Instance service. */
|
|
1079
|
+
export declare interface Operation {
|
|
1080
|
+
/** The name of the operation. */
|
|
1081
|
+
name: string;
|
|
1082
|
+
/** The display information of the operation. */
|
|
1083
|
+
display: OperationDisplay;
|
|
1084
|
+
/** The additional properties. */
|
|
1085
|
+
properties?: Record<string, unknown>;
|
|
1086
|
+
/** The intended executor of the operation. */
|
|
1087
|
+
origin?: ContainerInstanceOperationsOrigin;
|
|
1088
|
+
}
|
|
1089
|
+
|
|
1090
|
+
/** The display information of the operation. */
|
|
1091
|
+
export declare interface OperationDisplay {
|
|
1092
|
+
/** The name of the provider of the operation. */
|
|
1093
|
+
provider?: string;
|
|
1094
|
+
/** The name of the resource type of the operation. */
|
|
1095
|
+
resource?: string;
|
|
1096
|
+
/** The friendly name of the operation. */
|
|
1097
|
+
operation?: string;
|
|
1098
|
+
/** The description of the operation. */
|
|
1099
|
+
description?: string;
|
|
1100
|
+
}
|
|
1101
|
+
|
|
1102
|
+
/** The operation list response that contains all operations for Azure Container Instance service. */
|
|
1103
|
+
export declare interface OperationListResult {
|
|
1104
|
+
/** The list of operations. */
|
|
1105
|
+
value?: Operation[];
|
|
1106
|
+
/** The URI to fetch the next page of operations. */
|
|
1107
|
+
nextLink?: string;
|
|
1108
|
+
}
|
|
1109
|
+
|
|
1110
|
+
/** Interface representing a Operations. */
|
|
1111
|
+
export declare interface Operations {
|
|
1112
|
+
/**
|
|
1113
|
+
* List the operations for Azure Container Instance service.
|
|
1114
|
+
* @param options The options parameters.
|
|
1115
|
+
*/
|
|
1116
|
+
list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
|
|
1117
|
+
}
|
|
1118
|
+
|
|
1119
|
+
/** Optional parameters. */
|
|
1120
|
+
export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
/** Contains response data for the listNext operation. */
|
|
1124
|
+
export declare type OperationsListNextResponse = OperationListResult;
|
|
1125
|
+
|
|
1126
|
+
/** Optional parameters. */
|
|
1127
|
+
export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
|
|
1128
|
+
}
|
|
1129
|
+
|
|
1130
|
+
/** Contains response data for the list operation. */
|
|
1131
|
+
export declare type OperationsListResponse = OperationListResult;
|
|
1132
|
+
|
|
1133
|
+
/** The port exposed on the container group. */
|
|
1134
|
+
export declare interface Port {
|
|
1135
|
+
/** The protocol associated with the port. */
|
|
1136
|
+
protocol?: ContainerGroupNetworkProtocol;
|
|
1137
|
+
/** The port number. */
|
|
1138
|
+
port: number;
|
|
1139
|
+
}
|
|
1140
|
+
|
|
1141
|
+
/** The Resource model definition. */
|
|
1142
|
+
export declare interface Resource {
|
|
1143
|
+
/**
|
|
1144
|
+
* The resource id.
|
|
1145
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1146
|
+
*/
|
|
1147
|
+
readonly id?: string;
|
|
1148
|
+
/**
|
|
1149
|
+
* The resource name.
|
|
1150
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1151
|
+
*/
|
|
1152
|
+
readonly name?: string;
|
|
1153
|
+
/**
|
|
1154
|
+
* The resource type.
|
|
1155
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1156
|
+
*/
|
|
1157
|
+
readonly type?: string;
|
|
1158
|
+
/** The resource location. */
|
|
1159
|
+
location?: string;
|
|
1160
|
+
/** The resource tags. */
|
|
1161
|
+
tags?: {
|
|
1162
|
+
[propertyName: string]: string;
|
|
1163
|
+
};
|
|
1164
|
+
/** The zones for the container group. */
|
|
1165
|
+
zones?: string[];
|
|
1166
|
+
}
|
|
1167
|
+
|
|
1168
|
+
/** Defines values for ResourceIdentityType. */
|
|
1169
|
+
export declare type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
|
|
1170
|
+
|
|
1171
|
+
/** The resource limits. */
|
|
1172
|
+
export declare interface ResourceLimits {
|
|
1173
|
+
/** The memory limit in GB of this container instance. */
|
|
1174
|
+
memoryInGB?: number;
|
|
1175
|
+
/** The CPU limit of this container instance. */
|
|
1176
|
+
cpu?: number;
|
|
1177
|
+
/** The GPU limit of this container instance. */
|
|
1178
|
+
gpu?: GpuResource;
|
|
1179
|
+
}
|
|
1180
|
+
|
|
1181
|
+
/** The resource requests. */
|
|
1182
|
+
export declare interface ResourceRequests {
|
|
1183
|
+
/** The memory request in GB of this container instance. */
|
|
1184
|
+
memoryInGB: number;
|
|
1185
|
+
/** The CPU request of this container instance. */
|
|
1186
|
+
cpu: number;
|
|
1187
|
+
/** The GPU request of this container instance. */
|
|
1188
|
+
gpu?: GpuResource;
|
|
1189
|
+
}
|
|
1190
|
+
|
|
1191
|
+
/** The resource requirements. */
|
|
1192
|
+
export declare interface ResourceRequirements {
|
|
1193
|
+
/** The resource requests of this container instance. */
|
|
1194
|
+
requests: ResourceRequests;
|
|
1195
|
+
/** The resource limits of this container instance. */
|
|
1196
|
+
limits?: ResourceLimits;
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
/**
|
|
1200
|
+
* Defines values for Scheme. \
|
|
1201
|
+
* {@link KnownScheme} can be used interchangeably with Scheme,
|
|
1202
|
+
* this enum contains the known values that the service supports.
|
|
1203
|
+
* ### Known values supported by the service
|
|
1204
|
+
* **http** \
|
|
1205
|
+
* **https**
|
|
1206
|
+
*/
|
|
1207
|
+
export declare type Scheme = string;
|
|
1208
|
+
|
|
1209
|
+
/** A single usage result */
|
|
1210
|
+
export declare interface Usage {
|
|
1211
|
+
/**
|
|
1212
|
+
* Unit of the usage result
|
|
1213
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1214
|
+
*/
|
|
1215
|
+
readonly unit?: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* The current usage of the resource
|
|
1218
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1219
|
+
*/
|
|
1220
|
+
readonly currentValue?: number;
|
|
1221
|
+
/**
|
|
1222
|
+
* The maximum permitted usage of the resource.
|
|
1223
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1224
|
+
*/
|
|
1225
|
+
readonly limit?: number;
|
|
1226
|
+
/**
|
|
1227
|
+
* The name object of the resource
|
|
1228
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1229
|
+
*/
|
|
1230
|
+
readonly name?: UsageName;
|
|
1231
|
+
}
|
|
1232
|
+
|
|
1233
|
+
/** The response containing the usage data */
|
|
1234
|
+
export declare interface UsageListResult {
|
|
1235
|
+
/**
|
|
1236
|
+
* The usage data.
|
|
1237
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1238
|
+
*/
|
|
1239
|
+
readonly value?: Usage[];
|
|
1240
|
+
}
|
|
1241
|
+
|
|
1242
|
+
/** The name object of the resource */
|
|
1243
|
+
export declare interface UsageName {
|
|
1244
|
+
/**
|
|
1245
|
+
* The name of the resource
|
|
1246
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1247
|
+
*/
|
|
1248
|
+
readonly value?: string;
|
|
1249
|
+
/**
|
|
1250
|
+
* The localized name of the resource
|
|
1251
|
+
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1252
|
+
*/
|
|
1253
|
+
readonly localizedValue?: string;
|
|
1254
|
+
}
|
|
1255
|
+
|
|
1256
|
+
/** The properties of the volume. */
|
|
1257
|
+
export declare interface Volume {
|
|
1258
|
+
/** The name of the volume. */
|
|
1259
|
+
name: string;
|
|
1260
|
+
/** The Azure File volume. */
|
|
1261
|
+
azureFile?: AzureFileVolume;
|
|
1262
|
+
/** The empty directory volume. */
|
|
1263
|
+
emptyDir?: Record<string, unknown>;
|
|
1264
|
+
/** The secret volume. */
|
|
1265
|
+
secret?: {
|
|
1266
|
+
[propertyName: string]: string;
|
|
1267
|
+
};
|
|
1268
|
+
/** The git repo volume. */
|
|
1269
|
+
gitRepo?: GitRepoVolume;
|
|
1270
|
+
}
|
|
1271
|
+
|
|
1272
|
+
/** The properties of the volume mount. */
|
|
1273
|
+
export declare interface VolumeMount {
|
|
1274
|
+
/** The name of the volume mount. */
|
|
1275
|
+
name: string;
|
|
1276
|
+
/** The path within the container where the volume should be mounted. Must not contain colon (:). */
|
|
1277
|
+
mountPath: string;
|
|
1278
|
+
/** The flag indicating whether the volume mount is read-only. */
|
|
1279
|
+
readOnly?: boolean;
|
|
1280
|
+
}
|
|
1281
|
+
|
|
1282
|
+
export { }
|