From 0c486695dace88245e55559efa0a2a93e26228f8 Mon Sep 17 00:00:00 2001 From: Jingjing Li Date: Thu, 25 May 2023 07:29:27 +0000 Subject: [PATCH] Update examples and spec for new API version. --- .../stable/2023-05-01/BatchManagement.json | 28 +++++- .../PoolCreate_AcceleratedNetworking.json | 94 +++++++++++++++++++ ...irtualMachineConfiguration_Extensions.json | 23 ++--- .../PoolGet_AcceleratedNetworking.json | 67 +++++++++++++ ...irtualMachineConfiguration_Extensions.json | 10 +- 5 files changed, 205 insertions(+), 17 deletions(-) create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolCreate_AcceleratedNetworking.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolGet_AcceleratedNetworking.json diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/BatchManagement.json index 899c53774bfc..a80aaea0a75d 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/BatchManagement.json @@ -2157,6 +2157,9 @@ }, "CreatePool - VirtualMachineConfiguration Extensions": { "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_Extensions.json" + }, + "CreatePool - accelerated networking": { + "$ref": "./examples/PoolCreate_AcceleratedNetworking.json" } }, "parameters": [ @@ -2367,6 +2370,9 @@ }, "GetPool - VirtualMachineConfiguration Extensions": { "$ref": "./examples/PoolGet_VirtualMachineConfiguration_Extensions.json" + }, + "GetPool - AcceleratedNetworking": { + "$ref": "./examples/PoolGet_AcceleratedNetworking.json" } }, "parameters": [ @@ -3115,7 +3121,7 @@ "properties": { "keyIdentifier": { "type": "string", - "description": "Full path to the versioned secret. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. To be usable the following prerequisites must be met:\n\n The Batch Account has a System Assigned identity\n The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions\n The KeyVault has soft-delete and purge protection enabled" + "description": "Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met:\n\n The Batch Account has a System Assigned identity\n The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions\n The KeyVault has soft-delete and purge protection enabled" } }, "description": "KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault." @@ -4754,7 +4760,8 @@ "type": "string", "title": "The container technology to be used.", "enum": [ - "DockerCompatible" + "DockerCompatible", + "CriCompatible" ], "x-ms-enum": { "name": "ContainerType", @@ -4763,6 +4770,10 @@ { "value": "DockerCompatible", "description": "A Docker compatible container technology will be used to launch the containers." + }, + { + "value": "CriCompatible", + "description": "A CRI based technology will be used to launch the containers." } ] } @@ -4851,6 +4862,10 @@ "type": "boolean", "description": "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." }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, "settings": { "type": "object", "title": "JSON formatted public settings for the extension." @@ -5500,6 +5515,15 @@ "$ref": "#/definitions/PublicIPAddressConfiguration", "title": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.", "description": "This property is only supported on Pools with the virtualMachineConfiguration property." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "title": "Whether this pool should enable accelerated networking.", + "description": "Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview", + "description": "Create a VM with Accelerated Networking." + } } }, "description": "The network configuration for a pool." diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolCreate_AcceleratedNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolCreate_AcceleratedNetworking.json new file mode 100644 index 000000000000..289919f3dad6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolCreate_AcceleratedNetworking.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-05-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D1_V2", + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "enableAcceleratedNetworking": true + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8DB46CB72A227E2\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DB46CB72A227E2\"", + "properties": { + "lastModified": "2023-04-27T02:59:41.8592226Z", + "creationTime": "2023-04-27T02:59:41.8592226Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z", + "vmSize": "STANDARD_D1_V2", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-04-27T02:59:41.8592226Z" + }, + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "currentNodeCommunicationMode": "Classic" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json index b14ab39a866e..d464e3cf5740 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json @@ -25,15 +25,14 @@ "extensions": [ { "name": "batchextension1", - "type": "SecurityMonitoringForLinux", - "publisher": "Microsoft.Azure.Security.Monitoring", - "typeHandlerVersion": "1.0", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, "settings": { - "settingsKey": "settingsValue" - }, - "protectedSettings": { - "protectedSettingsKey": "protectedSettingsValue" + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" } } ] @@ -85,12 +84,14 @@ "extensions": [ { "name": "batchextension1", - "type": "SecurityMonitoringForLinux", - "publisher": "Microsoft.Azure.Security.Monitoring", - "typeHandlerVersion": "1.0", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, "settings": { - "settingsKey": "settingsValue" + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" } } ] diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolGet_AcceleratedNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolGet_AcceleratedNetworking.json new file mode 100644 index 000000000000..1f7056fa18e2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolGet_AcceleratedNetworking.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2023-04-28T02:32:32.8696419Z", + "creationTime": "2023-04-28T02:32:32.8696419Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-04-28T02:32:32.8696419Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-04-28T02:33:40.82831Z", + "vmSize": "STANDARD_D1_V2", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "networkConfiguration": { + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-04-28T02:32:32.8696419Z" + }, + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "currentNodeCommunicationMode": "Classic" + } + } + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json index 4e25cc3b596b..a1aba90cd213 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2023-05-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json @@ -56,12 +56,14 @@ "extensions": [ { "name": "batchextension1", - "type": "SecurityMonitoringForLinux", - "publisher": "Microsoft.Azure.Security.Monitoring", - "typeHandlerVersion": "1.0", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, "settings": { - "settingsKey": "settingsValue" + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" } } ]