|
3 | 3 | "info": {
|
4 | 4 | "title": "BatchManagementClient",
|
5 | 5 | "description": "The Batch Management Client.",
|
6 |
| - "version": "2022-06-01" |
| 6 | + "version": "2022-10-01" |
7 | 7 | },
|
8 | 8 | "host": "management.azure.com",
|
9 | 9 | "schemes": [
|
|
1252 | 1252 | "tags": [
|
1253 | 1253 | "Certificate"
|
1254 | 1254 | ],
|
| 1255 | + "deprecated": true, |
1255 | 1256 | "operationId": "Certificate_ListByBatchAccount",
|
1256 |
| - "description": "Lists all of the certificates in the specified account.", |
| 1257 | + "summary": "Lists all of the certificates in the specified account.", |
| 1258 | + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", |
1257 | 1259 | "x-ms-examples": {
|
1258 | 1260 | "ListCertificates": {
|
1259 | 1261 | "$ref": "./examples/CertificateList.json"
|
|
1322 | 1324 | "tags": [
|
1323 | 1325 | "Certificate"
|
1324 | 1326 | ],
|
| 1327 | + "deprecated": true, |
1325 | 1328 | "operationId": "Certificate_Create",
|
1326 |
| - "description": "Creates a new certificate inside the specified account.", |
| 1329 | + "summary": "Creates a new certificate inside the specified account.", |
| 1330 | + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", |
1327 | 1331 | "x-ms-examples": {
|
1328 | 1332 | "CreateCertificate - Minimal Pfx": {
|
1329 | 1333 | "$ref": "./examples/CertificateCreate_Minimal.json"
|
|
1400 | 1404 | "tags": [
|
1401 | 1405 | "Certificate"
|
1402 | 1406 | ],
|
| 1407 | + "deprecated": true, |
1403 | 1408 | "operationId": "Certificate_Update",
|
1404 |
| - "description": "Updates the properties of an existing certificate.", |
| 1409 | + "summary": "Updates the properties of an existing certificate.", |
| 1410 | + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", |
1405 | 1411 | "x-ms-examples": {
|
1406 | 1412 | "UpdateCertificate": {
|
1407 | 1413 | "$ref": "./examples/CertificateUpdate.json"
|
|
1465 | 1471 | "tags": [
|
1466 | 1472 | "Certificate"
|
1467 | 1473 | ],
|
| 1474 | + "deprecated": true, |
1468 | 1475 | "operationId": "Certificate_Delete",
|
1469 |
| - "description": "Deletes the specified certificate.", |
| 1476 | + "summary": "Deletes the specified certificate.", |
| 1477 | + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", |
1470 | 1478 | "x-ms-examples": {
|
1471 | 1479 | "CertificateDelete": {
|
1472 | 1480 | "$ref": "./examples/CertificateDelete.json"
|
|
1526 | 1534 | "tags": [
|
1527 | 1535 | "Certificate"
|
1528 | 1536 | ],
|
| 1537 | + "deprecated": true, |
1529 | 1538 | "operationId": "Certificate_Get",
|
1530 |
| - "description": "Gets information about the specified certificate.", |
| 1539 | + "summary": "Gets information about the specified certificate.", |
| 1540 | + "description": "Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", |
1531 | 1541 | "x-ms-examples": {
|
1532 | 1542 | "Get Certificate": {
|
1533 | 1543 | "$ref": "./examples/CertificateGet.json"
|
|
1580 | 1590 | "tags": [
|
1581 | 1591 | "Certificate"
|
1582 | 1592 | ],
|
| 1593 | + "deprecated": true, |
1583 | 1594 | "operationId": "Certificate_CancelDeletion",
|
1584 | 1595 | "summary": "Cancels a failed deletion of a certificate from the specified account.",
|
1585 |
| - "description": "If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.", |
| 1596 | + "description": "If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.\n\nWarning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.", |
1586 | 1597 | "x-ms-examples": {
|
1587 | 1598 | "CertificateCancelDeletion": {
|
1588 | 1599 | "$ref": "./examples/CertificateCancelDeletion.json"
|
|
1971 | 1982 | }
|
1972 | 1983 | }
|
1973 | 1984 | },
|
1974 |
| - "204": { |
1975 |
| - "description": "The operation was successful." |
1976 |
| - }, |
1977 | 1985 | "default": {
|
1978 | 1986 | "description": "Error response describing why the operation failed.",
|
1979 | 1987 | "schema": {
|
|
2509 | 2517 | "BatchAccount"
|
2510 | 2518 | ],
|
2511 | 2519 | "operationId": "BatchAccount_ListOutboundNetworkDependenciesEndpoints",
|
2512 |
| - "description": "Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/azure/batch/batch-virtual-network", |
| 2520 | + "description": "Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://docs.microsoft.com/en-us/azure/batch/batch-virtual-network.", |
2513 | 2521 | "x-ms-examples": {
|
2514 | 2522 | "ListOutboundNetworkDependencies": {
|
2515 | 2523 | "$ref": "./examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json"
|
|
2998 | 3006 | },
|
2999 | 3007 | "allowedAuthenticationModes": {
|
3000 | 3008 | "readOnly": true,
|
3001 |
| - "x-nullable": false, |
| 3009 | + "x-nullable": true, |
3002 | 3010 | "type": "array",
|
3003 | 3011 | "items": {
|
3004 | 3012 | "$ref": "#/definitions/AuthenticationMode"
|
|
3661 | 3669 | "data": {
|
3662 | 3670 | "type": "string",
|
3663 | 3671 | "title": "The base64-encoded contents of the certificate.",
|
3664 |
| - "description": "The maximum size is 10KB." |
| 3672 | + "description": "The maximum size is 10KB.", |
| 3673 | + "x-ms-mutability": [ |
| 3674 | + "read", |
| 3675 | + "update" |
| 3676 | + ] |
3665 | 3677 | },
|
3666 | 3678 | "password": {
|
3667 | 3679 | "type": "string",
|
|
3948 | 3960 | "type": "string",
|
3949 | 3961 | "title": "Description of the private Connection state"
|
3950 | 3962 | },
|
3951 |
| - "actionRequired": { |
| 3963 | + "actionsRequired": { |
3952 | 3964 | "type": "string",
|
3953 | 3965 | "title": "Action required on the private connection state",
|
3954 | 3966 | "readOnly": true
|
|
4109 | 4121 | "currentDedicatedNodes": {
|
4110 | 4122 | "type": "integer",
|
4111 | 4123 | "format": "int32",
|
4112 |
| - "title": "The number of compute nodes currently in the pool.", |
| 4124 | + "title": "The number of dedicated compute nodes currently in the pool.", |
4113 | 4125 | "readOnly": true
|
4114 | 4126 | },
|
4115 | 4127 | "currentLowPriorityNodes": {
|
|
4198 | 4210 | "$ref": "#/definitions/CertificateReference"
|
4199 | 4211 | },
|
4200 | 4212 | "title": "The list of certificates to be installed on each compute node in the pool.",
|
4201 |
| - "description": "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." |
| 4213 | + "description": "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.\n\nWarning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead." |
4202 | 4214 | },
|
4203 | 4215 | "applicationPackages": {
|
4204 | 4216 | "type": "array",
|
|
4229 | 4241 | "x-ms-identifiers": [],
|
4230 | 4242 | "title": "A list of file systems to mount on each node in the pool.",
|
4231 | 4243 | "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse."
|
| 4244 | + }, |
| 4245 | + "targetNodeCommunicationMode": { |
| 4246 | + "title": "The desired node communication mode for the pool.", |
| 4247 | + "description": "If omitted, the default value is Default.", |
| 4248 | + "$ref": "#/definitions/NodeCommunicationMode" |
| 4249 | + }, |
| 4250 | + "currentNodeCommunicationMode": { |
| 4251 | + "title": "The current state of the pool communication mode.", |
| 4252 | + "$ref": "#/definitions/NodeCommunicationMode", |
| 4253 | + "x-nullable": true, |
| 4254 | + "readOnly": true |
4232 | 4255 | }
|
4233 | 4256 | },
|
4234 | 4257 | "description": "Pool properties."
|
|
4351 | 4374 | "nodeDeallocationOption": {
|
4352 | 4375 | "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.",
|
4353 | 4376 | "description": "If omitted, the default value is Requeue.",
|
4354 |
| - "$ref": "#/definitions/ComputeNodeDeallocationOption" |
| 4377 | + "$ref": "#/definitions/ComputeNodeDeallocationOption", |
| 4378 | + "x-ms-mutability": [ |
| 4379 | + "create", |
| 4380 | + "update" |
| 4381 | + ] |
4355 | 4382 | }
|
4356 | 4383 | },
|
4357 | 4384 | "title": "Fixed scale settings for the pool."
|
|
4458 | 4485 | "required": [
|
4459 | 4486 | "id"
|
4460 | 4487 | ],
|
4461 |
| - "title": "A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool." |
| 4488 | + "title": "A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool.", |
| 4489 | + "description": "Warning: This object is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead." |
4462 | 4490 | },
|
4463 | 4491 | "ApplicationPackageReference": {
|
4464 | 4492 | "type": "object",
|
|
4557 | 4585 | ],
|
4558 | 4586 | "title": "The results and errors from an execution of a pool autoscale formula."
|
4559 | 4587 | },
|
| 4588 | + "NodeCommunicationMode": { |
| 4589 | + "type": "string", |
| 4590 | + "title": "Determines how a pool communicates with the Batch service.", |
| 4591 | + "enum": [ |
| 4592 | + "Default", |
| 4593 | + "Classic", |
| 4594 | + "Simplified" |
| 4595 | + ], |
| 4596 | + "x-ms-enum": { |
| 4597 | + "name": "NodeCommunicationMode", |
| 4598 | + "modelAsString": false, |
| 4599 | + "values": [ |
| 4600 | + { |
| 4601 | + "value": "Default", |
| 4602 | + "description": "The node communication mode is automatically set by the Batch service." |
| 4603 | + }, |
| 4604 | + { |
| 4605 | + "value": "Classic", |
| 4606 | + "description": "Nodes using the Classic communication mode require inbound TCP communication on ports 29876 and 29877 from the \"BatchNodeManagement.{region}\" service tag and outbound TCP communication on port 443 to the \"Storage.region\" and \"BatchNodeManagement.{region}\" service tags." |
| 4607 | + }, |
| 4608 | + { |
| 4609 | + "value": "Simplified", |
| 4610 | + "description": "Nodes using the Simplified communication mode require outbound TCP communication on port 443 to the \"BatchNodeManagement.{region}\" service tag. No open inbound ports are required." |
| 4611 | + } |
| 4612 | + ] |
| 4613 | + } |
| 4614 | + }, |
4560 | 4615 | "VirtualMachineConfiguration": {
|
4561 | 4616 | "type": "object",
|
4562 | 4617 | "properties": {
|
|
4980 | 5035 | "properties": {
|
4981 | 5036 | "name": {
|
4982 | 5037 | "type": "string",
|
4983 |
| - "title": "The name of the user account." |
| 5038 | + "title": "The name of the user account. Names can contain any Unicode characters up to a maximum length of 20." |
4984 | 5039 | },
|
4985 | 5040 | "password": {
|
4986 | 5041 | "type": "string",
|
|
5410 | 5465 | "description": "Setting up RBAC for Azure Batch VNets"
|
5411 | 5466 | }
|
5412 | 5467 | },
|
5413 |
| - "dynamicVNetAssignmentScope": { |
| 5468 | + "dynamicVnetAssignmentScope": { |
5414 | 5469 | "type": "string",
|
5415 | 5470 | "title": "The scope of dynamic vnet assignment.",
|
5416 | 5471 | "enum": [
|
|
5750 | 5805 | "$ref": "#/definitions/CloudErrorBody"
|
5751 | 5806 | },
|
5752 | 5807 | "x-ms-identifiers": [
|
5753 |
| - "code", |
5754 |
| - "message" |
| 5808 | + "message", |
| 5809 | + "target" |
5755 | 5810 | ],
|
5756 | 5811 | "description": "A list of additional details about the error."
|
5757 | 5812 | }
|
|
6059 | 6114 | "CIFSMountConfiguration": {
|
6060 | 6115 | "type": "object",
|
6061 | 6116 | "properties": {
|
6062 |
| - "username": { |
| 6117 | + "userName": { |
6063 | 6118 | "type": "string",
|
6064 | 6119 | "title": "The user to use for authentication against the CIFS file system."
|
6065 | 6120 | },
|
|
6083 | 6138 | }
|
6084 | 6139 | },
|
6085 | 6140 | "required": [
|
6086 |
| - "username", |
6087 | 6141 | "source",
|
6088 | 6142 | "password",
|
6089 | 6143 | "relativeMountPath"
|
|
6120 | 6174 | "required": [
|
6121 | 6175 | "accountName",
|
6122 | 6176 | "azureFileUrl",
|
6123 |
| - "accountKey", |
6124 | 6177 | "relativeMountPath"
|
6125 | 6178 | ],
|
6126 | 6179 | "title": "Information used to connect to an Azure Fileshare."
|
|
0 commit comments