diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/Application.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/Application.tsp index 0d19552495ee..ca5b9e7b1f5c 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/Application.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/Application.tsp @@ -27,15 +27,15 @@ model Application /** * The ETag of the resource, used for concurrency statements. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" @visibility(Lifecycle.Read) etag?: string; /** * The tags of the resource. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; } @@ -50,7 +50,7 @@ interface Applications { /** * Adds an application to the specified Batch account. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "Legacy behavior" create is Azure.ResourceManager.Legacy.CreateOrReplaceSync< Application, Response = ArmResourceUpdatedResponse, diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/ApplicationPackage.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/ApplicationPackage.tsp index 968831e5e5d0..9b8be493672c 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/ApplicationPackage.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/ApplicationPackage.tsp @@ -27,15 +27,15 @@ model ApplicationPackage /** * The ETag of the resource, used for concurrency statements. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" @visibility(Lifecycle.Read) etag?: string; /** * The tags of the resource. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; } @@ -50,7 +50,7 @@ interface ApplicationPackages { /** * Creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "Legacy behavior" create is Azure.ResourceManager.Legacy.CreateOrReplaceSync< ApplicationPackage, Response = ArmResourceUpdatedResponse, @@ -102,7 +102,7 @@ interface ApplicationPackages { @@doc(ApplicationPackages.activate::parameters.body, "The parameters for the request." ); -#suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-openapi" "Legacy design that typespec didn't have a direct translation for" @@extension(Applications.create::parameters.resource, "required", false); -#suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-openapi" "Legacy design that typespec didn't have a direct translation for" @@extension(ApplicationPackages.create::parameters.resource, "required", false); diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/BatchAccount.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/BatchAccount.tsp index 768342a2a74b..a9ffb669a095 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/BatchAccount.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/BatchAccount.tsp @@ -25,7 +25,7 @@ model BatchAccount /** * The identity of the Batch account. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" identity?: BatchAccountIdentity; } @@ -40,7 +40,7 @@ interface BatchAccounts { /** * Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "Legacy behavior" create is Legacy.CreateOrReplaceAsync< BatchAccount, Request = BatchAccountCreateParameters, @@ -62,7 +62,7 @@ interface BatchAccounts { /** * Deletes the specified Batch account. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "Legacy design" delete is ArmResourceDeleteWithoutOkAsync< BatchAccount, Response = ArmDeletedResponse | ArmDeleteAcceptedLroResponse | ArmDeletedNoContentResponse, diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/Certificate.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/Certificate.tsp index 824509b73859..f7dcd404e920 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/Certificate.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/Certificate.tsp @@ -9,6 +9,7 @@ using TypeSpec.Rest; using Azure.ResourceManager; using TypeSpec.Http; using TypeSpec.OpenAPI; +using Versioning; namespace Microsoft.Batch; /** @@ -27,15 +28,15 @@ model Certificate /** * The ETag of the resource, used for concurrency statements. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" @visibility(Lifecycle.Read) etag?: string; /** * The tags of the resource. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; } @@ -45,7 +46,8 @@ interface Certificates { /** * 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. */ - #deprecated "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #deprecated "Removal of feature" + @removed(Versions.v2025_06_01) get is ArmResourceRead< Certificate, Response = ArmResponse & { @@ -61,8 +63,9 @@ interface Certificates { /** * 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. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #deprecated "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "Legacy behavior" + #deprecated "Removal of feature" + @removed(Versions.v2025_06_01) create is Azure.ResourceManager.Legacy.CreateOrReplaceAsync< Certificate, Request = CertificateCreateOrUpdateParameters, @@ -70,14 +73,14 @@ interface Certificates { /** * The entity state (ETag) version of the certificate to update. A value of "*" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @header("If-Match") `If-Match`?: string; /** * Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @header("If-None-Match") `If-None-Match`?: string; }, @@ -94,7 +97,8 @@ interface Certificates { /** * 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. */ - #deprecated "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #deprecated "Removal of feature" + @removed(Versions.v2025_06_01) @patch(#{ implicitOptionality: false }) update is ArmCustomPatchSync< Certificate, @@ -103,7 +107,7 @@ interface Certificates { /** * The entity state (ETag) version of the certificate to update. This value can be omitted or set to "*" to apply the operation unconditionally. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @header("If-Match") `If-Match`?: string; }, @@ -120,8 +124,9 @@ interface Certificates { /** * 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. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #deprecated "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "Legacy design" + #deprecated "Removal of feature" + @removed(Versions.v2025_06_01) delete is ArmResourceDeleteWithoutOkAsync< Certificate, Response = ArmDeletedResponse | ArmDeleteAcceptedLroResponse | ArmDeletedNoContentResponse, @@ -131,7 +136,8 @@ interface Certificates { /** * 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. */ - #deprecated "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #deprecated "Removal of feature" + @removed(Versions.v2025_06_01) listByBatchAccount is ArmResourceListByParent< Certificate, Parameters = { @@ -162,7 +168,8 @@ interface Certificates { * * 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. */ - #deprecated "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #deprecated "Removal of feature" + @removed(Versions.v2025_06_01) @action("cancelDelete") cancelDeletion is ArmResourceActionSync< Certificate, diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/DetectorResponse.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/DetectorResponse.tsp index 909bdb09fa4c..c3f40d8e6255 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/DetectorResponse.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/DetectorResponse.tsp @@ -27,15 +27,15 @@ model DetectorResponse /** * The ETag of the resource, used for concurrency statements. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" @visibility(Lifecycle.Read) etag?: string; /** * The tags of the resource. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; } diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/Pool.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/Pool.tsp index c803e73ac226..6e3eccae451b 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/Pool.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/Pool.tsp @@ -26,21 +26,21 @@ model Pool is Azure.ResourceManager.ProxyResource { /** * The type of identity used for the Batch Pool. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" identity?: BatchPoolIdentity; /** * The ETag of the resource, used for concurrency statements. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" @visibility(Lifecycle.Read) etag?: string; /** * The tags of the resource. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; } @@ -65,21 +65,21 @@ interface Pools { /** * Creates a new pool inside the specified account. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "Legacy behavior" create is ArmResourceCreateOrReplaceSync< Pool, Parameters = { /** * The entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @header("If-Match") `If-Match`?: string; /** * Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @header("If-None-Match") `If-None-Match`?: string; }, @@ -104,7 +104,7 @@ interface Pools { /** * The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @header("If-Match") `If-Match`?: string; }, @@ -121,7 +121,7 @@ interface Pools { /** * Deletes the specified pool. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "Legacy design" delete is ArmResourceDeleteWithoutOkAsync< Pool, Response = ArmDeletedResponse | ArmDeleteAcceptedLroResponse | ArmDeletedNoContentResponse, diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/PrivateEndpointConnection.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/PrivateEndpointConnection.tsp index 992fc4b37c06..d3ef468a862d 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/PrivateEndpointConnection.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/PrivateEndpointConnection.tsp @@ -27,15 +27,15 @@ model PrivateEndpointConnection /** * The ETag of the resource, used for concurrency statements. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" @visibility(Lifecycle.Read) etag?: string; /** * The tags of the resource. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; } @@ -61,7 +61,7 @@ interface PrivateEndpointConnections { /** * The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to "*" to apply the operation unconditionally. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @header("If-Match") `If-Match`?: string; }, @@ -71,7 +71,7 @@ interface PrivateEndpointConnections { /** * Deletes the specified private endpoint connection. */ - #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "Legacy design" @Azure.Core.useFinalStateVia("azure-async-operation") delete is ArmResourceDeleteWithoutOkAsync< PrivateEndpointConnection, diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/PrivateLinkResource.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/PrivateLinkResource.tsp index 81ce32b10346..7fb0154e31e4 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/PrivateLinkResource.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/PrivateLinkResource.tsp @@ -27,15 +27,15 @@ model PrivateLinkResource /** * The ETag of the resource, used for concurrency statements. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" @visibility(Lifecycle.Read) etag?: string; /** * The tags of the resource. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Legacy design" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; } diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/back-compatible.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/back-compatible.tsp index 696925015aa8..085b46a8e4f6 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/back-compatible.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/back-compatible.tsp @@ -4,13 +4,13 @@ using Azure.ClientGenerator.Core; using Azure.ClientGenerator.Core.Legacy; using Microsoft.Batch; -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(BatchAccountCreateParameters.properties); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(BatchAccountUpdateParameters.properties); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(CertificateCreateOrUpdateParameters.properties); @@clientName(ContainerRegistry.username, "userName"); @@ -30,7 +30,7 @@ using Microsoft.Batch; @@clientLocation(BatchAccounts.listOutboundNetworkDependenciesEndpoints, "BatchAccount" ); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(BatchAccount.properties); @@clientLocation(PrivateEndpointConnections.get, "PrivateEndpointConnection"); @@ -46,7 +46,7 @@ using Microsoft.Batch; @@clientLocation(PrivateEndpointConnections.listByBatchAccount, "PrivateEndpointConnection" ); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(PrivateEndpointConnection.properties); @@clientLocation(ApplicationPackages.get, "ApplicationPackage"); @@ -56,7 +56,7 @@ using Microsoft.Batch; @@clientLocation(ApplicationPackages.list, "ApplicationPackage"); @@clientLocation(ApplicationPackages.activate, "ApplicationPackage"); @@clientName(ApplicationPackages.activate::parameters.body, "parameters"); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(ApplicationPackage.properties); @@clientLocation(Applications.get, "Application"); @@ -66,7 +66,7 @@ using Microsoft.Batch; @@clientName(Applications.update::parameters.properties, "parameters"); @@clientLocation(Applications.delete, "Application"); @@clientLocation(Applications.list, "Application"); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(Application.properties); @@clientLocation(Certificates.get, "Certificate"); @@ -77,19 +77,19 @@ using Microsoft.Batch; @@clientLocation(Certificates.delete, "Certificate"); @@clientLocation(Certificates.listByBatchAccount, "Certificate"); @@clientLocation(Certificates.cancelDeletion, "Certificate"); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(Certificate.properties); @@clientLocation(DetectorResponses.getDetector, "BatchAccount"); @@clientLocation(DetectorResponses.listDetectors, "BatchAccount"); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(DetectorResponse.properties); @@clientLocation(PrivateLinkResources.get, "PrivateLinkResource"); @@clientLocation(PrivateLinkResources.listByBatchAccount, "PrivateLinkResource" ); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(PrivateLinkResource.properties); @@clientLocation(Pools.get, "Pool"); @@ -101,7 +101,7 @@ using Microsoft.Batch; @@clientLocation(Pools.listByBatchAccount, "Pool"); @@clientLocation(Pools.disableAutoScale, "Pool"); @@clientLocation(Pools.stopResize, "Pool"); -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "brownfield service" @@flattenProperty(Pool.properties); @@clientLocation(NetworkSecurityPerimeterConfigurations.getConfiguration, @@ -129,7 +129,9 @@ using Microsoft.Batch; ); @@alternateType(IPRule.action, "Allow", "go"); -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** + * The subscription resource ID for an access rule. + */ model AccessRulePropertiesSubscriptionsItem { /** The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') */ id?: Azure.Core.armResourceIdentifier; diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationCreate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationCreate.json new file mode 100644 index 000000000000..945f30339b24 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + }, + "headers": { + "ETag": "W/\"0x8D64F8EBB3DC411\"" + } + } + }, + "operationId": "Application_Create", + "title": "ApplicationCreate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationDelete.json new file mode 100644 index 000000000000..866bcafea3e4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Application_Delete", + "title": "ApplicationDelete" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationGet.json new file mode 100644 index 000000000000..bf814f16ace7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "properties": { + "allowUpdates": true, + "displayName": "Sample Application" + } + }, + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + } + } + }, + "operationId": "Application_Get", + "title": "ApplicationGet" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationList.json new file mode 100644 index 000000000000..f47073a86fc6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "properties": { + "allowUpdates": false, + "defaultVersion": "1" + } + }, + { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app2", + "properties": { + "allowUpdates": false, + "defaultVersion": "2.0", + "displayName": "myAppName" + } + } + ] + } + } + }, + "operationId": "Application_List", + "title": "ApplicationList" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageActivate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageActivate.json new file mode 100644 index 000000000000..d4da721e6527 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageActivate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "parameters": { + "format": "zip" + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "versionName": "1" + }, + "responses": { + "200": { + "body": { + "name": "1", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "properties": { + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z", + "state": "Active" + } + }, + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + } + } + }, + "operationId": "ApplicationPackage_Activate", + "title": "ApplicationPackageActivate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageCreate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageCreate.json new file mode 100644 index 000000000000..22b7e097baa7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageCreate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "versionName": "1" + }, + "responses": { + "200": { + "body": { + "name": "1", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "properties": { + "state": "Pending", + "storageUrl": "http://mystorage1.blob.core.windows.net/myapp?mysas", + "storageUrlExpiry": "2017-06-27T18:48:09.9330991Z" + } + }, + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + } + } + }, + "operationId": "ApplicationPackage_Create", + "title": "ApplicationPackageCreate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageDelete.json new file mode 100644 index 000000000000..4b49eb7d6df4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "versionName": "1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApplicationPackage_Delete", + "title": "ApplicationPackageDelete" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageGet.json new file mode 100644 index 000000000000..8472888632ce --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "versionName": "1" + }, + "responses": { + "200": { + "body": { + "name": "1", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "properties": { + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z", + "state": "Active" + } + }, + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + } + } + }, + "operationId": "ApplicationPackage_Get", + "title": "ApplicationPackageGet" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageList.json new file mode 100644 index 000000000000..3f5a798d6772 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationPackageList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1.0", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1.0", + "properties": { + "state": "Pending" + } + }, + { + "name": "2.0", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/2.0", + "properties": { + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z", + "state": "Active" + } + } + ] + } + } + }, + "operationId": "ApplicationPackage_List", + "title": "ApplicationPackageList" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationUpdate.json new file mode 100644 index 000000000000..e81937b18131 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/ApplicationUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": true, + "defaultVersion": "2", + "displayName": "myAppName" + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "properties": { + "allowUpdates": true, + "defaultVersion": "2", + "displayName": "myAppName" + } + }, + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + } + } + }, + "operationId": "Application_Update", + "title": "ApplicationUpdate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_BYOS.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_BYOS.json new file mode 100644 index 000000000000..3080074c30b9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_BYOS.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "keyVaultReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "poolAllocationMode": "UserSubscription" + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "keyVaultReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "UserSubscription", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "BatchAccountCreate_BYOS" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_Default.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_Default.json new file mode 100644 index 000000000000..301a5401dbcf --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_Default.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "BatchAccountCreate_Default" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_SystemAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_SystemAssignedIdentity.json new file mode 100644 index 000000000000..3118d715566a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_SystemAssignedIdentity.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "SystemAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "BatchAccountCreate_SystemAssignedIdentity" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_UserAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_UserAssignedIdentity.json new file mode 100644 index 000000000000..2116488f2483 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountCreate_UserAssignedIdentity.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + } + } + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "BatchAccountCreate_UserAssignedIdentity" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountDelete.json new file mode 100644 index 000000000000..39f1d460c855 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/providers/Microsoft.Batch/locations/japaneast/accountOperationResults/sampleacct-30a022cb-a64f-4fd5-9289-8b38b342e9de?api-version=2025-06-01" + } + }, + "204": {} + }, + "operationId": "BatchAccount_Delete", + "title": "BatchAccountDelete" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountGet.json new file mode 100644 index 000000000000..cee3b2ea5e85 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + }, + "operationId": "BatchAccount_Get", + "title": "BatchAccountGet" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountGetKeys.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountGetKeys.json new file mode 100644 index 000000000000..dab4292668bd --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountGetKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + }, + "operationId": "BatchAccount_GetKeys", + "title": "BatchAccountGetKeys" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountList.json new file mode 100644 index 000000000000..ea970e6178e2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + ] + } + } + }, + "operationId": "BatchAccount_List", + "title": "BatchAccountList" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountListByResourceGroup.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountListByResourceGroup.json new file mode 100644 index 000000000000..5d10b7ef3b99 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountListByResourceGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + ] + } + } + }, + "operationId": "BatchAccount_ListByResourceGroup", + "title": "BatchAccountListByResourceGroup" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountListOutboundNetworkDependenciesEndpoints.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..9b8f00aefd3c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure Batch", + "endpoints": [ + { + "description": "Applicable to job manager tasks, tasks that use job scoped authentication, or any task that makes calls to Batch.", + "domainName": "sampleacct.japaneast.batch.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "description": "Applicable to all Azure Batch pools.", + "domainName": "japaneast.service.batch.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "description": "AutoStorage endpoint for this Batch account. Applicable to all Azure Batch pools under this account.", + "domainName": "autostorageaccountname.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "description": "Applicable to all Azure Batch pools.", + "domainName": "*.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "description": "Applicable to all Azure Batch pools.", + "domainName": "*.table.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "description": "Applicable to all Azure Batch pools.", + "domainName": "*.queue.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Package Repository", + "endpoints": [ + { + "description": "Only applicable to pools containing a Mount Configuration. Learn about Mount Configurations in Batch at https://learn.microsoft.com/azure/batch/virtual-file-mount.", + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Key Vault", + "endpoints": [ + { + "description": "Only applicable to pools containing a Disk Encryption Configuration and whose VM size does not support encryption at host. Learn more about disk encryption in Azure Batch at https://learn.microsoft.com/azure/batch/disk-encryption. Learn more about encryption at host and supported VM sizes at https://learn.microsoft.com/azure/virtual-machines/disks-enable-host-based-encryption-portal.", + "domainName": "*.vault.azure.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + }, + "operationId": "BatchAccount_ListOutboundNetworkDependenciesEndpoints", + "title": "ListOutboundNetworkDependencies" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountRegenerateKey.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountRegenerateKey.json new file mode 100644 index 000000000000..941fa2aada53 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountRegenerateKey.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "keyName": "Primary" + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + }, + "operationId": "BatchAccount_RegenerateKey", + "title": "BatchAccountRegenerateKey" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountSynchronizeAutoStorageKeys.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountSynchronizeAutoStorageKeys.json new file mode 100644 index 000000000000..f3ec35ca9015 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountSynchronizeAutoStorageKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "204": {} + }, + "operationId": "BatchAccount_SynchronizeAutoStorageKeys", + "title": "BatchAccountSynchronizeAutoStorageKeys" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountUpdate.json new file mode 100644 index 000000000000..3e10d9347b56 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/BatchAccountUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + }, + "operationId": "BatchAccount_Update", + "title": "BatchAccountUpdate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/DetectorGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/DetectorGet.json new file mode 100644 index 000000000000..e2bd8a6c90eb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/DetectorGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "detectorId": "poolsAndNodes", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "poolsAndNodes", + "type": "Microsoft.Batch/batchAccounts/detectors", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/detectors/poolsAndNodes", + "properties": { + "value": "ew0KICAibWV0YWRhdGEiOiB7DQogICAgImlkIjogInBvb2xzQW5kTm9kZXMiLA0KICAgICJuYW1lIjogIlBvb2xzIGFuZCBOb2RlcyIsDQogICAgImRlc2NyaXB0aW9uIjogbnVsbCwNCiAgICAiYXV0aG9yIjogIiIsDQogICAgImNhdGVnb3J5IjogbnVsbCwNCiAgICAic3VwcG9ydFRvcGljTGlzdCI6IFsNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc3IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDYxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY1IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY2IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDcyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDgyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkzIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDk0IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfQ0KICAgIF0sDQogICAgImFuYWx5c2lzVHlwZXMiOiBudWxsLA0KICAgICJ0eXBlIjogIkFuYWx5c2lzIiwNCiAgICAic2NvcmUiOiAwLjANCiAgfSwNCiAgImRhdGFzZXQiOiBbXSwNCiAgInN0YXR1cyI6IHsNCiAgICAibWVzc2FnZSI6IG51bGwsDQogICAgInN0YXR1c0lkIjogNA0KICB9LA0KICAiZGF0YVByb3ZpZGVyc01ldGFkYXRhIjogbnVsbCwNCiAgInN1Z2dlc3RlZFV0dGVyYW5jZXMiOiBudWxsDQp9" + } + } + } + }, + "operationId": "BatchAccount_GetDetector", + "title": "GetDetector" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/DetectorList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/DetectorList.json new file mode 100644 index 000000000000..f05007632d6b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/DetectorList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "poolsAndNodes", + "type": "Microsoft.Batch/batchAccounts/detectors", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/detectors/poolsAndNodes", + "properties": { + "value": "ew0KICAibWV0YWRhdGEiOiB7DQogICAgImlkIjogInBvb2xzQW5kTm9kZXMiLA0KICAgICJuYW1lIjogIlBvb2xzIGFuZCBOb2RlcyIsDQogICAgImRlc2NyaXB0aW9uIjogbnVsbCwNCiAgICAiYXV0aG9yIjogIiIsDQogICAgImNhdGVnb3J5IjogbnVsbCwNCiAgICAic3VwcG9ydFRvcGljTGlzdCI6IFsNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc3IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDYxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY1IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY2IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDcyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDgyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkzIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDk0IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfQ0KICAgIF0sDQogICAgImFuYWx5c2lzVHlwZXMiOiBudWxsLA0KICAgICJ0eXBlIjogIkFuYWx5c2lzIiwNCiAgICAic2NvcmUiOiAwLjANCiAgfSwNCiAgImRhdGFzZXQiOiBbXSwNCiAgInN0YXR1cyI6IHsNCiAgICAibWVzc2FnZSI6IG51bGwsDQogICAgInN0YXR1c0lkIjogNA0KICB9LA0KICAiZGF0YVByb3ZpZGVyc01ldGFkYXRhIjogbnVsbCwNCiAgInN1Z2dlc3RlZFV0dGVyYW5jZXMiOiBudWxsDQp9" + } + } + ] + } + } + }, + "operationId": "BatchAccount_ListDetectors", + "title": "ListDetectors" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationCheckNameAvailability_AlreadyExists.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationCheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..4afadde459c2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationCheckNameAvailability_AlreadyExists.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "locationName": "japaneast", + "parameters": { + "name": "existingaccountname", + "type": "Microsoft.Batch/batchAccounts" + }, + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "message": "An account named 'existingaccountname' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "Location_CheckNameAvailability", + "title": "LocationCheckNameAvailability_AlreadyExists" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationCheckNameAvailability_Available.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationCheckNameAvailability_Available.json new file mode 100644 index 000000000000..d1dacaaba92d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationCheckNameAvailability_Available.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "locationName": "japaneast", + "parameters": { + "name": "newaccountname", + "type": "Microsoft.Batch/batchAccounts" + }, + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "Location_CheckNameAvailability", + "title": "LocationCheckNameAvailability_Available" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationGetQuotas.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationGetQuotas.json new file mode 100644 index 000000000000..44683f1358c0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationGetQuotas.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "locationName": "japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "accountQuota": 1 + } + } + }, + "operationId": "Location_GetQuotas", + "title": "LocationGetQuotas" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationListVirtualMachineSkus.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationListVirtualMachineSkus.json new file mode 100644 index 000000000000..ce102c623953 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/LocationListVirtualMachineSkus.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "locationName": "japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_D1_v2", + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + } + ], + "familyName": "standardDFamily" + }, + { + "name": "Standard_A1", + "batchSupportEndOfLife": "2024-08-31T00:00:00Z", + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "71680" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "1.75" + }, + { + "name": "MaxDataDiskCount", + "value": "2" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "IaaS,PaaS" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "ACUs", + "value": "100" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "False" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "familyName": "standardA0_A7Family" + } + ] + } + } + }, + "operationId": "Location_ListSupportedVirtualMachineSkus", + "title": "LocationListVirtualMachineSkus" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationGet.json new file mode 100644 index 000000000000..1b00c088c7ca --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationGet.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "networkSecurityPerimeterConfigurationName": "00000000-0000-0000-0000-000000000000.sampleassociation", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000.sampleassociation", + "type": "Microsoft.Batch/batchAccounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/networkSecurityPerimeterConfigurations/00000000-0000-0000-0000-000000000000.sampleassociation", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/perimeterSubscriptionId/resourceGroups/perimeterResourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeterName", + "location": "perimeterLocation", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "accessRule1", + "properties": { + "addressPrefixes": [ + "10.11.0.0/16", + "10.10.1.0/24" + ], + "direction": "Inbound", + "emailAddresses": [], + "fullyQualifiedDomainNames": [], + "networkSecurityPerimeters": [], + "phoneNumbers": [], + "subscriptions": [] + } + }, + { + "name": "accessRule2", + "properties": { + "addressPrefixes": [], + "direction": "Outbound", + "emailAddresses": [], + "fullyQualifiedDomainNames": [ + "paasrp1.contoso.org", + "paasrp2.contoso.org" + ], + "networkSecurityPerimeters": [], + "phoneNumbers": [], + "subscriptions": [] + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningIssues": [], + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "sampleassociation", + "accessMode": "Learning" + } + } + } + } + }, + "operationId": "NetworkSecurityPerimeter_GetConfiguration", + "title": "GetNspConfiguration" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationReconcile.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationReconcile.json new file mode 100644 index 000000000000..77f63b662160 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationReconcile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "networkSecurityPerimeterConfigurationName": "00000000-0000-0000-0000-000000000000.sampleassociation", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/networkSecurityPerimeterConfigurationOperationResults/AcceptedReconciling$00000000-0000-0000-0000-000000000000.sampleassociation$00000000-1111-2222-3333-444444444444?api-version=2025-06-01", + "Retry-After": "15" + } + } + }, + "operationId": "NetworkSecurityPerimeter_ReconcileConfiguration", + "title": "ReconcileNspConfiguration" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationsList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationsList.json new file mode 100644 index 000000000000..ffe018cff9f9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/NspConfigurationsList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000.sampleassociation", + "type": "Microsoft.Batch/batchAccounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/networkSecurityPerimeterConfigurations/00000000-0000-0000-0000-000000000000.sampleassociation", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/perimeterSubscriptionId/resourceGroups/perimeterResourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeterName", + "location": "perimeterLocation", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "accessRule1", + "properties": { + "addressPrefixes": [ + "10.11.0.0/16", + "10.10.1.0/24" + ], + "direction": "Inbound", + "emailAddresses": [], + "fullyQualifiedDomainNames": [], + "networkSecurityPerimeters": [], + "phoneNumbers": [], + "subscriptions": [] + } + }, + { + "name": "accessRule2", + "properties": { + "addressPrefixes": [], + "direction": "Outbound", + "emailAddresses": [], + "fullyQualifiedDomainNames": [ + "paasrp1.contoso.org", + "paasrp2.contoso.org" + ], + "networkSecurityPerimeters": [], + "phoneNumbers": [], + "subscriptions": [] + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningIssues": [], + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "sampleassociation", + "accessMode": "Learning" + } + } + } + ] + } + } + }, + "operationId": "NetworkSecurityPerimeter_ListConfigurations", + "title": "ListNspConfigurations" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/OperationsList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/OperationsList.json new file mode 100644 index 000000000000..d2361fed4e67 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/OperationsList.json @@ -0,0 +1,522 @@ +{ + "parameters": { + "api-version": "2025-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "description": "Gets the diagnostic setting for the resource", + "operation": "Read diagnostic setting", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "description": "Creates or updates the diagnostic setting for the resource", + "operation": "Write diagnostic setting", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "description": "Gets the available logs for the Batch service", + "operation": "Read Batch service log definitions", + "provider": "Microsoft Batch", + "resource": "Batch Account Log Definitions" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "description": "Gets the available metrics for the Batch service", + "operation": "Read Batch service metric definitions", + "provider": "Microsoft Batch", + "resource": "Batch Account Metric Definitions" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/read", + "display": { + "description": "Lists jobs on a Batch account or gets the properties of a job", + "operation": "List or Get Jobs", + "provider": "Microsoft Batch", + "resource": "Jobs" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/write", + "display": { + "description": "Creates a new job on a Batch account or updates an existing job", + "operation": "Create or Update Job", + "provider": "Microsoft Batch", + "resource": "Jobs" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/delete", + "display": { + "description": "Deletes a job from a Batch account", + "operation": "Delete Job", + "provider": "Microsoft Batch", + "resource": "Jobs" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/read", + "display": { + "description": "Lists job schedules on a Batch account or gets the properties of a job schedule", + "operation": "List or Get Job Schedules", + "provider": "Microsoft Batch", + "resource": "Job Schedules" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/write", + "display": { + "description": "Creates a new job schedule on a Batch account or updates an existing job schedule", + "operation": "Create or Update Job Schedule", + "provider": "Microsoft Batch", + "resource": "Job Schedules" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/delete", + "display": { + "description": "Deletes a job schedule from a Batch account", + "operation": "Delete Job Schedule", + "provider": "Microsoft Batch", + "resource": "Job Schedules" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/operations/read", + "display": { + "description": "Lists operations available on Microsoft.Batch resource provider", + "operation": "List Available Batch Operations", + "provider": "Microsoft Batch", + "resource": "Available Batch Operations" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/read", + "display": { + "description": "Lists Batch accounts or gets the properties of a Batch account", + "operation": "List or Get Batch Accounts", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/write", + "display": { + "description": "Creates a new Batch account or updates an existing Batch account", + "operation": "Create or Update Batch Account", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/delete", + "display": { + "description": "Deletes a Batch account", + "operation": "Delete Batch Account", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/listkeys/action", + "display": { + "description": "Lists access keys for a Batch account", + "operation": "List Batch Account Keys", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/regeneratekeys/action", + "display": { + "description": "Regenerates access keys for a Batch account", + "operation": "Regenerate Batch Account Keys", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/locations/quotas/read", + "display": { + "description": "Gets Batch quotas of the specified subscription at the specified Azure region", + "operation": "Get Batch Quotas", + "provider": "Microsoft Batch", + "resource": "Batch Quotas" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/locations/checkNameAvailability/action", + "display": { + "description": "Checks that the account name is valid and not in use.", + "operation": "Check Name Availability", + "provider": "Microsoft Batch", + "resource": "Name Availability" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/operationResults/read", + "display": { + "description": "Gets the results of a long running Batch account operation", + "operation": "Get Batch account operation results", + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/accountOperationResults/read", + "display": { + "description": "Gets the results of a long running Batch account operation", + "operation": "Get Batch account operation results", + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/register/action", + "display": { + "description": "Registers the subscription for the Batch Resource Provider and enables the creation of Batch accounts", + "operation": "Register the Batch Resource Provider", + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/unregister/action", + "display": { + "description": "Unregisters the subscription for the Batch Resource Provider preventing the creation of Batch accounts", + "operation": "Unregister the Batch Resource Provider", + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/syncAutoStorageKeys/action", + "display": { + "description": "Synchronizes access keys for the auto storage account configured for a Batch account", + "operation": "Synchronize Auto Storage Account Keys", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/read", + "display": { + "description": "Lists applications or gets the properties of an application", + "operation": "List or Get Applications", + "provider": "Microsoft Batch", + "resource": "Applications" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/write", + "display": { + "description": "Creates a new application or updates an existing application", + "operation": "Create or Update Application", + "provider": "Microsoft Batch", + "resource": "Applications" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/delete", + "display": { + "description": "Deletes an application", + "operation": "Delete Application", + "provider": "Microsoft Batch", + "resource": "Applications" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/read", + "display": { + "description": "Gets the properties of an application package", + "operation": "Get Application Package", + "provider": "Microsoft Batch", + "resource": "Application Packages" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/write", + "display": { + "description": "Creates a new application package or updates an existing application package", + "operation": "Create or Update Application Package", + "provider": "Microsoft Batch", + "resource": "Application Packages" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/delete", + "display": { + "description": "Deletes an application package", + "operation": "Delete Application Package", + "provider": "Microsoft Batch", + "resource": "Application Packages" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/activate/action", + "display": { + "description": "Activates an application package", + "operation": "Activate Application Package", + "provider": "Microsoft Batch", + "resource": "Application Packages" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/read", + "display": { + "description": "Lists pools on a Batch account or gets the properties of a pool", + "operation": "List or Get Pools", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/write", + "display": { + "description": "Creates a new pool on a Batch account or updates an existing pool", + "operation": "Create or Update Pool", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/delete", + "display": { + "description": "Deletes a pool from a Batch account", + "operation": "Delete Pool", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/stopResize/action", + "display": { + "description": "Stops an ongoing resize operation on a Batch account pool", + "operation": "Stop Pool Resize", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/disableAutoscale/action", + "display": { + "description": "Disables automatic scaling for a Batch account pool", + "operation": "Disable Pool AutoScale", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/poolOperationResults/read", + "display": { + "description": "Gets the results of a long running pool operation on a Batch account", + "operation": "Get Pool Operation Results", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/virtualMachineSkus/read", + "display": { + "description": "Lists available Batch supported Virtual Machine VM sizes at the given location", + "operation": "List Supported Batch Virtual Machine VM", + "provider": "Microsoft Batch", + "resource": "Batch Supported Skus" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/cloudServiceSkus/read", + "display": { + "description": "Lists available Batch supported Cloud Service VM sizes at the given location", + "operation": "List Supported Batch Cloud Service VM", + "provider": "Microsoft Batch", + "resource": "Batch Supported Skus" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateLinkResources/read", + "display": { + "description": "Gets the properties of a Private link resource or Lists Private link resources on a Batch account", + "operation": "Get or List Private link resources", + "provider": "Microsoft Batch", + "resource": "PrivateLinkResources" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnections/write", + "display": { + "description": "Update an existing Private endpoint connection on a Batch account", + "operation": "Update Private endpoint connection", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnections/read", + "display": { + "description": "Gets Private endpoint connection or Lists Private endpoint connections on a Batch account", + "operation": "Get or List Private endpoint connection", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionResults/read", + "display": { + "description": "Gets the results of a long running Batch account private endpoint connection operation", + "operation": "Get Batch account private endpoint connection operation results", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/validate/action", + "display": { + "description": "Validates a Private endpoint connection proxy on a Batch account", + "operation": "Validates a Private endpoint connection proxy", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/write", + "display": { + "description": "Create a new Private endpoint connection proxy on a Batch account", + "operation": "Create or Update Private endpoint connection proxy", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/read", + "display": { + "description": "Gets Private endpoint connection proxy on a Batch account", + "operation": "Get Private endpoint connection proxy", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/delete", + "display": { + "description": "Delete a Private endpoint connection proxy on a Batch account", + "operation": "Delete Private endpoint connection proxy", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxyResults/read", + "display": { + "description": "Gets the results of a long running Batch account private endpoint connection proxy operation", + "operation": "Get Batch account private endpoint connection proxy operation results", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/outboundNetworkDependenciesEndpoints/read", + "display": { + "description": "Lists the outbound network dependency endpoints for a Batch account", + "operation": "List Outbound Network Dependency Endpoints", + "provider": "Microsoft Batch", + "resource": "Outbound Network Dependencies Endpoints" + }, + "isDataAction": false, + "origin": "user,system" + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "OperationsList" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_AcceleratedNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_AcceleratedNetworking.json new file mode 100644 index 000000000000..8271f423d17f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_AcceleratedNetworking.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "networkConfiguration": { + "enableAcceleratedNetworking": true, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "vmSize": "STANDARD_D1_V2" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z", + "creationTime": "2023-04-27T02:59:41.8592226Z", + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-04-27T02:59:41.8592226Z", + "networkConfiguration": { + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": true, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-04-27T02:59:41.8592226Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D1_V2" + } + }, + "headers": { + "ETag": "W/\"0x8DB46CB72A227E2\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - accelerated networking" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_ConfidentialDiskEncryptionSet_ForUserSubscriptionAccounts.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_ConfidentialDiskEncryptionSet_ForUserSubscriptionAccounts.json new file mode 100644 index 000000000000..a895b14deca6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_ConfidentialDiskEncryptionSet_ForUserSubscriptionAccounts.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "vmSize": "Standard_DC2as_v5", + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-datacenter-core-g2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "securityProfile": { + "securityType": "confidentialVM", + "encryptionAtHost": false, + "uefiSettings": { + "vTpmEnabled": true, + "secureBootEnabled": true + } + }, + "osDisk": { + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + }, + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/ConfidentialDiskEncryptionSetId" + } + } + } + }, + "dataDisks": [ + { + "lun": 0, + "diskSizeGB": 1024, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + } + ] + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "resizeTimeout": "PT15M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2025-06-30T07:30:49.7522647Z", + "creationTime": "2025-06-30T07:30:49.7522634Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2025-06-30T07:30:49.7522634Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2025-06-30T07:30:49.7522647Z", + "vmSize": "STANDARD_DC2as_v5", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Pack", + "jobDefaultOrder": "None" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-datacenter-core-g2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "dataDisks": [ + { + "lun": 0, + "caching": "None", + "diskSizeGB": 1024, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + } + ], + "osDisk": { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/ConfidentialDiskEncryptionSetId" + } + }, + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + }, + "securityProfile": { + "securityType": "confidentialVM", + "encryptionAtHost": false, + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2025-06-30T07:30:49.7522324Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - confidential disk encryption set for user subscription accounts" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_CustomerManagedKey_ForBatchManagedAccounts.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_CustomerManagedKey_ForBatchManagedAccounts.json new file mode 100644 index 000000000000..17a4580a7dbb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_CustomerManagedKey_ForBatchManagedAccounts.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "vmSize": "Standard_D4ds_v5", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk" + ], + "customerManagedKey": { + "keyUrl": "http://sample.vault.azure.net//keys/cmk/bb60031a6d4545d3a60d3f94588538c9", + "identityReference": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + } + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "resizeTimeout": "PT15M" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "principalId", + "clientId": "clientId" + } + } + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2025-06-30T07:16:33.4309281Z", + "creationTime": "2025-06-30T07:16:33.4309266Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2025-06-30T07:16:33.4309266Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2025-06-30T07:16:33.4309281Z", + "vmSize": "Standard_D4ds_v5", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread", + "jobDefaultOrder": "None" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2022-Datacenter", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk" + ], + "customerManagedKey": { + "keyUrl": "http://sample.vault.azure.net//keys/cmk/bb60031a6d4545d3a60d3f94588538c9", + "identityReference": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + } + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2025-06-30T07:16:33.4309126Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - customer managed key for Batch managed accounts" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_DiskEncryptionSet_ForUserSubscriptionAccounts.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_DiskEncryptionSet_ForUserSubscriptionAccounts.json new file mode 100644 index 000000000000..c3189ffa2e7f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_DiskEncryptionSet_ForUserSubscriptionAccounts.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "vmSize": "Standard_D4ds_v5", + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "securityProfile": { + "encryptionAtHost": false + }, + "osDisk": { + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "resizeTimeout": "PT15M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2025-06-30T07:45:46.1580726Z", + "creationTime": "2025-06-30T07:35:44.5579791Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2025-06-30T07:35:44.5579791Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2025-06-30T07:45:46.1580727Z", + "vmSize": "Standard_D4ds_v5", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Pack", + "jobDefaultOrder": "None" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2022-Datacenter", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + }, + "securityProfile": { + "encryptionAtHost": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2025-06-30T07:45:46.1580724Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - disk encryption set for user subscription accounts" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_DualStackNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_DualStackNetworking.json new file mode 100644 index 000000000000..291fe695cad6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_DualStackNetworking.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "resourceGroupName": "default-azurebatch", + "accountName": "exampleacc", + "poolName": "dualstackpool", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "vmSize": "Standard_D4ds_v5", + "networkConfiguration": { + "publicIPAddressConfiguration": { + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "endpointConfiguration": { + "inboundNatPools": [ + { + "backendPort": 22, + "frontendPortRangeStart": 40000, + "frontendPortRangeEnd": 40500, + "name": "sshpool", + "protocol": "TCP", + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 1000, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "ubuntu-24_04-lts", + "sku": "server" + }, + "nodeAgentSkuId": "batch.node.ubuntu 24.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/dualstackpool", + "name": "dualstackpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DDC34D4A01A419\"", + "properties": { + "lastModified": "2025-07-15T03:11:27.7998105Z", + "creationTime": "2025-07-15T03:11:27.7997967Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2025-07-15T03:11:27.7997967Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2025-07-15T03:11:27.7998136Z", + "vmSize": "Standard_D4ds_v5", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread", + "jobDefaultOrder": "None" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "ubuntu-24_04-lts", + "sku": "server", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 24.04" + } + }, + "networkConfiguration": { + "publicIPAddressConfiguration": { + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "sshpool", + "protocol": "TCP", + "backendPort": 22, + "frontendPortRangeStart": 40000, + "frontendPortRangeEnd": 40500, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "*", + "priority": 1000, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + }, + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": false + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2025-07-15T03:11:27.7994621Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - dual stack networking" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_MinimalVirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_MinimalVirtualMachineConfiguration.json new file mode 100644 index 000000000000..64678f4f3b8e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_MinimalVirtualMachineConfiguration.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Minimal VirtualMachineConfiguration" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_NoPublicIPAddresses.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_NoPublicIPAddresses.json new file mode 100644 index 000000000000..b56ea5c1c723 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_NoPublicIPAddresses.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "networkConfiguration": { + "publicIPAddressConfiguration": { + "provision": "NoPublicIPAddresses" + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "networkConfiguration": { + "publicIPAddressConfiguration": { + "provision": "NoPublicIPAddresses" + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - No public IP" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_PublicIPs.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_PublicIPs.json new file mode 100644 index 000000000000..f4fc6415ccfe --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_PublicIPs.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "networkConfiguration": { + "publicIPAddressConfiguration": { + "ipAddressIds": [ + "/subscriptions/12345678-1234-1234-1234-1234567890121/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135" + ], + "provision": "UserManaged" + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "networkConfiguration": { + "publicIPAddressConfiguration": { + "ipAddressIds": [ + "/subscriptions/12345678-1234-1234-1234-1234567890121/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135" + ], + "provision": "UserManaged" + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Public IPs" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_SecurityProfile.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_SecurityProfile.json new file mode 100644 index 000000000000..0f62b22ec899 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_SecurityProfile.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04", + "securityProfile": { + "encryptionAtHost": true, + "securityType": "trustedLaunch", + "uefiSettings": { + "secureBootEnabled": null, + "vTpmEnabled": false + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "vmSize": "Standard_d4s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04", + "securityProfile": { + "encryptionAtHost": true, + "securityType": "trustedLaunch", + "uefiSettings": { + "vTpmEnabled": false + } + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-06-14T07:03:58.3231917Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - SecurityProfile" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_SharedImageGallery.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_SharedImageGallery.json new file mode 100644 index 000000000000..640eb9ef5f70 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_SharedImageGallery.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Custom Image" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_Tags.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_Tags.json new file mode 100644 index 000000000000..b67ccf1da011 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_Tags.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-jammy", + "publisher": "Canonical", + "sku": "22_04-lts", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 22.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "vmSize": "Standard_d4s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-jammy", + "publisher": "Canonical", + "sku": "22_04-lts", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 22.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-09-27T07:33:13.0625789Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Tags" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_UpgradePolicy.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_UpgradePolicy.json new file mode 100644 index 000000000000..6539facd9ce8 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_UpgradePolicy.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "disableAutomaticRollback": true, + "enableAutomaticOSUpgrade": true, + "osRollingUpgradeDeferral": true, + "useRollingUpgradePolicy": true + }, + "mode": "automatic", + "rollingUpgradePolicy": { + "enableCrossZoneUpgrade": true, + "maxBatchInstancePercent": 20, + "maxUnhealthyInstancePercent": 20, + "maxUnhealthyUpgradedInstancePercent": 20, + "pauseTimeBetweenBatches": "PT0S", + "prioritizeUnhealthyInstances": false, + "rollbackFailedInstancesOnPolicyBreach": false + } + }, + "vmSize": "Standard_d4s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-05-11T06:16:44.2372184Z", + "creationTime": "2023-05-11T06:16:44.2372184Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-05-11T06:16:44.2372184Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T06:16:44.2372184Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T06:16:44.2372184Z", + "targetDedicatedNodes": 2 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "disableAutomaticRollback": true, + "enableAutomaticOSUpgrade": true, + "osRollingUpgradeDeferral": true, + "useRollingUpgradePolicy": true + }, + "mode": "automatic", + "rollingUpgradePolicy": { + "enableCrossZoneUpgrade": true, + "maxBatchInstancePercent": 20, + "maxUnhealthyInstancePercent": 20, + "maxUnhealthyUpgradedInstancePercent": 20, + "pauseTimeBetweenBatches": "PT0S", + "prioritizeUnhealthyInstances": false, + "rollbackFailedInstancesOnPolicyBreach": false + } + }, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - UpgradePolicy" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_UserAssignedIdentities.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_UserAssignedIdentities.json new file mode 100644 index 000000000000..900d28755b22 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_UserAssignedIdentities.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}, + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {} + } + }, + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2020-10-01T10:22:55.9407275Z", + "creationTime": "2020-10-01T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2020-10-01T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2020-10-01T10:22:55.9407275Z", + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - UserAssignedIdentities" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..a3ee0a470b99 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "dataDisks": [ + { + "caching": "ReadWrite", + "diskSizeGB": 30, + "lun": 0, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + } + }, + { + "caching": "None", + "diskSizeGB": 200, + "lun": 1, + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + } + ], + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk", + "TemporaryDisk" + ] + }, + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "licenseType": "Windows_Server", + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "osDisk": { + "ephemeralOSDiskSettings": { + "placement": "CacheDisk" + } + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "backendPort": 12001, + "frontendPortRangeEnd": 15100, + "frontendPortRangeStart": 15000, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 150, + "sourceAddressPrefix": "192.100.12.45", + "sourcePortRanges": [ + "1", + "2" + ] + }, + { + "access": "Deny", + "priority": 3500, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ], + "protocol": "TCP" + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "dataDisks": [ + { + "caching": "ReadWrite", + "diskSizeGB": 30, + "lun": 0, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + } + }, + { + "caching": "None", + "diskSizeGB": 200, + "lun": 1, + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + ], + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk", + "TemporaryDisk" + ] + }, + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "licenseType": "Windows_Server", + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "backendPort": 12001, + "frontendPortRangeEnd": 15100, + "frontendPortRangeStart": 15000, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 150, + "sourceAddressPrefix": "192.100.12.45", + "sourcePortRanges": [ + "1", + "2" + ] + }, + { + "access": "Deny", + "priority": 3500, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ], + "protocol": "TCP" + } + ] + } + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Full VirtualMachineConfiguration" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_Extensions.json new file mode 100644 index 000000000000..34853430a109 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_Extensions.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-focal", + "publisher": "Canonical", + "sku": "20_04-lts" + }, + "nodeAgentSkuId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "publisher": "Microsoft.Azure.KeyVault", + "settings": { + "authenticationSettingsKey": "authenticationSettingsValue", + "secretsManagementSettingsKey": "secretsManagementSettingsValue" + }, + "typeHandlerVersion": "2.0" + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-focal", + "publisher": "Canonical", + "sku": "20_04-lts" + }, + "nodeAgentSkuId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "publisher": "Microsoft.Azure.KeyVault", + "settings": { + "authenticationSettingsKey": "authenticationSettingsValue", + "secretsManagementSettingsKey": "secretsManagementSettingsValue" + }, + "typeHandlerVersion": "2.0" + } + ] + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - VirtualMachineConfiguration Extensions" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json new file mode 100644 index 000000000000..420b41211873 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "windowsserver", + "publisher": "microsoftwindowsserver", + "sku": "2022-datacenter-smalldisk" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "ReadWrite", + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "writeAcceleratorEnabled": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "vmSize": "Standard_d2s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "creationTime": "2023-08-24T02:12:27.7527697Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "windowsserver", + "publisher": "microsoftwindowsserver", + "sku": "2022-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "ReadWrite", + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "writeAcceleratorEnabled": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-08-24T02:12:27.7527697Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-08-24T02:12:27.7527697Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D2_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51F14DC1A8AD\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - VirtualMachineConfiguration OSDisk" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json new file mode 100644 index 000000000000..86489d9c1e60 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "serviceArtifactReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + }, + "mode": "automatic" + }, + "vmSize": "Standard_d4s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "mypool41", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "creationTime": "2023-05-11T07:44:44.8580493Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "serviceArtifactReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-05-11T07:44:44.8580493Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T07:44:44.8580493Z", + "targetDedicatedNodes": 2 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + }, + "mode": "automatic" + }, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51F14DC1A8AD\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - VirtualMachineConfiguration ServiceArtifactReference" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolDelete.json new file mode 100644 index 000000000000..9b8e34bf301e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/poolOperationResults/delete-testpool-8D4EDFF164A11C9?api-version=2025-06-01", + "Retry-After": "15" + } + }, + "204": {} + }, + "operationId": "Pool_Delete", + "title": "DeletePool" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolDisableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolDisableAutoScale.json new file mode 100644 index 000000000000..8f55ef20c643 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolDisableAutoScale.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_DisableAutoScale", + "title": "Disable AutoScale" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet.json new file mode 100644 index 000000000000..137bd87d7bbc --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "applicationPackages": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Enabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "backendPort": 12001, + "frontendPortRangeEnd": 15100, + "frontendPortRangeStart": 15000, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 150, + "sourceAddressPrefix": "192.100.12.45", + "sourcePortRanges": [ + "123", + "22" + ] + }, + { + "access": "Deny", + "priority": 3500, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ], + "protocol": "TCP" + } + ] + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + } + }, + "startTask": { + "commandLine": "cmd /c SET", + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "maxTaskRetryCount": 6, + "resourceFiles": [ + { + "fileMode": "777", + "filePath": "c:\\temp\\gohere", + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file" + } + ], + "userIdentity": { + "autoUser": { + "elevationLevel": "Admin", + "scope": "Pool" + } + }, + "waitForSuccess": true + }, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "taskSlotsPerNode": 13, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "gid": 4567, + "uid": 1234 + } + } + ], + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_AcceleratedNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_AcceleratedNetworking.json new file mode 100644 index 000000000000..3ff4a8b5d409 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_AcceleratedNetworking.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-04-28T02:33:40.82831Z", + "creationTime": "2023-04-28T02:32:32.8696419Z", + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-04-28T02:32:32.8696419Z", + "networkConfiguration": { + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-04-28T02:32:32.8696419Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-04-28T02:32:32.8696419Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D1_V2" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - AcceleratedNetworking" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_SecurityProfile.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_SecurityProfile.json new file mode 100644 index 000000000000..4a4bfcfd5af5 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_SecurityProfile.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-06-14T07:04:57.3413444Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04", + "securityProfile": { + "encryptionAtHost": true, + "securityType": "trustedLaunch", + "uefiSettings": { + "vTpmEnabled": false + } + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-06-14T07:03:58.3231917Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - SecurityProfile" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_UpgradePolicy.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_UpgradePolicy.json new file mode 100644 index 000000000000..0fd769584059 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_UpgradePolicy.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-05-11T06:10:31.4670326Z", + "creationTime": "2023-05-11T06:09:38.3178089Z", + "currentDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-05-11T06:09:38.3178089Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T06:09:38.3178089Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T06:09:38.3178089Z", + "targetDedicatedNodes": 2 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "disableAutomaticRollback": true, + "enableAutomaticOSUpgrade": true, + "osRollingUpgradeDeferral": true, + "useRollingUpgradePolicy": true + }, + "mode": "automatic", + "rollingUpgradePolicy": { + "enableCrossZoneUpgrade": true, + "maxBatchInstancePercent": 20, + "maxUnhealthyInstancePercent": 20, + "maxUnhealthyUpgradedInstancePercent": 20, + "pauseTimeBetweenBatches": "PT0S", + "prioritizeUnhealthyInstances": false, + "rollbackFailedInstancesOnPolicyBreach": false + } + }, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - UpgradePolicy" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_Extensions.json new file mode 100644 index 000000000000..8c103788595f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_Extensions.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-focal", + "publisher": "Canonical", + "sku": "20_04-lts" + }, + "nodeAgentSkuId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "publisher": "Microsoft.Azure.KeyVault", + "settings": { + "authenticationSettingsKey": "authenticationSettingsValue", + "secretsManagementSettingsKey": "secretsManagementSettingsValue" + }, + "typeHandlerVersion": "2.0" + } + ] + } + }, + "interNodeCommunication": "Enabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "taskSlotsPerNode": 13, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - VirtualMachineConfiguration Extensions" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json new file mode 100644 index 000000000000..8d359a25fe6b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-08-24T02:13:22.4881351Z", + "creationTime": "2023-08-24T02:12:27.7527697Z", + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "windowsserver", + "publisher": "microsoftwindowsserver", + "sku": "2022-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "ReadWrite", + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "writeAcceleratorEnabled": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-08-24T02:12:27.7527697Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-08-24T02:12:27.7527697Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D2_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - VirtualMachineConfiguration OSDisk" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json new file mode 100644 index 000000000000..290e27612847 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-05-11T07:45:42.0881659Z", + "creationTime": "2023-05-11T07:44:44.8580493Z", + "currentDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "serviceArtifactReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-05-11T07:44:44.8580493Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T07:44:44.8580493Z", + "targetDedicatedNodes": 2 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + }, + "mode": "automatic" + }, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - VirtualMachineConfiguration ServiceArtifactReference" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolList.json new file mode 100644 index 000000000000..bdd02aed26bb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolList.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "applicationPackages": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Enabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "backendPort": 12001, + "frontendPortRangeEnd": 15100, + "frontendPortRangeStart": 15000, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 150, + "sourceAddressPrefix": "192.100.12.45", + "sourcePortRanges": [ + "*" + ] + }, + { + "access": "Deny", + "priority": 3500, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ], + "protocol": "TCP" + } + ] + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "errors": [ + { + "code": "AllocationTimedout", + "message": "Desired number of dedicated nodes could not be allocated as the resize timeout was reached" + } + ], + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + } + }, + "startTask": { + "commandLine": "cmd /c SET", + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "maxTaskRetryCount": 6, + "resourceFiles": [ + { + "fileMode": "777", + "filePath": "c:\\temp\\gohere", + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file" + } + ], + "userIdentity": { + "autoUser": { + "elevationLevel": "Admin", + "scope": "Pool" + } + }, + "waitForSuccess": true + }, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "taskSlotsPerNode": 13, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "gid": 4567, + "uid": 1234 + } + } + ], + "vmSize": "STANDARD_D4" + } + } + ] + } + } + }, + "operationId": "Pool_ListByBatchAccount", + "title": "ListPool" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolListWithFilter.json new file mode 100644 index 000000000000..a3377bcae2f7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "$filter": "startswith(name, 'po') or (properties/allocationState eq 'Steady' and properties/provisioningStateTransitionTime lt datetime'2017-02-02')", + "$select": "properties/allocationState,properties/provisioningStateTransitionTime,properties/currentDedicatedNodes,properties/currentLowPriorityNodes", + "accountName": "sampleacct", + "api-version": "2025-06-01", + "maxResults": "50", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 2, + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z" + } + }, + { + "name": "pooltest", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/pooltest", + "properties": { + "allocationState": "Resizing", + "currentDedicatedNodes": 4, + "currentLowPriorityNodes": 0, + "provisioningStateTransitionTime": "2017-08-26T10:22:55.9407275Z" + } + } + ] + } + } + }, + "operationId": "Pool_ListByBatchAccount", + "title": "ListPoolWithFilter" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolStopResize.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolStopResize.json new file mode 100644 index 000000000000..9878b66d36f1 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolStopResize.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT10M", + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_StopResize", + "title": "StopPoolResize" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_EnableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_EnableAutoScale.json new file mode 100644 index 000000000000..0d6fe825015b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_EnableAutoScale.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=34" + } + } + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-29T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34 + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT15M", + "formula": "$TargetDedicated=34" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Update", + "title": "UpdatePool - Enable Autoscale" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_OtherProperties.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_OtherProperties.json new file mode 100644 index 000000000000..7299561d10ba --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_OtherProperties.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "applicationPackages": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ] + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "applicationPackages": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-29T10:22:55.9407275Z", + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ], + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8 + }, + "scaleSettings": { + "fixedScale": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Update", + "title": "UpdatePool - Other Properties" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_RemoveStartTask.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_RemoveStartTask.json new file mode 100644 index 000000000000..ca679399f76e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_RemoveStartTask.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "startTask": {} + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-29T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34 + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT15M", + "formula": "$TargetDedicated=34" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Update", + "title": "UpdatePool - Remove Start Task" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_ResizePool.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_ResizePool.json new file mode 100644 index 000000000000..9d5221906d04 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PoolUpdate_ResizePool.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "scaleSettings": { + "fixedScale": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0 + } + } + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-29T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8 + }, + "scaleSettings": { + "fixedScale": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Update", + "title": "UpdatePool - Resize Pool" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateBatchAccountCreate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateBatchAccountCreate.json new file mode 100644 index 000000000000..7620588d3170 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateBatchAccountCreate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "keyVaultReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "publicNetworkAccess": "Disabled" + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "keyVaultReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "UserSubscription", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "PrivateBatchAccountCreate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateBatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateBatchAccountGet.json new file mode 100644 index 000000000000..0161169b1035 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateBatchAccountGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "privateEndpointConnections": [ + { + "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + } + } + } + ], + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled" + } + } + } + }, + "operationId": "BatchAccount_Get", + "title": "PrivateBatchAccountGet" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..b64b73f6fca7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0/accountOperationResults/sampleacct-30a022cb-a64f-4fd5-9289-8b38b342e9de?api-version=2025-06-01" + } + }, + "204": {} + }, + "operationId": "PrivateEndpointConnection_Delete", + "title": "PrivateEndpointConnectionDelete" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..cd44d77073fc --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "properties": { + "groupIds": [ + "batchAccount" + ], + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "PrivateEndpointConnection_Get", + "title": "GetPrivateEndpointConnection" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..a3238485d8c4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + } + } + }, + "privateEndpointConnectionName": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "properties": { + "groupIds": [ + "batchAccount" + ], + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnectionProxyResults/Updating$testprivateEndpointConnection5.24d6b4b5$e65c-4330-bbe9-3a290d62f8e0-8D4EDFF164A11C9?api-version=2025-06-01", + "Retry-After": "15" + } + } + }, + "operationId": "PrivateEndpointConnection_Update", + "title": "UpdatePrivateEndpointConnection" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionsList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..812d776f1307 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateEndpointConnectionsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "privateEndpointConnectionName": "testprivateEndpointConnection", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testprivateEndpointConnection", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection", + "properties": { + "groupIds": [ + "batchAccount" + ], + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnection_ListByBatchAccount", + "title": "ListPrivateEndpointConnections" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateLinkResourceGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..9f8f26231699 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateLinkResourceGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "privateLinkResourceName": "batchAccount", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + } + }, + "operationId": "PrivateLinkResource_Get", + "title": "GetPrivateLinkResource" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateLinkResourcesList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..2c0ed091f035 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/examples/2025-06-01/PrivateLinkResourcesList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "batchAccount", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResource_ListByBatchAccount", + "title": "ListPrivateLinkResource" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/main.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/main.tsp index c2094edf3cc1..4b1973bb603f 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/main.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/main.tsp @@ -47,6 +47,11 @@ enum Versions { * The 2024-07-01 API version. */ v2024_07_01: "2024-07-01", + + /** + * The 2025-06-01 API version. + */ + v2025_06_01: "2025-06-01", } interface Operations diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/models.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/models.tsp index eaf0c5a97e82..bd6e20981372 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/models.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/models.tsp @@ -1,5 +1,6 @@ import "@typespec/rest"; import "@typespec/http"; +import "@typespec/openapi"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; @@ -7,6 +8,8 @@ using TypeSpec.Rest; using TypeSpec.Http; using Azure.ResourceManager; using Azure.ResourceManager.Foundations; +using TypeSpec.OpenAPI; +using Versioning; namespace Microsoft.Batch; @@ -28,14 +31,26 @@ union ContainerType { } /** - * Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs. + * Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs. */ union SecurityEncryptionTypes { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** + * EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. + */ NonPersistedTPM: "NonPersistedTPM", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** + * EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob. + */ VMGuestStateOnly: "VMGuestStateOnly", + + /** + * EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks. + */ + @added(Versions.v2025_06_01) + DiskWithVMGuestState: "DiskWithVMGuestState", } /** @@ -107,9 +122,15 @@ union IssueType { */ union Severity { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** + * Warning severity + */ Warning: "Warning", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** + * Error severity + */ Error: "Error", } @@ -118,20 +139,32 @@ union Severity { */ union CreatedByType { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** + * The resource was created by a user. + */ User: "User", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** + * The resource was created by an application. + */ Application: "Application", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** + * The resource was created by a managed identity. + */ ManagedIdentity: "ManagedIdentity", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** + * The resource was created by a key. + */ Key: "Key", } /** * The authentication mode which the Batch service will use to manage the auto-storage account. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum AutoStorageAuthenticationMode { /** * The Batch service will authenticate requests to auto-storage using storage account keys. @@ -147,7 +180,7 @@ enum AutoStorageAuthenticationMode { /** * The allocation mode for creating pools in the Batch account. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum PoolAllocationMode { /** * Pools will be allocated in subscriptions owned by the Batch service. @@ -163,7 +196,7 @@ enum PoolAllocationMode { /** * The network access type for operating on the resources in the Batch account. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum PublicNetworkAccessType { /** * Enables connectivity to Azure Batch through public DNS. @@ -184,7 +217,7 @@ enum PublicNetworkAccessType { /** * Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum EndpointAccessDefaultAction { /** * Allow client access. @@ -200,7 +233,7 @@ enum EndpointAccessDefaultAction { /** * Type of the key source. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum KeySource { /** * Batch creates and manages the encryption keys used to protect the account data. @@ -216,7 +249,7 @@ enum KeySource { /** * The authentication mode for the Batch account. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum AuthenticationMode { /** * The authentication mode using shared keys. @@ -237,7 +270,7 @@ enum AuthenticationMode { /** * The type of identity used for the Batch account. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum ResourceIdentityType { /** * Batch account has a system assigned identity with it. @@ -258,8 +291,8 @@ enum ResourceIdentityType { /** * The provisioned state of the resource */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Legacy Design" enum ProvisioningState { /** * The account is in an invalid state. @@ -295,8 +328,8 @@ enum ProvisioningState { /** * The provisioning state of the private endpoint connection. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Legacy Design" enum PrivateEndpointConnectionProvisioningState { /** * The connection is creating. @@ -332,7 +365,7 @@ enum PrivateEndpointConnectionProvisioningState { /** * The status of the Batch private endpoint connection */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum PrivateLinkServiceConnectionStatus { /** * The private endpoint connection is approved and can be used to access Batch account @@ -358,7 +391,7 @@ enum PrivateLinkServiceConnectionStatus { /** * The type of account key to regenerate. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum AccountKeyType { /** * The primary account key. @@ -374,7 +407,7 @@ enum AccountKeyType { /** * The current state of the application package. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum PackageState { /** * The application package has been created but has not yet been activated. @@ -390,7 +423,7 @@ enum PackageState { /** * Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum NameAvailabilityReason { /** * The requested name is invalid. @@ -403,9 +436,12 @@ enum NameAvailabilityReason { AlreadyExists, } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** + * The current provisioning state of the certificate. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Legacy Design" +@removed(Versions.v2025_06_01) enum CertificateProvisioningState { /** * The certificate is available for use in pools. @@ -426,7 +462,8 @@ enum CertificateProvisioningState { /** * The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" +@removed(Versions.v2025_06_01) enum CertificateFormat { /** * The certificate is a PFX (PKCS#12) formatted certificate or certificate chain. @@ -442,8 +479,8 @@ enum CertificateFormat { /** * The current state of the pool. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Legacy Design" enum PoolProvisioningState { /** * The pool is available to run tasks subject to the availability of compute nodes. @@ -459,7 +496,7 @@ enum PoolProvisioningState { /** * Whether the pool is resizing. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum AllocationState { /** * The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes. @@ -477,10 +514,28 @@ enum AllocationState { Stopping, } +/** + * The IP families used to specify IP versions available to the pool. + */ +@added(Versions.v2025_06_01) +union IPFamily { + string, + + /** + * IPv4 is available to the pool. + */ + IPv4: "IPv4", + + /** + * IPv6 is available to the pool. + */ + IPv6: "IPv6", +} + /** * The type of caching to enable for the disk. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum CachingType { /** * The caching mode for the disk is not enabled. @@ -501,7 +556,7 @@ enum CachingType { /** * The storage account type for use in creating data disks or OS disk. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum StorageAccountType { /** * The data disk / OS disk should use standard locally redundant storage. @@ -522,7 +577,7 @@ enum StorageAccountType { /** * If omitted, no disks on the compute nodes in the pool will be encrypted. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" @summary("The disks to encrypt on each compute node.") enum DiskEncryptionTarget { /** @@ -539,7 +594,7 @@ enum DiskEncryptionTarget { /** * The default value is regional. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum NodePlacementPolicyType { /** * All nodes in the pool will be allocated in the same region. @@ -555,7 +610,7 @@ enum NodePlacementPolicyType { /** * Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum SecurityTypes { /** * Trusted launch protects against advanced and persistent attack techniques. @@ -571,7 +626,7 @@ enum SecurityTypes { /** * Determines what to do with a node and its running task(s) after it has been selected for deallocation. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum ComputeNodeDeallocationOption { /** * Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated. @@ -589,7 +644,7 @@ enum ComputeNodeDeallocationOption { TaskCompletion, /** - * Deprecated, we encourage you to upload task data to Azure Storage in your task and use `TaskCompletion` instead. Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. + * Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired. */ RetainedData, } @@ -597,7 +652,7 @@ enum ComputeNodeDeallocationOption { /** * This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum InterNodeCommunicationState { /** * Enable network communication between virtual machines. @@ -613,7 +668,7 @@ enum InterNodeCommunicationState { /** * The scope of dynamic vnet assignment. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum DynamicVNetAssignmentScope { /** * No dynamic VNet assignment is enabled. @@ -629,7 +684,7 @@ enum DynamicVNetAssignmentScope { /** * The protocol of the endpoint. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum InboundEndpointProtocol { /** * Use TCP for the endpoint. @@ -645,7 +700,7 @@ enum InboundEndpointProtocol { /** * The action that should be taken for a specified IP address, subnet range or tag. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum NetworkSecurityGroupRuleAccess { /** * Allow access. @@ -658,10 +713,28 @@ enum NetworkSecurityGroupRuleAccess { Deny, } +/** + * The order for scheduling tasks from different jobs with the same priority. + */ +@added(Versions.v2025_06_01) +union JobDefaultOrder { + string, + + /** + * Tasks should be scheduled uniformly from all equal-priority jobs for the pool. + */ + None: "None", + + /** + * If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first. + */ + CreationTime: "CreationTime", +} + /** * The provisioning type for Public IP Addresses for the Batch Pool. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum IPAddressProvisioningType { /** * A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool. @@ -682,7 +755,7 @@ enum IPAddressProvisioningType { /** * How tasks should be distributed across compute nodes. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum ComputeNodeFillType { /** * Tasks should be assigned evenly across all nodes in the pool. @@ -698,7 +771,7 @@ enum ComputeNodeFillType { /** * The elevation level of the user. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum ElevationLevel { /** * The user is a standard user without elevated access. @@ -714,7 +787,7 @@ enum ElevationLevel { /** * Specifies login mode for the user. The default value is Interactive. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum LoginMode { /** * The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes. @@ -728,9 +801,27 @@ enum LoginMode { } /** - * The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. + * Specifies the access control policy execution mode. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@added(Versions.v2025_06_01) +union HostEndpointSettingsModeTypes { + string, + + /** + * In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. + */ + Audit: "Audit", + + /** + * Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'. + */ + Enforce: "Enforce", +} + +/** + * The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum AutoUserScope { /** * Specifies that the service should create a new user for the task. @@ -746,7 +837,7 @@ enum AutoUserScope { /** * A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum ContainerWorkingDirectory { /** * Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch. @@ -762,7 +853,8 @@ enum ContainerWorkingDirectory { /** * The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. 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. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" +@removed(Versions.v2025_06_01) enum CertificateStoreLocation { /** * Certificates should be installed to the CurrentUser certificate store. @@ -775,8 +867,11 @@ enum CertificateStoreLocation { LocalMachine, } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** + * The visibility of the certificate. + */ +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" +@removed(Versions.v2025_06_01) enum CertificateVisibility { /** * The certificate should be visible to the user account under which the start task is run. Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as well. @@ -797,7 +892,8 @@ enum CertificateVisibility { /** * Determines how a pool communicates with the Batch service. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" +@removed(Versions.v2025_06_01) enum NodeCommunicationMode { /** * The node communication mode is automatically set by the Batch service. @@ -818,7 +914,7 @@ enum NodeCommunicationMode { /** * Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum UpgradeMode { /** * All virtual machines in the scale set are automatically updated at the same time. @@ -839,7 +935,7 @@ enum UpgradeMode { /** * The type of identity used for the Batch Pool. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum PoolIdentityType { /** * Batch pool has user assigned identities with it. @@ -864,13 +960,13 @@ model BatchAccountCreateParameters { /** * The user-specified tags associated with the account. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; /** * The properties of the Batch account. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy desgin" properties?: BatchAccountCreateProperties; /** @@ -920,7 +1016,7 @@ model BatchAccountCreateProperties { /** * List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" allowedAuthenticationModes?: AuthenticationMode[] | null; } @@ -1013,7 +1109,7 @@ model EndpointAccessProfile { /** * The action when client IP address is matched. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum IPRuleAction { /** * Allow access for the matched client IP address. @@ -1089,7 +1185,7 @@ model BatchAccountIdentity { /** * The list of user identities associated with the Batch account. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" userAssignedIdentities?: Record; } @@ -1149,22 +1245,22 @@ model BatchAccountProperties { /** * The network access type for operating on the resources in the Batch account. */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-core/no-closed-literal-union" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" + #suppress "@azure-tools/typespec-azure-core/no-closed-literal-union" "Legacy desgin" @summary("The network interface type for accessing Azure Batch service and Batch account operations.") publicNetworkAccess?: PublicNetworkAccessType | null = PublicNetworkAccessType.Enabled; /** * The network profile only takes effect when publicNetworkAccess is enabled. */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" @summary("Network profile for Batch account, which contains network rule settings for each endpoint.") networkProfile?: NetworkProfile | null; /** * List of private endpoint connections associated with the Batch account */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" @visibility(Lifecycle.Read) privateEndpointConnections?: PrivateEndpointConnection[] | null; @@ -1185,7 +1281,7 @@ model BatchAccountProperties { /** * For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" @visibility(Lifecycle.Read) @summary("The dedicated core quota for the Batch account.") dedicatedCoreQuota?: int32 | null; @@ -1193,7 +1289,7 @@ model BatchAccountProperties { /** * For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" @visibility(Lifecycle.Read) @summary("The Spot/low-priority core quota for the Batch account.") lowPriorityCoreQuota?: int32 | null; @@ -1201,9 +1297,9 @@ model BatchAccountProperties { /** * A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Legacy design that typespec didn't have a direct translation for" @visibility(Lifecycle.Read) @OpenAPI.extension("x-ms-identifiers", #["name"]) dedicatedCoreQuotaPerVMFamily?: VirtualMachineFamilyCoreQuota[] | null; @@ -1211,7 +1307,7 @@ model BatchAccountProperties { /** * If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @visibility(Lifecycle.Read) @summary("A value indicating whether core quotas per Virtual Machine family are enforced for this account") dedicatedCoreQuotaPerVMFamilyEnforced?: boolean; @@ -1220,18 +1316,20 @@ model BatchAccountProperties { * The pool quota for the Batch account. */ @visibility(Lifecycle.Read) + @summary("The pool quota for the Batch account.") poolQuota?: int32; /** * The active job and job schedule quota for the Batch account. */ @visibility(Lifecycle.Read) + @summary("The active job and job schedule quota for the Batch account.") activeJobAndJobScheduleQuota?: int32; /** * List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" @visibility(Lifecycle.Read) allowedAuthenticationModes?: AuthenticationMode[] | null; } @@ -1243,14 +1341,15 @@ model PrivateEndpointConnectionProperties { /** * The provisioning state of the private endpoint connection. */ + @summary("The provisioning state of the private endpoint connection.") @visibility(Lifecycle.Read) provisioningState?: PrivateEndpointConnectionProvisioningState; /** * The private endpoint of the private endpoint connection. */ - @visibility(Lifecycle.Read) @summary("The ARM resource identifier of the private endpoint.") + @visibility(Lifecycle.Read) privateEndpoint?: PrivateEndpoint; /** @@ -1263,6 +1362,7 @@ model PrivateEndpointConnectionProperties { /** * The private link service connection state of the private endpoint connection. */ + @summary("The private link service connection state of the private endpoint connection.") privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState; } @@ -1273,6 +1373,7 @@ model PrivateEndpoint { /** * The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. */ + @summary("The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.") @visibility(Lifecycle.Read) id?: string; } @@ -1284,16 +1385,19 @@ model PrivateLinkServiceConnectionState { /** * The status of the Batch private endpoint connection */ + @summary("The status of the Batch private endpoint connection") status: PrivateLinkServiceConnectionStatus; /** * Description of the private Connection state */ + @summary("Description of the private Connection state") description?: string; /** * Action required on the private connection state */ + @summary("Action required on the private connection state") @visibility(Lifecycle.Read) actionsRequired?: string; } @@ -1301,9 +1405,9 @@ model PrivateLinkServiceConnectionState { /** * A definition of an Azure resource. */ -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-custom-resource-no-key" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-custom-resource-usage-discourage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy desgin" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-custom-resource-no-key" "Legacy desgin" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-custom-resource-usage-discourage" "Legacy desgin" @Azure.ResourceManager.Legacy.customAzureResource model AzureProxyResource { /** @@ -1333,14 +1437,14 @@ model AzureProxyResource { /** * The tags of the resource. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; } /** * Contains information about the auto-storage account associated with a Batch account. */ -#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Legacy Design" model AutoStorageProperties extends AutoStorageBaseProperties { /** * The UTC time at which storage keys were last synchronized with the Batch account. @@ -1368,7 +1472,7 @@ model VirtualMachineFamilyCoreQuota { /** * An error response from the Batch service. */ -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy desgin" @error @Azure.ResourceManager.Legacy.armExternalType model CloudError { @@ -1381,7 +1485,7 @@ model CloudError { /** * An error response from the Batch service. */ -#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy desgin" @Azure.ResourceManager.Legacy.armExternalType model CloudErrorBody { /** @@ -1413,13 +1517,13 @@ model BatchAccountUpdateParameters { /** * The user-specified tags associated with the account. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" tags?: Record; /** * The properties of the account. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy desgin" properties?: BatchAccountUpdateProperties; /** @@ -1446,7 +1550,7 @@ model BatchAccountUpdateProperties { /** * List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane. */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" allowedAuthenticationModes?: AuthenticationMode[] | null; /** @@ -1508,7 +1612,7 @@ model ActivateApplicationPackageParameters { /** * Properties of an application package */ -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Legacy Design" model ApplicationPackageProperties { /** * The current state of the application package. @@ -1544,7 +1648,7 @@ model ApplicationPackageProperties { /** * The properties associated with the Application. */ -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Legacy Design" model ApplicationProperties { /** * The display name for the application. @@ -1638,6 +1742,7 @@ model SkuCapability { /** * A REST API operation */ +@summary("A REST API operation") model Operation { /** * This is of the format {provider}/{resource}/{operation} @@ -1653,18 +1758,21 @@ model Operation { /** * The object that describes the operation. */ + @summary("The object that describes the operation.") display?: OperationDisplay; /** * The intended executor of the operation. */ + @summary("The intended executor of the operation.") origin?: string; /** * Properties of the operation. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Legacy design" + @summary("Properties of the operation.") properties?: unknown; } @@ -1675,6 +1783,7 @@ model OperationDisplay { /** * Friendly name of the resource provider. */ + @summary("Friendly name of the resource provider.") provider?: string; /** @@ -1686,18 +1795,20 @@ model OperationDisplay { /** * The resource type on which the operation is performed. */ + @summary("The resource type on which the operation is performed.") resource?: string; /** * The friendly name of the operation */ + @summary("The friendly name of the operation") description?: string; } /** * The result of the request to list operations. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum ResourceType { /** * The resource type for Microsoft.Batch/batchAccounts @@ -1746,14 +1857,18 @@ model CheckNameAvailabilityResult { /** * Values returned by the List operation. */ +@removed(Versions.v2025_06_01) model ListCertificatesResult is Azure.Core.Page; /** * Certificate properties. */ -#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Legacy Design" +@removed(Versions.v2025_06_01) model CertificateProperties extends CertificateBaseProperties { - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + /** + * The provisioned state of the resource + */ @summary("The provisioned state of the resource") @visibility(Lifecycle.Read) provisioningState?: CertificateProvisioningState; @@ -1762,6 +1877,7 @@ model CertificateProperties extends CertificateBaseProperties { * The time at which the certificate entered its current state. */ @visibility(Lifecycle.Read) + @summary("The time at which the certificate entered its current state.") provisioningStateTransitionTime?: utcDateTime; /** @@ -1774,6 +1890,7 @@ model CertificateProperties extends CertificateBaseProperties { * The time at which the certificate entered its previous state. */ @visibility(Lifecycle.Read) + @summary("The time at which the certificate entered its previous state.") previousProvisioningStateTransitionTime?: utcDateTime; /** @@ -1819,6 +1936,7 @@ model DeleteCertificateError { /** * Base certificate properties. */ +@removed(Versions.v2025_06_01) model CertificateBaseProperties { /** * This must match the first portion of the certificate name. Currently required to be 'SHA1'. @@ -1841,21 +1959,23 @@ model CertificateBaseProperties { /** * Contains information about a certificate. */ -#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-custom-resource-no-key" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" -#suppress "@azure-tools/typespec-azure-resource-manager/arm-custom-resource-usage-discourage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Legacy Design" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-custom-resource-no-key" "Legacy desgin" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-custom-resource-usage-discourage" "Legacy desgin" +@removed(Versions.v2025_06_01) model CertificateCreateOrUpdateParameters extends AzureProxyResource { /** * The properties associated with the certificate. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy desgin" properties?: CertificateCreateOrUpdateProperties; } /** * Certificate properties for create operations */ -#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "Legacy Design" +@removed(Versions.v2025_06_01) model CertificateCreateOrUpdateProperties extends CertificateBaseProperties { /** * The maximum size is 10KB. @@ -1875,7 +1995,7 @@ model CertificateCreateOrUpdateProperties extends CertificateBaseProperties { /** * Detector response properties. */ -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Legacy Design" model DetectorResponseProperties { /** * A base64 encoded string that represents the content of a detector. @@ -1891,7 +2011,7 @@ model ListPrivateLinkResourcesResult is Azure.Core.Page; /** * Private link resource properties. */ -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Legacy Design" model PrivateLinkResourceProperties { /** * The group id is used to establish the private link connection. @@ -1903,12 +2023,14 @@ model PrivateLinkResourceProperties { /** * The list of required members that are used to establish the private link connection. */ + @summary("The list of required members that are used to establish the private link connection.") @visibility(Lifecycle.Read) requiredMembers?: string[]; /** * The list of required zone names for the private DNS resource name */ + @summary("The list of required zone names for the private DNS resource name.") @visibility(Lifecycle.Read) requiredZoneNames?: string[]; } @@ -1944,30 +2066,35 @@ model PoolProperties { /** * The creation time of the pool. */ + @summary("The creation time of the pool.") @visibility(Lifecycle.Read) creationTime?: utcDateTime; /** * The current state of the pool. */ + @summary("The current state of the pool.") @visibility(Lifecycle.Read) provisioningState?: PoolProvisioningState; /** * The time at which the pool entered its current state. */ + @summary("The time at which the pool entered its current state.") @visibility(Lifecycle.Read) provisioningStateTransitionTime?: utcDateTime; /** * Whether the pool is resizing. */ + @summary("Whether the pool is resizing.") @visibility(Lifecycle.Read) allocationState?: AllocationState; /** * The time at which the pool entered its current allocation state. */ + @summary("The time at which the pool entered its current allocation state.") @visibility(Lifecycle.Read) allocationStateTransitionTime?: utcDateTime; @@ -1986,12 +2113,14 @@ model PoolProperties { /** * The number of dedicated compute nodes currently in the pool. */ + @summary("The number of dedicated compute nodes currently in the pool.") @visibility(Lifecycle.Read) currentDedicatedNodes?: int32; /** * The number of Spot/low-priority compute nodes currently in the pool. */ + @summary("The number of Spot/low-priority compute nodes currently in the pool.") @visibility(Lifecycle.Read) currentLowPriorityNodes?: int32; @@ -2035,6 +2164,7 @@ model PoolProperties { /** * The list of user accounts to be created on each node in the pool. */ + @summary("The list of user accounts to be created on each node in the pool.") @identifiers(#["name"]) userAccounts?: UserAccount[]; @@ -2057,6 +2187,7 @@ model PoolProperties { * Warning: 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. */ @summary("The list of certificates to be installed on each compute node in the pool.") + @removed(Versions.v2025_06_01) certificates?: CertificateReference[]; /** @@ -2068,6 +2199,7 @@ model PoolProperties { /** * The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail. */ + @removed(Versions.v2025_06_01) @summary("The list of application licenses the Batch service will make available on each compute node in the pool.") applicationLicenses?: string[]; @@ -2088,14 +2220,17 @@ model PoolProperties { /** * If omitted, the default value is Default. */ + @removed(Versions.v2025_06_01) @summary("Determines how a pool communicates with the Batch service.") targetNodeCommunicationMode?: NodeCommunicationMode; /** * Determines how a pool communicates with the Batch service. */ - #suppress "@azure-tools/typespec-azure-core/no-nullable" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - #suppress "@azure-tools/typespec-azure-core/no-closed-literal-union" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-nullable" "legacy design, needed for compatibility" + #suppress "@azure-tools/typespec-azure-core/no-closed-literal-union" "Legacy desgin" + @summary("Determines how a pool communicates with the Batch service.") + @removed(Versions.v2025_06_01) @visibility(Lifecycle.Read) currentNodeCommunicationMode?: NodeCommunicationMode | null; @@ -2108,7 +2243,8 @@ model PoolProperties { /** * The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" + @removed(Versions.v2025_06_01) @summary("The user-specified tags associated with the pool.") resourceTags?: Record; } @@ -2116,6 +2252,7 @@ model PoolProperties { /** * Deployment configuration properties. */ +@summary("Deployment configuration properties.") model DeploymentConfiguration { /** * The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. @@ -2127,6 +2264,7 @@ model DeploymentConfiguration { /** * The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. */ +@summary("The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.") model VirtualMachineConfiguration { /** * A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. @@ -2197,6 +2335,7 @@ model VirtualMachineConfiguration { /** * Specifies the security profile settings for the virtual machine or virtual machine scale set. */ + @summary("Specifies the security profile settings for the virtual machine or virtual machine scale set.") securityProfile?: SecurityProfile; /** @@ -2209,6 +2348,7 @@ model VirtualMachineConfiguration { /** * A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. */ +@summary("A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.") model ImageReference { /** * For example, Canonical or MicrosoftWindowsServer. @@ -2256,6 +2396,7 @@ model ImageReference { /** * Windows operating system settings to apply to the virtual machine. */ +@summary("Windows operating system settings to apply to the virtual machine.") model WindowsConfiguration { /** * If omitted, the default value is true. @@ -2289,7 +2430,8 @@ model DataDisk { /** * The initial disk size in GB when creating new data disk. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" + @summary("The initial disk size in GB when creating new data disk.") diskSizeGB: int32; /** @@ -2299,16 +2441,26 @@ model DataDisk { * Premium_LRS - The data disk should use premium locally redundant storage. */ @summary("The storage account type for use in creating data disks or OS disk.") + @removed(Versions.v2025_06_01) storageAccountType?: StorageAccountType; + + /** + * The managed disk parameters. + */ + @summary("The managed disk parameters.") + @added(Versions.v2025_06_01) + managedDisk?: ManagedDisk; } /** * The configuration for container-enabled pools. */ +@summary("The configuration for container-enabled pools.") model ContainerConfiguration { /** * The container technology to be used. */ + @summary("The container technology to be used.") type: ContainerType; /** @@ -2328,15 +2480,18 @@ model ContainerConfiguration { /** * A private container registry. */ +@summary("A private container registry.") model ContainerRegistry { /** * The user name to log into the registry server. */ + @summary("The user name to log into the registry server.") username?: string; /** * The password to log into the registry server. */ + @summary("The password to log into the registry server.") @secret password?: string; @@ -2362,42 +2517,75 @@ model DiskEncryptionConfiguration { */ @summary("The list of disk targets Batch Service will encrypt on the compute node") targets?: DiskEncryptionTarget[]; + + /** + * Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption. + */ + @added(Versions.v2025_06_01) + @summary("The Customer Managed Key reference to encrypt the OS Disk.") + customerManagedKey?: DiskCustomerManagedKey; +} + +/** + * The Customer Managed Key reference to encrypt the Disk. + */ +@added(Versions.v2025_06_01) +model DiskCustomerManagedKey { + /** + * Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. + */ + keyUrl?: url; + + /** + * Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false. + */ + rotationToLatestKeyVersionEnabled?: boolean; + + /** + * The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault. + */ + identityReference?: ComputeNodeIdentityReference; } /** * Allocation configuration used by Batch Service to provision the nodes. */ -@summary("Node placement configuration for batch pools.") +@summary("Node placement configuration for Batch pools.") model NodePlacementConfiguration { /** * Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. */ - @summary("The placement policy for allocating nodes in the pool.") + @summary("Node placement Policy type on Batch pools.") policy?: NodePlacementPolicyType; } /** * The configuration for virtual machine extensions. */ +@summary("The configuration for virtual machine extensions.") model VMExtension { /** * The name of the virtual machine extension. */ + @summary("The name of the virtual machine extension.") name: string; /** * The name of the extension handler publisher. */ + @summary("The name of the extension handler publisher.") publisher: string; /** * The type of the extensions. */ + @summary("The type of the extensions.") type: string; /** * The version of script handler. */ + @summary("The version of script handler.") typeHandlerVersion?: string; /** @@ -2413,13 +2601,14 @@ model VMExtension { /** * JSON formatted public settings for the extension. */ - #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Legacy design" + @summary("JSON formatted public settings for the extension.") settings?: unknown; /** * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */ - #suppress "@azure-tools/typespec-azure-core/no-unknown" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-unknown" "Legacy design" @secret protectedSettings?: unknown; @@ -2433,38 +2622,45 @@ model VMExtension { /** * Settings for the operating system disk of the virtual machine. */ +@summary("Settings for the operating system disk of the virtual machine.") model OSDisk { /** * Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" + @summary("Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.") ephemeralOSDiskSettings?: DiffDiskSettings; /** * The type of caching to enable for the disk. */ + @summary("The type of caching to enable for the disk.") caching?: CachingType; - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + /** + * The managed disk parameters. + */ @summary("The managed disk parameters.") managedDisk?: ManagedDisk; /** * The initial disk size in GB when creating new OS disk. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" + @summary("The initial disk size in GB when creating new OS disk.") diskSizeGB?: int32; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ + @summary("Specifies whether writeAccelerator should be enabled or disabled on the disk.") writeAcceleratorEnabled?: boolean; } /** * The location where the OS disk should be placed. */ -#suppress "@azure-tools/typespec-azure-core/no-enum" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/no-enum" "legacy design" enum DiffDiskPlacement { /** * The OS disk will be placed on the cache disk of the VM. @@ -2475,6 +2671,7 @@ enum DiffDiskPlacement { /** * Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */ +@summary("Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.") model DiffDiskSettings { /** * This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. @@ -2483,11 +2680,14 @@ model DiffDiskSettings { placement?: DiffDiskPlacement; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** + * The managed disk parameters. + */ model ManagedDisk { /** * The storage account type for use in creating data disks or OS disk. */ + @summary("The storage account type for use in creating data disks or OS disk.") storageAccountType?: StorageAccountType; /** @@ -2495,17 +2695,42 @@ model ManagedDisk { */ @summary("Specifies the security profile for the managed disk.") securityProfile?: VMDiskSecurityProfile; + + /** + * Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode. + */ + @added(Versions.v2025_06_01) + diskEncryptionSet?: DiskEncryptionSetParameters; +} + +/** + * The ARM resource id of the disk encryption set. + */ +@added(Versions.v2025_06_01) +model DiskEncryptionSetParameters { + /** + * The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account. + */ + @summary("The resource id of the disk encryption set.") + id: Azure.Core.armResourceIdentifier; } /** * Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. */ -#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" model VMDiskSecurityProfile { /** * Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs. */ + @summary("Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs.") securityEncryptionType?: SecurityEncryptionTypes; + + /** + * Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode. + */ + @added(Versions.v2025_06_01) + diskEncryptionSet?: DiskEncryptionSetParameters; } /** @@ -2515,6 +2740,7 @@ model SecurityProfile { /** * Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. */ + @summary("Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.") securityType?: SecurityTypes; /** @@ -2525,7 +2751,52 @@ model SecurityProfile { /** * Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */ + @summary("Specifies the security settings like secure boot and vTPM used while creating the virtual machine.") uefiSettings?: UefiSettings; + + /** + * Specifies ProxyAgent settings while creating the virtual machine. + */ + @added(Versions.v2025_06_01) + proxyAgentSettings?: ProxyAgentSettings; +} + +/** + * Specifies ProxyAgent settings while creating the virtual machine. + */ +@added(Versions.v2025_06_01) +model ProxyAgentSettings { + /** + * Specifies whether Metadata Security Protocol feature should be enabled on the virtual machine or virtual machine scale set. Default is False. + */ + enabled?: boolean; + + /** + * Settings for the IMDS endpoint. + */ + imds?: HostEndpointSettings; + + /** + * Settings for the WireServer endpoint. + */ + wireServer?: HostEndpointSettings; +} + +/** + * Specifies particular host endpoint settings. + */ +@added(Versions.v2025_06_01) +model HostEndpointSettings { + /** + * Specifies the access control policy execution mode. + */ + mode?: HostEndpointSettingsModeTypes; + + /** + * Specifies the reference to the InVMAccessControlProfileVersion resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "Matching case of the property in the original spec" + inVMAccessControlProfileReferenceId?: Azure.Core.armResourceIdentifier; } /** @@ -2575,6 +2846,7 @@ model ScaleSettings { /** * Fixed scale settings for the pool. */ +@summary("Fixed scale settings for the pool.") model FixedScaleSettings { /** * The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). @@ -2597,7 +2869,7 @@ model FixedScaleSettings { /** * If omitted, the default value is Requeue. */ - @summary("Determines what to do with a node and its running task(s) if the pool size is decreasing.") + @summary("Determines what to do with a node and its running task(s) after it has been selected for deallocation.") @visibility(Lifecycle.Create, Lifecycle.Update) nodeDeallocationOption?: ComputeNodeDeallocationOption; } @@ -2605,11 +2877,13 @@ model FixedScaleSettings { /** * AutoScale settings for the pool. */ +@summary("AutoScale settings for the pool.") model AutoScaleSettings { /** * A formula for the desired number of compute nodes in the pool. */ - #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Legacy design that typespec didn't have a direct translation for" + @summary("A formula for the desired number of compute nodes in the pool.") @OpenAPI.externalDocs( "https://learn.microsoft.com/azure/batch/batch-automatic-scaling", "Create an automatic scaling formula for scaling compute nodes in a Batch pool" @@ -2626,10 +2900,12 @@ model AutoScaleSettings { /** * The results and errors from an execution of a pool autoscale formula. */ +@summary("The results and errors from an execution of a pool autoscale formula.") model AutoScaleRun { /** * The time at which the autoscale formula was last evaluated. */ + @summary("The time at which the autoscale formula was last evaluated.") evaluationTime: utcDateTime; /** @@ -2648,6 +2924,7 @@ model AutoScaleRun { /** * An error that occurred when autoscaling a pool. */ +@summary("An error that occurred when autoscaling a pool.") model AutoScaleRunError { /** * An identifier for the error. Codes are invariant and are intended to be consumed programmatically. @@ -2662,6 +2939,7 @@ model AutoScaleRunError { /** * Additional details about the error. */ + @summary("Additional details about the error.") @identifiers(#["code"]) details?: AutoScaleRunError[]; } @@ -2673,9 +2951,9 @@ model NetworkConfiguration { /** * The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration */ - #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Legacy design that typespec didn't have a direct translation for" @OpenAPI.externalDocs( - "https://learn.microsoft.com/azure/batch/batch-virtual-network", + "https://learn.microsoft.com/azure/batch/batch-virtual-networks", "Create an Azure Batch pool in a virtual network" ) @summary("The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.") @@ -2684,6 +2962,7 @@ model NetworkConfiguration { /** * The scope of dynamic vnet assignment. */ + @summary("The scope of dynamic vnet assignment.") dynamicVnetAssignmentScope?: DynamicVNetAssignmentScope = DynamicVNetAssignmentScope.none; /** @@ -2695,14 +2974,14 @@ model NetworkConfiguration { /** * The public IP Address configuration of the networking configuration of a Pool. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" @summary("The Public IPAddress configuration for Compute Nodes in the Batch Pool.") publicIPAddressConfiguration?: PublicIPAddressConfiguration; /** * 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. */ - #suppress "@azure-tools/typespec-azure-core/no-openapi" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Legacy design that typespec didn't have a direct translation for" @summary("Whether this pool should enable accelerated networking.") @OpenAPI.externalDocs( "https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview", @@ -2714,6 +2993,7 @@ model NetworkConfiguration { /** * The endpoint configuration for a pool. */ +@summary("The endpoint configuration for a pool.") model PoolEndpointConfiguration { /** * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. @@ -2726,6 +3006,7 @@ model PoolEndpointConfiguration { /** * A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally. */ +@summary("A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.") model InboundNatPool { /** * The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. @@ -2736,6 +3017,7 @@ model InboundNatPool { /** * The protocol of the endpoint. */ + @summary("The protocol of the endpoint.") protocol: InboundEndpointProtocol; /** @@ -2767,6 +3049,7 @@ model InboundNatPool { /** * A network security group rule to apply to an inbound endpoint. */ +@summary("A network security group rule to apply to an inbound endpoint.") model NetworkSecurityGroupRule { /** * Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. @@ -2777,6 +3060,7 @@ model NetworkSecurityGroupRule { /** * The action that should be taken for a specified IP address, subnet range or tag. */ + @summary("The action that should be taken for a specified IP address, subnet range or tag.") access: NetworkSecurityGroupRuleAccess; /** @@ -2795,7 +3079,7 @@ model NetworkSecurityGroupRule { /** * The public IP Address configuration of the networking configuration of a Pool. */ -#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" model PublicIPAddressConfiguration { /** * The default value is BatchManaged @@ -2808,30 +3092,76 @@ model PublicIPAddressConfiguration { */ @summary("The list of public IPs which the Batch service will use when provisioning Compute Nodes.") ipAddressIds?: string[]; + + /** + * IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. + */ + @summary("The IP families used to specify IP versions available to the pool.") + @added(Versions.v2025_06_01) + ipFamilies?: IPFamily[]; + + /** + * IP Tags that will applied to new Public IPs that Batch creates. + */ + @summary("IP Tags that will applied to new Public IPs that Batch creates.") + @identifiers(#[]) + @added(Versions.v2025_06_01) + ipTags?: IPTag[]; } /** * Specifies how tasks should be distributed across compute nodes. */ +@summary("Specifies how tasks should be distributed across compute nodes.") +@added(Versions.v2025_06_01) +model IPTag { + /** + * Example: FirstPartyUsage. + */ + @summary("The IP Tag type.") + ipTagType?: string; + + /** + * Example: SQL. + */ + @summary("The value of the IP tag associated with the public IP.") + tag?: string; +} + +/** + * Specifies how tasks should be distributed across compute nodes. + */ +@summary("Specifies how tasks should be distributed across compute nodes.") model TaskSchedulingPolicy { + /** + * The order for scheduling tasks from different jobs with the same priority. + */ + @summary("If not specified, the default is none.") + @added(Versions.v2025_06_01) + jobDefaultOrder?: JobDefaultOrder; + /** * How tasks should be distributed across compute nodes. */ + @summary("How tasks should be distributed across compute nodes.") nodeFillType: ComputeNodeFillType = ComputeNodeFillType.Spread; } /** * Properties used to create a user on an Azure Batch node. */ +@summary("Properties used to create a user on an Azure Batch node.") model UserAccount { /** * The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. */ + @summary("The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.") name: string; /** * The password for the user account. */ + @summary("The password for the user account.") @secret password: string; @@ -2857,6 +3187,7 @@ model UserAccount { /** * Properties used to create a user account on a Linux node. */ +@summary("Properties used to create a user account on a Linux node.") model LinuxUserConfiguration { /** * The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. @@ -2881,6 +3212,7 @@ model LinuxUserConfiguration { /** * Properties used to create a user account on a Windows node. */ +@summary("Properties used to create a user account on a Windows node.") model WindowsUserConfiguration { /** * Specifies login mode for the user. The default value is Interactive. @@ -2897,11 +3229,13 @@ model MetadataItem { /** * The name of the metadata item. */ + @summary("The name of the metadata item.") name: string; /** * The value of the metadata item. */ + @summary("The value of the metadata item.") value: string; } @@ -2919,12 +3253,14 @@ model StartTask { /** * A list of files that the Batch service will download to the compute node before running the command line. */ + @summary("A list of files that the Batch service will download to the compute node before running the command line.") @identifiers(#["httpUrl"]) resourceFiles?: ResourceFile[]; /** * A list of environment variable settings for the start task. */ + @summary("A list of environment variable settings for the start task.") @identifiers(#["name"]) environmentSettings?: EnvironmentSetting[]; @@ -2956,6 +3292,7 @@ model StartTask { /** * A single file or multiple files to be downloaded to a compute node. */ +@summary("A single file or multiple files to be downloaded to a compute node.") model ResourceFile { /** * The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. @@ -3003,15 +3340,18 @@ model ResourceFile { /** * An environment variable to be set on a task process. */ +@summary("An environment variable to be set on a task process.") model EnvironmentSetting { /** * The name of the environment variable. */ + @summary("The name of the environment variable.") name: string; /** * The value of the environment variable. */ + @summary("The value of the environment variable.") value?: string; } @@ -3036,6 +3376,7 @@ model UserIdentity { /** * Specifies the parameters for the auto user that runs a task on the Batch service. */ +@summary("Specifies the parameters for the auto user that runs a task on the Batch service.") model AutoUserSpecification { /** * The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. @@ -3053,6 +3394,7 @@ model AutoUserSpecification { /** * The container settings for a task. */ +@summary("The container settings for a task.") model TaskContainerSettings { /** * These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. @@ -3075,6 +3417,7 @@ model TaskContainerSettings { /** * A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. */ + @summary("A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.") workingDirectory?: ContainerWorkingDirectory; /** @@ -3088,10 +3431,12 @@ model TaskContainerSettings { /** * The entry of path and mount mode you want to mount into task container. */ +@summary("The entry of path and mount mode you want to mount into task container.") model ContainerHostBatchBindMountEntry { /** * The paths which will be mounted to container task's container. */ + @summary("The paths which will be mounted to container task's container.") source?: ContainerHostDataPath; /** @@ -3105,10 +3450,12 @@ model ContainerHostBatchBindMountEntry { * 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. */ @summary("A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool.") +@removed(Versions.v2025_06_01) model CertificateReference { /** * The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. */ + @summary("The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.") id: string; /** @@ -3126,16 +3473,19 @@ model CertificateReference { /** * Which user accounts on the compute node should have access to the private data of the certificate. */ + @summary("Which user accounts on the compute node should have access to the private data of the certificate.") visibility?: CertificateVisibility[]; } /** * Link to an application package inside the batch account */ +@summary("Link to an application package inside the batch account") model ApplicationPackageReference { /** * The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. */ + @summary("The ID of the application package to install. This must be inside the same Batch account as the pool. This can either be a reference to a specific version or the default version if one exists.") id: string; /** @@ -3153,11 +3503,13 @@ model ResizeOperationStatus { /** * The desired number of dedicated compute nodes in the pool. */ + @summary("The desired number of dedicated compute nodes in the pool.") targetDedicatedNodes?: int32; /** * The desired number of Spot/low-priority compute nodes in the pool. */ + @summary("The desired number of Spot/low-priority compute nodes in the pool.") targetLowPriorityNodes?: int32; /** @@ -3175,6 +3527,7 @@ model ResizeOperationStatus { /** * The time when this resize operation was started. */ + @summary("The time when this resize operation was started.") startTime?: utcDateTime; /** @@ -3188,6 +3541,7 @@ model ResizeOperationStatus { /** * An error that occurred when resizing a pool. */ +@summary("An error that occurred when resizing a pool.") model ResizeError { /** * An identifier for the error. Codes are invariant and are intended to be consumed programmatically. @@ -3202,6 +3556,7 @@ model ResizeError { /** * Additional details about the error. */ + @summary("Additional details about the error.") @identifiers(#["code"]) details?: ResizeError[]; } @@ -3209,6 +3564,7 @@ model ResizeError { /** * The file system to mount on each node. */ +@summary("The file system to mount on each node.") model MountConfiguration { /** * This property is mutually exclusive with all other properties. @@ -3238,15 +3594,18 @@ model MountConfiguration { /** * Information used to connect to an Azure Storage Container using Blobfuse. */ +@summary("Information used to connect to an Azure Storage Container using Blobfuse.") model AzureBlobFileSystemConfiguration { /** * The Azure Storage Account name. */ + @summary("The Azure Storage Account name.") accountName: string; /** * The Azure Blob Storage Container name. */ + @summary("The Azure Blob Storage Container name.") containerName: string; /** @@ -3285,11 +3644,13 @@ model AzureBlobFileSystemConfiguration { /** * Information used to connect to an NFS file system. */ -#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" +@summary("Information used to connect to an NFS file system.") model NFSMountConfiguration { /** * The URI of the file system to mount. */ + @summary("The URI of the file system to mount.") source: string; /** @@ -3308,15 +3669,18 @@ model NFSMountConfiguration { /** * Information used to connect to a CIFS file system. */ +@summary("Information used to connect to a CIFS file system.") model CifsMountConfiguration { /** * The user to use for authentication against the CIFS file system. */ + @summary("The user to use for authentication against the CIFS file system.") userName: string; /** * The URI of the file system to mount. */ + @summary("The URI of the file system to mount.") source: string; /** @@ -3334,6 +3698,7 @@ model CifsMountConfiguration { /** * The password to use for authentication against the CIFS file system. */ + @summary("The password to use for authentication against the CIFS file system.") @secret password: string; } @@ -3341,10 +3706,12 @@ model CifsMountConfiguration { /** * Information used to connect to an Azure Fileshare. */ +@summary("Information used to connect to an Azure Fileshare.") model AzureFileShareConfiguration { /** * The Azure Storage account name. */ + @summary("The Azure Storage account name.") accountName: string; /** @@ -3356,6 +3723,7 @@ model AzureFileShareConfiguration { /** * The Azure Storage account key. */ + @summary("The Azure Storage account key.") @secret accountKey: string; @@ -3379,24 +3747,27 @@ model UpgradePolicy { /** * Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. */ + @summary("Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.") mode: UpgradeMode; /** * The configuration parameters used for performing automatic OS upgrade. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" + @summary("Configuration parameters used for performing automatic OS Upgrade.") automaticOSUpgradePolicy?: AutomaticOSUpgradePolicy; /** * The configuration parameters used while performing a rolling upgrade. */ + @summary("The configuration parameters used while performing a rolling upgrade.") rollingUpgradePolicy?: RollingUpgradePolicy; } /** * The configuration parameters used for performing automatic OS upgrade. */ -#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" model AutomaticOSUpgradePolicy { /** * Whether OS image rollback feature should be disabled. @@ -3406,7 +3777,7 @@ model AutomaticOSUpgradePolicy { /** * Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. */ - #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/casing-style" "Legacy casing" enableAutomaticOSUpgrade?: boolean; /** @@ -3478,7 +3849,7 @@ model BatchPoolIdentity { /** * The list of user identities associated with the Batch pool. */ - #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "legacy design" userAssignedIdentities?: Record; } diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/readme.md b/specification/batch/resource-manager/Microsoft.Batch/Batch/readme.md index 2649f3d436f4..ea9bf90f0150 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/readme.md +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/readme.md @@ -28,9 +28,17 @@ These are the global settings for the Batch API. title: BatchManagementClient description: Batch Client openapi-type: arm -tag: package-2024-07 +tag: package-2025-06 ``` +### Tag: package-2025-06 + +These settings apply only when `--tag=package-2025-06` is specified on the command line. + +```yaml $(tag) == 'package-2025-06' +input-file: + - stable/2025-06-01/openapi.json +``` ### Tag: package-2024-07 diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/routes.tsp b/specification/batch/resource-manager/Microsoft.Batch/Batch/routes.tsp index 175b2d00bcc8..a19177cdb0f4 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/routes.tsp +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/routes.tsp @@ -11,7 +11,7 @@ using TypeSpec.OpenAPI; namespace Microsoft.Batch; -#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "Legacy desgin" @tag("Location") interface LocationOperationGroup { /** diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2024-07-01/openapi.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2024-07-01/openapi.json index 5820dae653fa..71645b4510b5 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2024-07-01/openapi.json +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2024-07-01/openapi.json @@ -3392,10 +3392,12 @@ }, "ApplicationPackageReference": { "type": "object", + "title": "Link to an application package inside the batch account", "description": "Link to an application package inside the batch account", "properties": { "id": { "type": "string", + "title": "The ID of the application package to install. This must be inside the same Batch account as the pool. This can either be a reference to a specific version or the default version if one exists.", "description": "The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists." }, "version": { @@ -3458,11 +3460,13 @@ }, "AutoScaleRun": { "type": "object", + "title": "The results and errors from an execution of a pool autoscale formula.", "description": "The results and errors from an execution of a pool autoscale formula.", "properties": { "evaluationTime": { "type": "string", "format": "date-time", + "title": "The time at which the autoscale formula was last evaluated.", "description": "The time at which the autoscale formula was last evaluated." }, "results": { @@ -3482,6 +3486,7 @@ }, "AutoScaleRunError": { "type": "object", + "title": "An error that occurred when autoscaling a pool.", "description": "An error that occurred when autoscaling a pool.", "properties": { "code": { @@ -3494,6 +3499,7 @@ }, "details": { "type": "array", + "title": "Additional details about the error.", "description": "Additional details about the error.", "items": { "$ref": "#/definitions/AutoScaleRunError" @@ -3510,10 +3516,12 @@ }, "AutoScaleSettings": { "type": "object", + "title": "AutoScale settings for the pool.", "description": "AutoScale settings for the pool.", "properties": { "formula": { "type": "string", + "title": "A formula for the desired number of compute nodes in the pool.", "description": "A formula for the desired number of compute nodes in the pool.", "externalDocs": { "description": "Create an automatic scaling formula for scaling compute nodes in a Batch pool", @@ -3603,7 +3611,7 @@ }, "AutoUserScope": { "type": "string", - "description": "The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks.", + "description": "The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks.", "enum": [ "Task", "Pool" @@ -3627,6 +3635,7 @@ }, "AutoUserSpecification": { "type": "object", + "title": "Specifies the parameters for the auto user that runs a task on the Batch service.", "description": "Specifies the parameters for the auto user that runs a task on the Batch service.", "properties": { "scope": { @@ -3665,14 +3674,17 @@ }, "AzureBlobFileSystemConfiguration": { "type": "object", + "title": "Information used to connect to an Azure Storage Container using Blobfuse.", "description": "Information used to connect to an Azure Storage Container using Blobfuse.", "properties": { "accountName": { "type": "string", + "title": "The Azure Storage Account name.", "description": "The Azure Storage Account name." }, "containerName": { "type": "string", + "title": "The Azure Blob Storage Container name.", "description": "The Azure Blob Storage Container name." }, "accountKey": { @@ -3713,10 +3725,12 @@ }, "AzureFileShareConfiguration": { "type": "object", + "title": "Information used to connect to an Azure Fileshare.", "description": "Information used to connect to an Azure Fileshare.", "properties": { "accountName": { "type": "string", + "title": "The Azure Storage account name.", "description": "The Azure Storage account name." }, "azureFileUrl": { @@ -3727,6 +3741,7 @@ "accountKey": { "type": "string", "format": "password", + "title": "The Azure Storage account key.", "description": "The Azure Storage account key.", "x-ms-secret": true }, @@ -4102,12 +4117,14 @@ "poolQuota": { "type": "integer", "format": "int32", + "title": "The pool quota for the Batch account.", "description": "The pool quota for the Batch account.", "readOnly": true }, "activeJobAndJobScheduleQuota": { "type": "integer", "format": "int32", + "title": "The active job and job schedule quota for the Batch account.", "description": "The active job and job schedule quota for the Batch account.", "readOnly": true }, @@ -4251,14 +4268,17 @@ }, "CIFSMountConfiguration": { "type": "object", + "title": "Information used to connect to a CIFS file system.", "description": "Information used to connect to a CIFS file system.", "properties": { "userName": { "type": "string", + "title": "The user to use for authentication against the CIFS file system.", "description": "The user to use for authentication against the CIFS file system." }, "source": { "type": "string", + "title": "The URI of the file system to mount.", "description": "The URI of the file system to mount." }, "relativeMountPath": { @@ -4274,6 +4294,7 @@ "password": { "type": "string", "format": "password", + "title": "The password to use for authentication against the CIFS file system.", "description": "The password to use for authentication against the CIFS file system.", "x-ms-secret": true } @@ -4440,11 +4461,13 @@ "provisioningState": { "$ref": "#/definitions/CertificateProvisioningState", "title": "The provisioned state of the resource", + "description": "The provisioned state of the resource", "readOnly": true }, "provisioningStateTransitionTime": { "type": "string", "format": "date-time", + "title": "The time at which the certificate entered its current state.", "description": "The time at which the certificate entered its current state.", "readOnly": true }, @@ -4456,6 +4479,7 @@ "previousProvisioningStateTransitionTime": { "type": "string", "format": "date-time", + "title": "The time at which the certificate entered its previous state.", "description": "The time at which the certificate entered its previous state.", "readOnly": true }, @@ -4479,6 +4503,7 @@ }, "CertificateProvisioningState": { "type": "string", + "description": "The current provisioning state of the certificate.", "enum": [ "Succeeded", "Deleting", @@ -4504,7 +4529,8 @@ "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete." } ] - } + }, + "readOnly": true }, "CertificateReference": { "type": "object", @@ -4513,6 +4539,7 @@ "properties": { "id": { "type": "string", + "title": "The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool.", "description": "The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool." }, "storeLocation": { @@ -4527,6 +4554,7 @@ }, "visibility": { "type": "array", + "title": "Which user accounts on the compute node should have access to the private data of the certificate.", "description": "Which user accounts on the compute node should have access to the private data of the certificate.", "items": { "$ref": "#/definitions/CertificateVisibility" @@ -4563,6 +4591,7 @@ }, "CertificateVisibility": { "type": "string", + "description": "The visibility of the certificate.", "enum": [ "StartTask", "Task", @@ -4701,7 +4730,7 @@ { "name": "RetainedData", "value": "RetainedData", - "description": "Deprecated, we encourage you to upload task data to Azure Storage in your task and use `TaskCompletion` instead. Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired." + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired." } ] } @@ -4718,10 +4747,12 @@ }, "ContainerConfiguration": { "type": "object", + "title": "The configuration for container-enabled pools.", "description": "The configuration for container-enabled pools.", "properties": { "type": { "$ref": "#/definitions/ContainerType", + "title": "The container technology to be used.", "description": "The container technology to be used." }, "containerImageNames": { @@ -4750,10 +4781,12 @@ }, "ContainerHostBatchBindMountEntry": { "type": "object", + "title": "The entry of path and mount mode you want to mount into task container.", "description": "The entry of path and mount mode you want to mount into task container.", "properties": { "source": { "$ref": "#/definitions/ContainerHostDataPath", + "title": "The paths which will be mounted to container task's container.", "description": "The paths which will be mounted to container task's container." }, "isReadOnly": { @@ -4813,16 +4846,19 @@ }, "ContainerRegistry": { "type": "object", + "title": "A private container registry.", "description": "A private container registry.", "properties": { "username": { "type": "string", + "title": "The user name to log into the registry server.", "description": "The user name to log into the registry server.", "x-ms-client-name": "userName" }, "password": { "type": "string", "format": "password", + "title": "The password to log into the registry server.", "description": "The password to log into the registry server.", "x-ms-secret": true }, @@ -4904,6 +4940,7 @@ "diskSizeGB": { "type": "integer", "format": "int32", + "title": "The initial disk size in GB when creating new data disk.", "description": "The initial disk size in GB when creating new data disk." }, "storageAccountType": { @@ -4951,6 +4988,7 @@ }, "DeploymentConfiguration": { "type": "object", + "title": "Deployment configuration properties.", "description": "Deployment configuration properties.", "properties": { "virtualMachineConfiguration": { @@ -5039,6 +5077,7 @@ }, "DiffDiskSettings": { "type": "object", + "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", "properties": { "placement": { @@ -5213,14 +5252,17 @@ }, "EnvironmentSetting": { "type": "object", + "title": "An environment variable to be set on a task process.", "description": "An environment variable to be set on a task process.", "properties": { "name": { "type": "string", + "title": "The name of the environment variable.", "description": "The name of the environment variable." }, "value": { "type": "string", + "title": "The value of the environment variable.", "description": "The value of the environment variable." } }, @@ -5230,6 +5272,7 @@ }, "FixedScaleSettings": { "type": "object", + "title": "Fixed scale settings for the pool.", "description": "Fixed scale settings for the pool.", "properties": { "resizeTimeout": { @@ -5253,7 +5296,7 @@ }, "nodeDeallocationOption": { "$ref": "#/definitions/ComputeNodeDeallocationOption", - "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.", + "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", "description": "If omitted, the default value is Requeue.", "x-ms-mutability": [ "update", @@ -5331,6 +5374,7 @@ }, "ImageReference": { "type": "object", + "title": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.", "description": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.", "properties": { "publisher": { @@ -5396,6 +5440,7 @@ }, "InboundNatPool": { "type": "object", + "title": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.", "description": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.", "properties": { "name": { @@ -5405,6 +5450,7 @@ }, "protocol": { "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint.", "description": "The protocol of the endpoint." }, "backendPort": { @@ -5529,6 +5575,7 @@ }, "LinuxUserConfiguration": { "type": "object", + "title": "Properties used to create a user account on a Linux node.", "description": "Properties used to create a user account on a Linux node.", "properties": { "uid": { @@ -5704,9 +5751,11 @@ }, "ManagedDisk": { "type": "object", + "description": "The managed disk parameters.", "properties": { "storageAccountType": { "$ref": "#/definitions/StorageAccountType", + "title": "The storage account type for use in creating data disks or OS disk.", "description": "The storage account type for use in creating data disks or OS disk." }, "securityProfile": { @@ -5723,10 +5772,12 @@ "properties": { "name": { "type": "string", + "title": "The name of the metadata item.", "description": "The name of the metadata item." }, "value": { "type": "string", + "title": "The value of the metadata item.", "description": "The value of the metadata item." } }, @@ -5737,6 +5788,7 @@ }, "MountConfiguration": { "type": "object", + "title": "The file system to mount on each node.", "description": "The file system to mount on each node.", "properties": { "azureBlobFileSystemConfiguration": { @@ -5763,10 +5815,12 @@ }, "NFSMountConfiguration": { "type": "object", + "title": "Information used to connect to an NFS file system.", "description": "Information used to connect to an NFS file system.", "properties": { "source": { "type": "string", + "title": "The URI of the file system to mount.", "description": "The URI of the file system to mount." }, "relativeMountPath": { @@ -5819,11 +5873,12 @@ "description": "The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration", "externalDocs": { "description": "Create an Azure Batch pool in a virtual network", - "url": "https://learn.microsoft.com/azure/batch/batch-virtual-network" + "url": "https://learn.microsoft.com/azure/batch/batch-virtual-networks" } }, "dynamicVnetAssignmentScope": { "type": "string", + "title": "The scope of dynamic vnet assignment.", "description": "The scope of dynamic vnet assignment.", "default": "none", "enum": [ @@ -5884,6 +5939,7 @@ }, "NetworkSecurityGroupRule": { "type": "object", + "title": "A network security group rule to apply to an inbound endpoint.", "description": "A network security group rule to apply to an inbound endpoint.", "properties": { "priority": { @@ -5894,6 +5950,7 @@ }, "access": { "$ref": "#/definitions/NetworkSecurityGroupRuleAccess", + "title": "The action that should be taken for a specified IP address, subnet range or tag.", "description": "The action that should be taken for a specified IP address, subnet range or tag." }, "sourceAddressPrefix": { @@ -5972,12 +6029,12 @@ }, "NodePlacementConfiguration": { "type": "object", - "title": "Node placement configuration for batch pools.", + "title": "Node placement configuration for Batch pools.", "description": "Allocation configuration used by Batch Service to provision the nodes.", "properties": { "policy": { "$ref": "#/definitions/NodePlacementPolicyType", - "title": "The placement policy for allocating nodes in the pool.", + "title": "Node placement Policy type on Batch pools.", "description": "Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy." } } @@ -6008,33 +6065,40 @@ }, "OSDisk": { "type": "object", + "title": "Settings for the operating system disk of the virtual machine.", "description": "Settings for the operating system disk of the virtual machine.", "properties": { "ephemeralOSDiskSettings": { "$ref": "#/definitions/DiffDiskSettings", + "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." }, "caching": { "$ref": "#/definitions/CachingType", + "title": "The type of caching to enable for the disk.", "description": "The type of caching to enable for the disk." }, "managedDisk": { "$ref": "#/definitions/ManagedDisk", - "title": "The managed disk parameters." + "title": "The managed disk parameters.", + "description": "The managed disk parameters." }, "diskSizeGB": { "type": "integer", "format": "int32", + "title": "The initial disk size in GB when creating new OS disk.", "description": "The initial disk size in GB when creating new OS disk." }, "writeAcceleratorEnabled": { "type": "boolean", + "title": "Specifies whether writeAccelerator should be enabled or disabled on the disk.", "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } } }, "Operation": { "type": "object", + "title": "A REST API operation", "description": "A REST API operation", "properties": { "name": { @@ -6048,13 +6112,16 @@ }, "display": { "$ref": "#/definitions/OperationDisplay", + "title": "The object that describes the operation.", "description": "The object that describes the operation." }, "origin": { "type": "string", + "title": "The intended executor of the operation.", "description": "The intended executor of the operation." }, "properties": { + "title": "Properties of the operation.", "description": "Properties of the operation." } } @@ -6065,6 +6132,7 @@ "properties": { "provider": { "type": "string", + "title": "Friendly name of the resource provider.", "description": "Friendly name of the resource provider." }, "operation": { @@ -6074,10 +6142,12 @@ }, "resource": { "type": "string", + "title": "The resource type on which the operation is performed.", "description": "The resource type on which the operation is performed." }, "description": { "type": "string", + "title": "The friendly name of the operation", "description": "The friendly name of the operation" } } @@ -6235,6 +6305,7 @@ }, "PoolEndpointConfiguration": { "type": "object", + "title": "The endpoint configuration for a pool.", "description": "The endpoint configuration for a pool.", "properties": { "inboundNatPools": { @@ -6296,28 +6367,33 @@ "creationTime": { "type": "string", "format": "date-time", + "title": "The creation time of the pool.", "description": "The creation time of the pool.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/PoolProvisioningState", + "title": "The current state of the pool.", "description": "The current state of the pool.", "readOnly": true }, "provisioningStateTransitionTime": { "type": "string", "format": "date-time", + "title": "The time at which the pool entered its current state.", "description": "The time at which the pool entered its current state.", "readOnly": true }, "allocationState": { "$ref": "#/definitions/AllocationState", + "title": "Whether the pool is resizing.", "description": "Whether the pool is resizing.", "readOnly": true }, "allocationStateTransitionTime": { "type": "string", "format": "date-time", + "title": "The time at which the pool entered its current allocation state.", "description": "The time at which the pool entered its current allocation state.", "readOnly": true }, @@ -6334,12 +6410,14 @@ "currentDedicatedNodes": { "type": "integer", "format": "int32", + "title": "The number of dedicated compute nodes currently in the pool.", "description": "The number of dedicated compute nodes currently in the pool.", "readOnly": true }, "currentLowPriorityNodes": { "type": "integer", "format": "int32", + "title": "The number of Spot/low-priority compute nodes currently in the pool.", "description": "The number of Spot/low-priority compute nodes currently in the pool.", "readOnly": true }, @@ -6378,6 +6456,7 @@ }, "userAccounts": { "type": "array", + "title": "The list of user accounts to be created on each node in the pool.", "description": "The list of user accounts to be created on each node in the pool.", "items": { "$ref": "#/definitions/UserAccount" @@ -6448,6 +6527,7 @@ }, "currentNodeCommunicationMode": { "$ref": "#/definitions/NodeCommunicationMode", + "title": "Determines how a pool communicates with the Batch service.", "description": "Determines how a pool communicates with the Batch service.", "x-nullable": true, "readOnly": true @@ -6497,6 +6577,7 @@ "properties": { "id": { "type": "string", + "title": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.", "description": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.", "readOnly": true } @@ -6536,6 +6617,7 @@ "properties": { "provisioningState": { "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "title": "The provisioning state of the private endpoint connection.", "description": "The provisioning state of the private endpoint connection.", "readOnly": true }, @@ -6556,6 +6638,7 @@ }, "privateLinkServiceConnectionState": { "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "title": "The private link service connection state of the private endpoint connection.", "description": "The private link service connection state of the private endpoint connection." } } @@ -6606,7 +6689,8 @@ "description": "The user has cancelled the connection creation." } ] - } + }, + "readOnly": true }, "PrivateLinkResource": { "type": "object", @@ -6648,6 +6732,7 @@ }, "requiredMembers": { "type": "array", + "title": "The list of required members that are used to establish the private link connection.", "description": "The list of required members that are used to establish the private link connection.", "items": { "type": "string" @@ -6656,6 +6741,7 @@ }, "requiredZoneNames": { "type": "array", + "title": "The list of required zone names for the private DNS resource name.", "description": "The list of required zone names for the private DNS resource name", "items": { "type": "string" @@ -6670,14 +6756,17 @@ "properties": { "status": { "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "title": "The status of the Batch private endpoint connection", "description": "The status of the Batch private endpoint connection" }, "description": { "type": "string", + "title": "Description of the private Connection state", "description": "Description of the private Connection state" }, "actionsRequired": { "type": "string", + "title": "Action required on the private connection state", "description": "Action required on the private connection state", "readOnly": true } @@ -6768,7 +6857,8 @@ "description": "The last operation for the account is cancelled." } ] - } + }, + "readOnly": true }, "PublicIPAddressConfiguration": { "type": "object", @@ -6791,6 +6881,7 @@ }, "ResizeError": { "type": "object", + "title": "An error that occurred when resizing a pool.", "description": "An error that occurred when resizing a pool.", "properties": { "code": { @@ -6803,6 +6894,7 @@ }, "details": { "type": "array", + "title": "Additional details about the error.", "description": "Additional details about the error.", "items": { "$ref": "#/definitions/ResizeError" @@ -6825,11 +6917,13 @@ "targetDedicatedNodes": { "type": "integer", "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool.", "description": "The desired number of dedicated compute nodes in the pool." }, "targetLowPriorityNodes": { "type": "integer", "format": "int32", + "title": "The desired number of Spot/low-priority compute nodes in the pool.", "description": "The desired number of Spot/low-priority compute nodes in the pool." }, "resizeTimeout": { @@ -6846,6 +6940,7 @@ "startTime": { "type": "string", "format": "date-time", + "title": "The time when this resize operation was started.", "description": "The time when this resize operation was started." }, "errors": { @@ -6863,6 +6958,7 @@ }, "ResourceFile": { "type": "object", + "title": "A single file or multiple files to be downloaded to a compute node.", "description": "A single file or multiple files to be downloaded to a compute node.", "properties": { "autoStorageContainerName": { @@ -7012,7 +7108,7 @@ }, "SecurityEncryptionTypes": { "type": "string", - "description": "Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs.", + "description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs.", "enum": [ "NonPersistedTPM", "VMGuestStateOnly" @@ -7023,11 +7119,13 @@ "values": [ { "name": "NonPersistedTPM", - "value": "NonPersistedTPM" + "value": "NonPersistedTPM", + "description": "EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob." }, { "name": "VMGuestStateOnly", - "value": "VMGuestStateOnly" + "value": "VMGuestStateOnly", + "description": "EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob." } ] } @@ -7038,6 +7136,7 @@ "properties": { "securityType": { "$ref": "#/definitions/SecurityTypes", + "title": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.", "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings." }, "encryptionAtHost": { @@ -7046,6 +7145,7 @@ }, "uefiSettings": { "$ref": "#/definitions/UefiSettings", + "title": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.", "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine." } } @@ -7116,6 +7216,7 @@ }, "resourceFiles": { "type": "array", + "title": "A list of files that the Batch service will download to the compute node before running the command line.", "description": "A list of files that the Batch service will download to the compute node before running the command line.", "items": { "$ref": "#/definitions/ResourceFile" @@ -7126,6 +7227,7 @@ }, "environmentSettings": { "type": "array", + "title": "A list of environment variable settings for the start task.", "description": "A list of environment variable settings for the start task.", "items": { "$ref": "#/definitions/EnvironmentSetting" @@ -7247,6 +7349,7 @@ }, "TaskContainerSettings": { "type": "object", + "title": "The container settings for a task.", "description": "The container settings for a task.", "properties": { "containerRunOptions": { @@ -7266,6 +7369,7 @@ }, "workingDirectory": { "$ref": "#/definitions/ContainerWorkingDirectory", + "title": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.", "description": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'." }, "containerHostBatchBindMounts": { @@ -7284,10 +7388,12 @@ }, "TaskSchedulingPolicy": { "type": "object", + "title": "Specifies how tasks should be distributed across compute nodes.", "description": "Specifies how tasks should be distributed across compute nodes.", "properties": { "nodeFillType": { "type": "string", + "title": "How tasks should be distributed across compute nodes.", "description": "How tasks should be distributed across compute nodes.", "default": "Spread", "enum": [ @@ -7366,14 +7472,17 @@ "properties": { "mode": { "$ref": "#/definitions/UpgradeMode", + "title": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.", "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between." }, "automaticOSUpgradePolicy": { "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "title": "Configuration parameters used for performing automatic OS Upgrade.", "description": "The configuration parameters used for performing automatic OS upgrade." }, "rollingUpgradePolicy": { "$ref": "#/definitions/RollingUpgradePolicy", + "title": "The configuration parameters used while performing a rolling upgrade.", "description": "The configuration parameters used while performing a rolling upgrade." } }, @@ -7383,15 +7492,18 @@ }, "UserAccount": { "type": "object", + "title": "Properties used to create a user on an Azure Batch node.", "description": "Properties used to create a user on an Azure Batch node.", "properties": { "name": { "type": "string", + "title": "The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.", "description": "The name of the user account. Names can contain any Unicode characters up to a maximum length of 20." }, "password": { "type": "string", "format": "password", + "title": "The password for the user account.", "description": "The password for the user account.", "x-ms-secret": true }, @@ -7455,28 +7567,34 @@ "properties": { "securityEncryptionType": { "$ref": "#/definitions/SecurityEncryptionTypes", + "title": "Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs.", "description": "Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs." } } }, "VMExtension": { "type": "object", + "title": "The configuration for virtual machine extensions.", "description": "The configuration for virtual machine extensions.", "properties": { "name": { "type": "string", + "title": "The name of the virtual machine extension.", "description": "The name of the virtual machine extension." }, "publisher": { "type": "string", + "title": "The name of the extension handler publisher.", "description": "The name of the extension handler publisher." }, "type": { "type": "string", + "title": "The type of the extensions.", "description": "The type of the extensions." }, "typeHandlerVersion": { "type": "string", + "title": "The version of script handler.", "description": "The version of script handler." }, "autoUpgradeMinorVersion": { @@ -7488,6 +7606,7 @@ "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." }, "settings": { + "title": "JSON formatted public settings for the extension.", "description": "JSON formatted public settings for the extension." }, "protectedSettings": { @@ -7512,6 +7631,7 @@ }, "VirtualMachineConfiguration": { "type": "object", + "title": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.", "description": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.", "properties": { "imageReference": { @@ -7579,6 +7699,7 @@ }, "securityProfile": { "$ref": "#/definitions/SecurityProfile", + "title": "Specifies the security profile settings for the virtual machine or virtual machine scale set.", "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set." }, "serviceArtifactReference": { @@ -7611,6 +7732,7 @@ }, "WindowsConfiguration": { "type": "object", + "title": "Windows operating system settings to apply to the virtual machine.", "description": "Windows operating system settings to apply to the virtual machine.", "properties": { "enableAutomaticUpdates": { @@ -7622,6 +7744,7 @@ }, "WindowsUserConfiguration": { "type": "object", + "title": "Properties used to create a user account on a Windows node.", "description": "Properties used to create a user account on a Windows node.", "properties": { "loginMode": { diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationCreate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationCreate.json new file mode 100644 index 000000000000..945f30339b24 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationCreate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + }, + "headers": { + "ETag": "W/\"0x8D64F8EBB3DC411\"" + } + } + }, + "operationId": "Application_Create", + "title": "ApplicationCreate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationDelete.json new file mode 100644 index 000000000000..866bcafea3e4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "Application_Delete", + "title": "ApplicationDelete" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationGet.json new file mode 100644 index 000000000000..bf814f16ace7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "properties": { + "allowUpdates": true, + "displayName": "Sample Application" + } + }, + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + } + } + }, + "operationId": "Application_Get", + "title": "ApplicationGet" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationList.json new file mode 100644 index 000000000000..f47073a86fc6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "properties": { + "allowUpdates": false, + "defaultVersion": "1" + } + }, + { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app2", + "properties": { + "allowUpdates": false, + "defaultVersion": "2.0", + "displayName": "myAppName" + } + } + ] + } + } + }, + "operationId": "Application_List", + "title": "ApplicationList" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageActivate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageActivate.json new file mode 100644 index 000000000000..d4da721e6527 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageActivate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "parameters": { + "format": "zip" + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "versionName": "1" + }, + "responses": { + "200": { + "body": { + "name": "1", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "properties": { + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z", + "state": "Active" + } + }, + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + } + } + }, + "operationId": "ApplicationPackage_Activate", + "title": "ApplicationPackageActivate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageCreate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageCreate.json new file mode 100644 index 000000000000..22b7e097baa7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageCreate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "versionName": "1" + }, + "responses": { + "200": { + "body": { + "name": "1", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "properties": { + "state": "Pending", + "storageUrl": "http://mystorage1.blob.core.windows.net/myapp?mysas", + "storageUrlExpiry": "2017-06-27T18:48:09.9330991Z" + } + }, + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + } + } + }, + "operationId": "ApplicationPackage_Create", + "title": "ApplicationPackageCreate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageDelete.json new file mode 100644 index 000000000000..4b49eb7d6df4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "versionName": "1" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ApplicationPackage_Delete", + "title": "ApplicationPackageDelete" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageGet.json new file mode 100644 index 000000000000..8472888632ce --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "versionName": "1" + }, + "responses": { + "200": { + "body": { + "name": "1", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "properties": { + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z", + "state": "Active" + } + }, + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + } + } + }, + "operationId": "ApplicationPackage_Get", + "title": "ApplicationPackageGet" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageList.json new file mode 100644 index 000000000000..3f5a798d6772 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationPackageList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1.0", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1.0", + "properties": { + "state": "Pending" + } + }, + { + "name": "2.0", + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/2.0", + "properties": { + "format": "zip", + "lastActivationTime": "2017-06-27T18:48:09.9330991Z", + "state": "Active" + } + } + ] + } + } + }, + "operationId": "ApplicationPackage_List", + "title": "ApplicationPackageList" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationUpdate.json new file mode 100644 index 000000000000..e81937b18131 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/ApplicationUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": true, + "defaultVersion": "2", + "displayName": "myAppName" + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "app1", + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "properties": { + "allowUpdates": true, + "defaultVersion": "2", + "displayName": "myAppName" + } + }, + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + } + } + }, + "operationId": "Application_Update", + "title": "ApplicationUpdate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_BYOS.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_BYOS.json new file mode 100644 index 000000000000..3080074c30b9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_BYOS.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "keyVaultReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "poolAllocationMode": "UserSubscription" + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "keyVaultReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "UserSubscription", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "BatchAccountCreate_BYOS" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_Default.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_Default.json new file mode 100644 index 000000000000..301a5401dbcf --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_Default.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "BatchAccountCreate_Default" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_SystemAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_SystemAssignedIdentity.json new file mode 100644 index 000000000000..3118d715566a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_SystemAssignedIdentity.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "identity": { + "type": "SystemAssigned" + }, + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "SystemAssigned", + "principalId": "1a2e532b-9900-414c-8600-cfc6126628d7", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "BatchAccountCreate_SystemAssignedIdentity" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_UserAssignedIdentity.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_UserAssignedIdentity.json new file mode 100644 index 000000000000..2116488f2483 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountCreate_UserAssignedIdentity.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + }, + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + } + } + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "BatchAccountCreate_UserAssignedIdentity" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountDelete.json new file mode 100644 index 000000000000..39f1d460c855 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/providers/Microsoft.Batch/locations/japaneast/accountOperationResults/sampleacct-30a022cb-a64f-4fd5-9289-8b38b342e9de?api-version=2025-06-01" + } + }, + "204": {} + }, + "operationId": "BatchAccount_Delete", + "title": "BatchAccountDelete" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountGet.json new file mode 100644 index 000000000000..cee3b2ea5e85 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + }, + "operationId": "BatchAccount_Get", + "title": "BatchAccountGet" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountGetKeys.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountGetKeys.json new file mode 100644 index 000000000000..dab4292668bd --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountGetKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + }, + "operationId": "BatchAccount_GetKeys", + "title": "BatchAccountGetKeys" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountList.json new file mode 100644 index 000000000000..ea970e6178e2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + ] + } + } + }, + "operationId": "BatchAccount_List", + "title": "BatchAccountList" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountListByResourceGroup.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountListByResourceGroup.json new file mode 100644 index 000000000000..5d10b7ef3b99 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountListByResourceGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + ] + } + } + }, + "operationId": "BatchAccount_ListByResourceGroup", + "title": "BatchAccountListByResourceGroup" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..9b8f00aefd3c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Azure Batch", + "endpoints": [ + { + "description": "Applicable to job manager tasks, tasks that use job scoped authentication, or any task that makes calls to Batch.", + "domainName": "sampleacct.japaneast.batch.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "description": "Applicable to all Azure Batch pools.", + "domainName": "japaneast.service.batch.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Storage", + "endpoints": [ + { + "description": "AutoStorage endpoint for this Batch account. Applicable to all Azure Batch pools under this account.", + "domainName": "autostorageaccountname.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "description": "Applicable to all Azure Batch pools.", + "domainName": "*.blob.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "description": "Applicable to all Azure Batch pools.", + "domainName": "*.table.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + }, + { + "description": "Applicable to all Azure Batch pools.", + "domainName": "*.queue.core.windows.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Microsoft Package Repository", + "endpoints": [ + { + "description": "Only applicable to pools containing a Mount Configuration. Learn about Mount Configurations in Batch at https://learn.microsoft.com/azure/batch/virtual-file-mount.", + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Azure Key Vault", + "endpoints": [ + { + "description": "Only applicable to pools containing a Disk Encryption Configuration and whose VM size does not support encryption at host. Learn more about disk encryption in Azure Batch at https://learn.microsoft.com/azure/batch/disk-encryption. Learn more about encryption at host and supported VM sizes at https://learn.microsoft.com/azure/virtual-machines/disks-enable-host-based-encryption-portal.", + "domainName": "*.vault.azure.net", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + }, + "operationId": "BatchAccount_ListOutboundNetworkDependenciesEndpoints", + "title": "ListOutboundNetworkDependencies" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountRegenerateKey.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountRegenerateKey.json new file mode 100644 index 000000000000..941fa2aada53 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountRegenerateKey.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "keyName": "Primary" + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + }, + "operationId": "BatchAccount_RegenerateKey", + "title": "BatchAccountRegenerateKey" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountSynchronizeAutoStorageKeys.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountSynchronizeAutoStorageKeys.json new file mode 100644 index 000000000000..f3ec35ca9015 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountSynchronizeAutoStorageKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "204": {} + }, + "operationId": "BatchAccount_SynchronizeAutoStorageKeys", + "title": "BatchAccountSynchronizeAutoStorageKeys" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountUpdate.json new file mode 100644 index 000000000000..3e10d9347b56 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/BatchAccountUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled" + } + } + } + }, + "operationId": "BatchAccount_Update", + "title": "BatchAccountUpdate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/DetectorGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/DetectorGet.json new file mode 100644 index 000000000000..e2bd8a6c90eb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/DetectorGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "detectorId": "poolsAndNodes", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "poolsAndNodes", + "type": "Microsoft.Batch/batchAccounts/detectors", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/detectors/poolsAndNodes", + "properties": { + "value": "ew0KICAibWV0YWRhdGEiOiB7DQogICAgImlkIjogInBvb2xzQW5kTm9kZXMiLA0KICAgICJuYW1lIjogIlBvb2xzIGFuZCBOb2RlcyIsDQogICAgImRlc2NyaXB0aW9uIjogbnVsbCwNCiAgICAiYXV0aG9yIjogIiIsDQogICAgImNhdGVnb3J5IjogbnVsbCwNCiAgICAic3VwcG9ydFRvcGljTGlzdCI6IFsNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc3IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDYxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY1IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY2IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDcyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDgyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkzIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDk0IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfQ0KICAgIF0sDQogICAgImFuYWx5c2lzVHlwZXMiOiBudWxsLA0KICAgICJ0eXBlIjogIkFuYWx5c2lzIiwNCiAgICAic2NvcmUiOiAwLjANCiAgfSwNCiAgImRhdGFzZXQiOiBbXSwNCiAgInN0YXR1cyI6IHsNCiAgICAibWVzc2FnZSI6IG51bGwsDQogICAgInN0YXR1c0lkIjogNA0KICB9LA0KICAiZGF0YVByb3ZpZGVyc01ldGFkYXRhIjogbnVsbCwNCiAgInN1Z2dlc3RlZFV0dGVyYW5jZXMiOiBudWxsDQp9" + } + } + } + }, + "operationId": "BatchAccount_GetDetector", + "title": "GetDetector" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/DetectorList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/DetectorList.json new file mode 100644 index 000000000000..f05007632d6b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/DetectorList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "poolsAndNodes", + "type": "Microsoft.Batch/batchAccounts/detectors", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/detectors/poolsAndNodes", + "properties": { + "value": "ew0KICAibWV0YWRhdGEiOiB7DQogICAgImlkIjogInBvb2xzQW5kTm9kZXMiLA0KICAgICJuYW1lIjogIlBvb2xzIGFuZCBOb2RlcyIsDQogICAgImRlc2NyaXB0aW9uIjogbnVsbCwNCiAgICAiYXV0aG9yIjogIiIsDQogICAgImNhdGVnb3J5IjogbnVsbCwNCiAgICAic3VwcG9ydFRvcGljTGlzdCI6IFsNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc3IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDYxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY1IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY2IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDY5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDcyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDc5IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDgyIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkxIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDkzIiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfSwNCiAgICAgIHsNCiAgICAgICAgImlkIjogIjMyNjM1MDk0IiwNCiAgICAgICAgInBlc0lkIjogIjE1NjE0IiwNCiAgICAgICAgInR5cGVJZCI6ICJEaWFnbm9zdGljcy5Nb2RlbHNBbmRVdGlscy5BdHRyaWJ1dGVzLlN1cHBvcnRUb3BpYywgRGlhZ25vc3RpY3MuTW9kZWxzQW5kVXRpbHMsIFZlcnNpb249MS4wLjAuMCwgQ3VsdHVyZT1uZXV0cmFsLCBQdWJsaWNLZXlUb2tlbj1udWxsIg0KICAgICAgfQ0KICAgIF0sDQogICAgImFuYWx5c2lzVHlwZXMiOiBudWxsLA0KICAgICJ0eXBlIjogIkFuYWx5c2lzIiwNCiAgICAic2NvcmUiOiAwLjANCiAgfSwNCiAgImRhdGFzZXQiOiBbXSwNCiAgInN0YXR1cyI6IHsNCiAgICAibWVzc2FnZSI6IG51bGwsDQogICAgInN0YXR1c0lkIjogNA0KICB9LA0KICAiZGF0YVByb3ZpZGVyc01ldGFkYXRhIjogbnVsbCwNCiAgInN1Z2dlc3RlZFV0dGVyYW5jZXMiOiBudWxsDQp9" + } + } + ] + } + } + }, + "operationId": "BatchAccount_ListDetectors", + "title": "ListDetectors" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationCheckNameAvailability_AlreadyExists.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationCheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..4afadde459c2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationCheckNameAvailability_AlreadyExists.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "locationName": "japaneast", + "parameters": { + "name": "existingaccountname", + "type": "Microsoft.Batch/batchAccounts" + }, + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "message": "An account named 'existingaccountname' is already in use.", + "nameAvailable": false, + "reason": "AlreadyExists" + } + } + }, + "operationId": "Location_CheckNameAvailability", + "title": "LocationCheckNameAvailability_AlreadyExists" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationCheckNameAvailability_Available.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationCheckNameAvailability_Available.json new file mode 100644 index 000000000000..d1dacaaba92d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationCheckNameAvailability_Available.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "locationName": "japaneast", + "parameters": { + "name": "newaccountname", + "type": "Microsoft.Batch/batchAccounts" + }, + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "Location_CheckNameAvailability", + "title": "LocationCheckNameAvailability_Available" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationGetQuotas.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationGetQuotas.json new file mode 100644 index 000000000000..44683f1358c0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationGetQuotas.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "locationName": "japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "accountQuota": 1 + } + } + }, + "operationId": "Location_GetQuotas", + "title": "LocationGetQuotas" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationListVirtualMachineSkus.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationListVirtualMachineSkus.json new file mode 100644 index 000000000000..ce102c623953 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/LocationListVirtualMachineSkus.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "api-version": "2025-06-01", + "locationName": "japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_D1_v2", + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + } + ], + "familyName": "standardDFamily" + }, + { + "name": "Standard_A1", + "batchSupportEndOfLife": "2024-08-31T00:00:00Z", + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "71680" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "1.75" + }, + { + "name": "MaxDataDiskCount", + "value": "2" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "IaaS,PaaS" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "ACUs", + "value": "100" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "False" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "familyName": "standardA0_A7Family" + } + ] + } + } + }, + "operationId": "Location_ListSupportedVirtualMachineSkus", + "title": "LocationListVirtualMachineSkus" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationGet.json new file mode 100644 index 000000000000..1b00c088c7ca --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationGet.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "networkSecurityPerimeterConfigurationName": "00000000-0000-0000-0000-000000000000.sampleassociation", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000000000.sampleassociation", + "type": "Microsoft.Batch/batchAccounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/networkSecurityPerimeterConfigurations/00000000-0000-0000-0000-000000000000.sampleassociation", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/perimeterSubscriptionId/resourceGroups/perimeterResourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeterName", + "location": "perimeterLocation", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "accessRule1", + "properties": { + "addressPrefixes": [ + "10.11.0.0/16", + "10.10.1.0/24" + ], + "direction": "Inbound", + "emailAddresses": [], + "fullyQualifiedDomainNames": [], + "networkSecurityPerimeters": [], + "phoneNumbers": [], + "subscriptions": [] + } + }, + { + "name": "accessRule2", + "properties": { + "addressPrefixes": [], + "direction": "Outbound", + "emailAddresses": [], + "fullyQualifiedDomainNames": [ + "paasrp1.contoso.org", + "paasrp2.contoso.org" + ], + "networkSecurityPerimeters": [], + "phoneNumbers": [], + "subscriptions": [] + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningIssues": [], + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "sampleassociation", + "accessMode": "Learning" + } + } + } + } + }, + "operationId": "NetworkSecurityPerimeter_GetConfiguration", + "title": "GetNspConfiguration" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationReconcile.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationReconcile.json new file mode 100644 index 000000000000..77f63b662160 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationReconcile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "networkSecurityPerimeterConfigurationName": "00000000-0000-0000-0000-000000000000.sampleassociation", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/networkSecurityPerimeterConfigurationOperationResults/AcceptedReconciling$00000000-0000-0000-0000-000000000000.sampleassociation$00000000-1111-2222-3333-444444444444?api-version=2025-06-01", + "Retry-After": "15" + } + } + }, + "operationId": "NetworkSecurityPerimeter_ReconcileConfiguration", + "title": "ReconcileNspConfiguration" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationsList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationsList.json new file mode 100644 index 000000000000..ffe018cff9f9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/NspConfigurationsList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "00000000-0000-0000-0000-000000000000.sampleassociation", + "type": "Microsoft.Batch/batchAccounts/networkSecurityPerimeterConfigurations", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/networkSecurityPerimeterConfigurations/00000000-0000-0000-0000-000000000000.sampleassociation", + "properties": { + "networkSecurityPerimeter": { + "id": "/subscriptions/perimeterSubscriptionId/resourceGroups/perimeterResourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeterName", + "location": "perimeterLocation", + "perimeterGuid": "00000000-0000-0000-0000-000000000000" + }, + "profile": { + "name": "profileName", + "accessRules": [ + { + "name": "accessRule1", + "properties": { + "addressPrefixes": [ + "10.11.0.0/16", + "10.10.1.0/24" + ], + "direction": "Inbound", + "emailAddresses": [], + "fullyQualifiedDomainNames": [], + "networkSecurityPerimeters": [], + "phoneNumbers": [], + "subscriptions": [] + } + }, + { + "name": "accessRule2", + "properties": { + "addressPrefixes": [], + "direction": "Outbound", + "emailAddresses": [], + "fullyQualifiedDomainNames": [ + "paasrp1.contoso.org", + "paasrp2.contoso.org" + ], + "networkSecurityPerimeters": [], + "phoneNumbers": [], + "subscriptions": [] + } + } + ], + "accessRulesVersion": 1 + }, + "provisioningIssues": [], + "provisioningState": "Succeeded", + "resourceAssociation": { + "name": "sampleassociation", + "accessMode": "Learning" + } + } + } + ] + } + } + }, + "operationId": "NetworkSecurityPerimeter_ListConfigurations", + "title": "ListNspConfigurations" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/OperationsList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/OperationsList.json new file mode 100644 index 000000000000..d2361fed4e67 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/OperationsList.json @@ -0,0 +1,522 @@ +{ + "parameters": { + "api-version": "2025-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "description": "Gets the diagnostic setting for the resource", + "operation": "Read diagnostic setting", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "description": "Creates or updates the diagnostic setting for the resource", + "operation": "Write diagnostic setting", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "description": "Gets the available logs for the Batch service", + "operation": "Read Batch service log definitions", + "provider": "Microsoft Batch", + "resource": "Batch Account Log Definitions" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "description": "Gets the available metrics for the Batch service", + "operation": "Read Batch service metric definitions", + "provider": "Microsoft Batch", + "resource": "Batch Account Metric Definitions" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/read", + "display": { + "description": "Lists jobs on a Batch account or gets the properties of a job", + "operation": "List or Get Jobs", + "provider": "Microsoft Batch", + "resource": "Jobs" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/write", + "display": { + "description": "Creates a new job on a Batch account or updates an existing job", + "operation": "Create or Update Job", + "provider": "Microsoft Batch", + "resource": "Jobs" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobs/delete", + "display": { + "description": "Deletes a job from a Batch account", + "operation": "Delete Job", + "provider": "Microsoft Batch", + "resource": "Jobs" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/read", + "display": { + "description": "Lists job schedules on a Batch account or gets the properties of a job schedule", + "operation": "List or Get Job Schedules", + "provider": "Microsoft Batch", + "resource": "Job Schedules" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/write", + "display": { + "description": "Creates a new job schedule on a Batch account or updates an existing job schedule", + "operation": "Create or Update Job Schedule", + "provider": "Microsoft Batch", + "resource": "Job Schedules" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/batchAccounts/jobSchedules/delete", + "display": { + "description": "Deletes a job schedule from a Batch account", + "operation": "Delete Job Schedule", + "provider": "Microsoft Batch", + "resource": "Job Schedules" + }, + "isDataAction": true + }, + { + "name": "Microsoft.Batch/operations/read", + "display": { + "description": "Lists operations available on Microsoft.Batch resource provider", + "operation": "List Available Batch Operations", + "provider": "Microsoft Batch", + "resource": "Available Batch Operations" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/read", + "display": { + "description": "Lists Batch accounts or gets the properties of a Batch account", + "operation": "List or Get Batch Accounts", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/write", + "display": { + "description": "Creates a new Batch account or updates an existing Batch account", + "operation": "Create or Update Batch Account", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/delete", + "display": { + "description": "Deletes a Batch account", + "operation": "Delete Batch Account", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/listkeys/action", + "display": { + "description": "Lists access keys for a Batch account", + "operation": "List Batch Account Keys", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/regeneratekeys/action", + "display": { + "description": "Regenerates access keys for a Batch account", + "operation": "Regenerate Batch Account Keys", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/locations/quotas/read", + "display": { + "description": "Gets Batch quotas of the specified subscription at the specified Azure region", + "operation": "Get Batch Quotas", + "provider": "Microsoft Batch", + "resource": "Batch Quotas" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/locations/checkNameAvailability/action", + "display": { + "description": "Checks that the account name is valid and not in use.", + "operation": "Check Name Availability", + "provider": "Microsoft Batch", + "resource": "Name Availability" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/operationResults/read", + "display": { + "description": "Gets the results of a long running Batch account operation", + "operation": "Get Batch account operation results", + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/accountOperationResults/read", + "display": { + "description": "Gets the results of a long running Batch account operation", + "operation": "Get Batch account operation results", + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/register/action", + "display": { + "description": "Registers the subscription for the Batch Resource Provider and enables the creation of Batch accounts", + "operation": "Register the Batch Resource Provider", + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/unregister/action", + "display": { + "description": "Unregisters the subscription for the Batch Resource Provider preventing the creation of Batch accounts", + "operation": "Unregister the Batch Resource Provider", + "provider": "Microsoft Batch", + "resource": "Batch Resource Provider" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/syncAutoStorageKeys/action", + "display": { + "description": "Synchronizes access keys for the auto storage account configured for a Batch account", + "operation": "Synchronize Auto Storage Account Keys", + "provider": "Microsoft Batch", + "resource": "Batch Accounts" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/read", + "display": { + "description": "Lists applications or gets the properties of an application", + "operation": "List or Get Applications", + "provider": "Microsoft Batch", + "resource": "Applications" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/write", + "display": { + "description": "Creates a new application or updates an existing application", + "operation": "Create or Update Application", + "provider": "Microsoft Batch", + "resource": "Applications" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/delete", + "display": { + "description": "Deletes an application", + "operation": "Delete Application", + "provider": "Microsoft Batch", + "resource": "Applications" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/read", + "display": { + "description": "Gets the properties of an application package", + "operation": "Get Application Package", + "provider": "Microsoft Batch", + "resource": "Application Packages" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/write", + "display": { + "description": "Creates a new application package or updates an existing application package", + "operation": "Create or Update Application Package", + "provider": "Microsoft Batch", + "resource": "Application Packages" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/delete", + "display": { + "description": "Deletes an application package", + "operation": "Delete Application Package", + "provider": "Microsoft Batch", + "resource": "Application Packages" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/applications/versions/activate/action", + "display": { + "description": "Activates an application package", + "operation": "Activate Application Package", + "provider": "Microsoft Batch", + "resource": "Application Packages" + }, + "isDataAction": false, + "origin": "user,system" + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/read", + "display": { + "description": "Lists pools on a Batch account or gets the properties of a pool", + "operation": "List or Get Pools", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/write", + "display": { + "description": "Creates a new pool on a Batch account or updates an existing pool", + "operation": "Create or Update Pool", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/delete", + "display": { + "description": "Deletes a pool from a Batch account", + "operation": "Delete Pool", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/stopResize/action", + "display": { + "description": "Stops an ongoing resize operation on a Batch account pool", + "operation": "Stop Pool Resize", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/pools/disableAutoscale/action", + "display": { + "description": "Disables automatic scaling for a Batch account pool", + "operation": "Disable Pool AutoScale", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/poolOperationResults/read", + "display": { + "description": "Gets the results of a long running pool operation on a Batch account", + "operation": "Get Pool Operation Results", + "provider": "Microsoft Batch", + "resource": "Pools" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/virtualMachineSkus/read", + "display": { + "description": "Lists available Batch supported Virtual Machine VM sizes at the given location", + "operation": "List Supported Batch Virtual Machine VM", + "provider": "Microsoft Batch", + "resource": "Batch Supported Skus" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/locations/cloudServiceSkus/read", + "display": { + "description": "Lists available Batch supported Cloud Service VM sizes at the given location", + "operation": "List Supported Batch Cloud Service VM", + "provider": "Microsoft Batch", + "resource": "Batch Supported Skus" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateLinkResources/read", + "display": { + "description": "Gets the properties of a Private link resource or Lists Private link resources on a Batch account", + "operation": "Get or List Private link resources", + "provider": "Microsoft Batch", + "resource": "PrivateLinkResources" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnections/write", + "display": { + "description": "Update an existing Private endpoint connection on a Batch account", + "operation": "Update Private endpoint connection", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnections/read", + "display": { + "description": "Gets Private endpoint connection or Lists Private endpoint connections on a Batch account", + "operation": "Get or List Private endpoint connection", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionResults/read", + "display": { + "description": "Gets the results of a long running Batch account private endpoint connection operation", + "operation": "Get Batch account private endpoint connection operation results", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnections" + }, + "isDataAction": false + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/validate/action", + "display": { + "description": "Validates a Private endpoint connection proxy on a Batch account", + "operation": "Validates a Private endpoint connection proxy", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/write", + "display": { + "description": "Create a new Private endpoint connection proxy on a Batch account", + "operation": "Create or Update Private endpoint connection proxy", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/read", + "display": { + "description": "Gets Private endpoint connection proxy on a Batch account", + "operation": "Get Private endpoint connection proxy", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxies/delete", + "display": { + "description": "Delete a Private endpoint connection proxy on a Batch account", + "operation": "Delete Private endpoint connection proxy", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/privateEndpointConnectionProxyResults/read", + "display": { + "description": "Gets the results of a long running Batch account private endpoint connection proxy operation", + "operation": "Get Batch account private endpoint connection proxy operation results", + "provider": "Microsoft Batch", + "resource": "PrivateEndpointConnectionProxies" + }, + "isDataAction": false, + "origin": "system" + }, + { + "name": "Microsoft.Batch/batchAccounts/outboundNetworkDependenciesEndpoints/read", + "display": { + "description": "Lists the outbound network dependency endpoints for a Batch account", + "operation": "List Outbound Network Dependency Endpoints", + "provider": "Microsoft Batch", + "resource": "Outbound Network Dependencies Endpoints" + }, + "isDataAction": false, + "origin": "user,system" + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "OperationsList" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_AcceleratedNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_AcceleratedNetworking.json new file mode 100644 index 000000000000..8271f423d17f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_AcceleratedNetworking.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "networkConfiguration": { + "enableAcceleratedNetworking": true, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "vmSize": "STANDARD_D1_V2" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z", + "creationTime": "2023-04-27T02:59:41.8592226Z", + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-04-27T02:59:41.8592226Z", + "networkConfiguration": { + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": true, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-04-27T02:59:41.8592226Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D1_V2" + } + }, + "headers": { + "ETag": "W/\"0x8DB46CB72A227E2\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - accelerated networking" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_ConfidentialDiskEncryptionSet_ForUserSubscriptionAccounts.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_ConfidentialDiskEncryptionSet_ForUserSubscriptionAccounts.json new file mode 100644 index 000000000000..a895b14deca6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_ConfidentialDiskEncryptionSet_ForUserSubscriptionAccounts.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "vmSize": "Standard_DC2as_v5", + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-datacenter-core-g2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "securityProfile": { + "securityType": "confidentialVM", + "encryptionAtHost": false, + "uefiSettings": { + "vTpmEnabled": true, + "secureBootEnabled": true + } + }, + "osDisk": { + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + }, + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/ConfidentialDiskEncryptionSetId" + } + } + } + }, + "dataDisks": [ + { + "lun": 0, + "diskSizeGB": 1024, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + } + ] + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "resizeTimeout": "PT15M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2025-06-30T07:30:49.7522647Z", + "creationTime": "2025-06-30T07:30:49.7522634Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2025-06-30T07:30:49.7522634Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2025-06-30T07:30:49.7522647Z", + "vmSize": "STANDARD_DC2as_v5", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Pack", + "jobDefaultOrder": "None" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2019-datacenter-core-g2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "dataDisks": [ + { + "lun": 0, + "caching": "None", + "diskSizeGB": 1024, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + } + ], + "osDisk": { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "securityProfile": { + "securityEncryptionType": "DiskWithVMGuestState", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/ConfidentialDiskEncryptionSetId" + } + }, + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + }, + "securityProfile": { + "securityType": "confidentialVM", + "encryptionAtHost": false, + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2025-06-30T07:30:49.7522324Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - confidential disk encryption set for user subscription accounts" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_CustomerManagedKey_ForBatchManagedAccounts.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_CustomerManagedKey_ForBatchManagedAccounts.json new file mode 100644 index 000000000000..17a4580a7dbb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_CustomerManagedKey_ForBatchManagedAccounts.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "vmSize": "Standard_D4ds_v5", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk" + ], + "customerManagedKey": { + "keyUrl": "http://sample.vault.azure.net//keys/cmk/bb60031a6d4545d3a60d3f94588538c9", + "identityReference": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + } + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "resizeTimeout": "PT15M" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "principalId": "principalId", + "clientId": "clientId" + } + } + }, + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2025-06-30T07:16:33.4309281Z", + "creationTime": "2025-06-30T07:16:33.4309266Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2025-06-30T07:16:33.4309266Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2025-06-30T07:16:33.4309281Z", + "vmSize": "Standard_D4ds_v5", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread", + "jobDefaultOrder": "None" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2022-Datacenter", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk" + ], + "customerManagedKey": { + "keyUrl": "http://sample.vault.azure.net//keys/cmk/bb60031a6d4545d3a60d3f94588538c9", + "identityReference": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" + } + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2025-06-30T07:16:33.4309126Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - customer managed key for Batch managed accounts" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_DiskEncryptionSet_ForUserSubscriptionAccounts.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_DiskEncryptionSet_ForUserSubscriptionAccounts.json new file mode 100644 index 000000000000..c3189ffa2e7f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_DiskEncryptionSet_ForUserSubscriptionAccounts.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "vmSize": "Standard_D4ds_v5", + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "sku": "2022-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "securityProfile": { + "encryptionAtHost": false + }, + "osDisk": { + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "resizeTimeout": "PT15M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2025-06-30T07:45:46.1580726Z", + "creationTime": "2025-06-30T07:35:44.5579791Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2025-06-30T07:35:44.5579791Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2025-06-30T07:45:46.1580727Z", + "vmSize": "Standard_D4ds_v5", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Pack", + "jobDefaultOrder": "None" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2022-Datacenter", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId" + } + } + }, + "securityProfile": { + "encryptionAtHost": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2025-06-30T07:45:46.1580724Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - disk encryption set for user subscription accounts" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_DualStackNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_DualStackNetworking.json new file mode 100644 index 000000000000..291fe695cad6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_DualStackNetworking.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789012", + "resourceGroupName": "default-azurebatch", + "accountName": "exampleacc", + "poolName": "dualstackpool", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "vmSize": "Standard_D4ds_v5", + "networkConfiguration": { + "publicIPAddressConfiguration": { + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "endpointConfiguration": { + "inboundNatPools": [ + { + "backendPort": 22, + "frontendPortRangeStart": 40000, + "frontendPortRangeEnd": 40500, + "name": "sshpool", + "protocol": "TCP", + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 1000, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + } + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "ubuntu-24_04-lts", + "sku": "server" + }, + "nodeAgentSkuId": "batch.node.ubuntu 24.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/dualstackpool", + "name": "dualstackpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8DDC34D4A01A419\"", + "properties": { + "lastModified": "2025-07-15T03:11:27.7998105Z", + "creationTime": "2025-07-15T03:11:27.7997967Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2025-07-15T03:11:27.7997967Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2025-07-15T03:11:27.7998136Z", + "vmSize": "Standard_D4ds_v5", + "interNodeCommunication": "Disabled", + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread", + "jobDefaultOrder": "None" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "ubuntu-24_04-lts", + "sku": "server", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 24.04" + } + }, + "networkConfiguration": { + "publicIPAddressConfiguration": { + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "sshpool", + "protocol": "TCP", + "backendPort": 22, + "frontendPortRangeStart": 40000, + "frontendPortRangeEnd": 40500, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "*", + "priority": 1000, + "sourcePortRanges": [ + "*" + ] + } + ] + } + ] + }, + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": false + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2025-07-15T03:11:27.7994621Z" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - dual stack networking" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json new file mode 100644 index 000000000000..64678f4f3b8e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Minimal VirtualMachineConfiguration" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_NoPublicIPAddresses.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_NoPublicIPAddresses.json new file mode 100644 index 000000000000..b56ea5c1c723 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_NoPublicIPAddresses.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "networkConfiguration": { + "publicIPAddressConfiguration": { + "provision": "NoPublicIPAddresses" + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "networkConfiguration": { + "publicIPAddressConfiguration": { + "provision": "NoPublicIPAddresses" + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - No public IP" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_PublicIPs.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_PublicIPs.json new file mode 100644 index 000000000000..f4fc6415ccfe --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_PublicIPs.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "networkConfiguration": { + "publicIPAddressConfiguration": { + "ipAddressIds": [ + "/subscriptions/12345678-1234-1234-1234-1234567890121/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135" + ], + "provision": "UserManaged" + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "networkConfiguration": { + "publicIPAddressConfiguration": { + "ipAddressIds": [ + "/subscriptions/12345678-1234-1234-1234-1234567890121/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135" + ], + "provision": "UserManaged" + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Public IPs" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_SecurityProfile.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_SecurityProfile.json new file mode 100644 index 000000000000..0f62b22ec899 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_SecurityProfile.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04", + "securityProfile": { + "encryptionAtHost": true, + "securityType": "trustedLaunch", + "uefiSettings": { + "secureBootEnabled": null, + "vTpmEnabled": false + } + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "vmSize": "Standard_d4s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04", + "securityProfile": { + "encryptionAtHost": true, + "securityType": "trustedLaunch", + "uefiSettings": { + "vTpmEnabled": false + } + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-06-14T07:03:58.3231917Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - SecurityProfile" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_SharedImageGallery.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_SharedImageGallery.json new file mode 100644 index 000000000000..640eb9ef5f70 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_SharedImageGallery.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Custom Image" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_Tags.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_Tags.json new file mode 100644 index 000000000000..b67ccf1da011 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_Tags.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-jammy", + "publisher": "Canonical", + "sku": "22_04-lts", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 22.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "vmSize": "Standard_d4s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-jammy", + "publisher": "Canonical", + "sku": "22_04-lts", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 22.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-09-27T07:33:13.0625789Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Tags" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_UpgradePolicy.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_UpgradePolicy.json new file mode 100644 index 000000000000..6539facd9ce8 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_UpgradePolicy.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "disableAutomaticRollback": true, + "enableAutomaticOSUpgrade": true, + "osRollingUpgradeDeferral": true, + "useRollingUpgradePolicy": true + }, + "mode": "automatic", + "rollingUpgradePolicy": { + "enableCrossZoneUpgrade": true, + "maxBatchInstancePercent": 20, + "maxUnhealthyInstancePercent": 20, + "maxUnhealthyUpgradedInstancePercent": 20, + "pauseTimeBetweenBatches": "PT0S", + "prioritizeUnhealthyInstances": false, + "rollbackFailedInstancesOnPolicyBreach": false + } + }, + "vmSize": "Standard_d4s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-05-11T06:16:44.2372184Z", + "creationTime": "2023-05-11T06:16:44.2372184Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-05-11T06:16:44.2372184Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T06:16:44.2372184Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T06:16:44.2372184Z", + "targetDedicatedNodes": 2 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "disableAutomaticRollback": true, + "enableAutomaticOSUpgrade": true, + "osRollingUpgradeDeferral": true, + "useRollingUpgradePolicy": true + }, + "mode": "automatic", + "rollingUpgradePolicy": { + "enableCrossZoneUpgrade": true, + "maxBatchInstancePercent": 20, + "maxUnhealthyInstancePercent": 20, + "maxUnhealthyUpgradedInstancePercent": 20, + "pauseTimeBetweenBatches": "PT0S", + "prioritizeUnhealthyInstances": false, + "rollbackFailedInstancesOnPolicyBreach": false + } + }, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - UpgradePolicy" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_UserAssignedIdentities.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_UserAssignedIdentities.json new file mode 100644 index 000000000000..900d28755b22 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_UserAssignedIdentities.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}, + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {} + } + }, + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "clientId1", + "principalId": "principalId1" + }, + "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": { + "clientId": "clientId2", + "principalId": "principalId2" + } + } + }, + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2020-10-01T10:22:55.9407275Z", + "creationTime": "2020-10-01T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2020-10-01T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2020-10-01T10:22:55.9407275Z", + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - UserAssignedIdentities" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..a3ee0a470b99 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "dataDisks": [ + { + "caching": "ReadWrite", + "diskSizeGB": 30, + "lun": 0, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + } + }, + { + "caching": "None", + "diskSizeGB": 200, + "lun": 1, + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + } + ], + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk", + "TemporaryDisk" + ] + }, + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "licenseType": "Windows_Server", + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "osDisk": { + "ephemeralOSDiskSettings": { + "placement": "CacheDisk" + } + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "backendPort": 12001, + "frontendPortRangeEnd": 15100, + "frontendPortRangeStart": 15000, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 150, + "sourceAddressPrefix": "192.100.12.45", + "sourcePortRanges": [ + "1", + "2" + ] + }, + { + "access": "Deny", + "priority": 3500, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ], + "protocol": "TCP" + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "dataDisks": [ + { + "caching": "ReadWrite", + "diskSizeGB": 30, + "lun": 0, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + } + }, + { + "caching": "None", + "diskSizeGB": 200, + "lun": 1, + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + ], + "diskEncryptionConfiguration": { + "targets": [ + "OsDisk", + "TemporaryDisk" + ] + }, + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "licenseType": "Windows_Server", + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "backendPort": 12001, + "frontendPortRangeEnd": 15100, + "frontendPortRangeStart": 15000, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 150, + "sourceAddressPrefix": "192.100.12.45", + "sourcePortRanges": [ + "1", + "2" + ] + }, + { + "access": "Deny", + "priority": 3500, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ], + "protocol": "TCP" + } + ] + } + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - Full VirtualMachineConfiguration" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json new file mode 100644 index 000000000000..34853430a109 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_Extensions.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-focal", + "publisher": "Canonical", + "sku": "20_04-lts" + }, + "nodeAgentSkuId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "publisher": "Microsoft.Azure.KeyVault", + "settings": { + "authenticationSettingsKey": "authenticationSettingsValue", + "secretsManagementSettingsKey": "secretsManagementSettingsValue" + }, + "typeHandlerVersion": "2.0" + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "vmSize": "STANDARD_D4" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-focal", + "publisher": "Canonical", + "sku": "20_04-lts" + }, + "nodeAgentSkuId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "publisher": "Microsoft.Azure.KeyVault", + "settings": { + "authenticationSettingsKey": "authenticationSettingsValue", + "secretsManagementSettingsKey": "secretsManagementSettingsValue" + }, + "typeHandlerVersion": "2.0" + } + ] + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT5M", + "formula": "$TargetDedicatedNodes=1" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - VirtualMachineConfiguration Extensions" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json new file mode 100644 index 000000000000..420b41211873 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "windowsserver", + "publisher": "microsoftwindowsserver", + "sku": "2022-datacenter-smalldisk" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "ReadWrite", + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "writeAcceleratorEnabled": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "vmSize": "Standard_d2s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "creationTime": "2023-08-24T02:12:27.7527697Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "windowsserver", + "publisher": "microsoftwindowsserver", + "sku": "2022-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "ReadWrite", + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "writeAcceleratorEnabled": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-08-24T02:12:27.7527697Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-08-24T02:12:27.7527697Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D2_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51F14DC1A8AD\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - VirtualMachineConfiguration OSDisk" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json new file mode 100644 index 000000000000..86489d9c1e60 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "serviceArtifactReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + }, + "mode": "automatic" + }, + "vmSize": "Standard_d4s_v3" + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "mypool41", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "creationTime": "2023-05-11T07:44:44.8580493Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "serviceArtifactReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-05-11T07:44:44.8580493Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T07:44:44.8580493Z", + "targetDedicatedNodes": 2 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + }, + "mode": "automatic" + }, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51F14DC1A8AD\"" + } + } + }, + "operationId": "Pool_Create", + "title": "CreatePool - VirtualMachineConfiguration ServiceArtifactReference" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolDelete.json new file mode 100644 index 000000000000..9b8e34bf301e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/poolOperationResults/delete-testpool-8D4EDFF164A11C9?api-version=2025-06-01", + "Retry-After": "15" + } + }, + "204": {} + }, + "operationId": "Pool_Delete", + "title": "DeletePool" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolDisableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolDisableAutoScale.json new file mode 100644 index 000000000000..8f55ef20c643 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolDisableAutoScale.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_DisableAutoScale", + "title": "Disable AutoScale" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet.json new file mode 100644 index 000000000000..137bd87d7bbc --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "applicationPackages": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Enabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "backendPort": 12001, + "frontendPortRangeEnd": 15100, + "frontendPortRangeStart": 15000, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 150, + "sourceAddressPrefix": "192.100.12.45", + "sourcePortRanges": [ + "123", + "22" + ] + }, + { + "access": "Deny", + "priority": 3500, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ], + "protocol": "TCP" + } + ] + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + } + }, + "startTask": { + "commandLine": "cmd /c SET", + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "maxTaskRetryCount": 6, + "resourceFiles": [ + { + "fileMode": "777", + "filePath": "c:\\temp\\gohere", + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file" + } + ], + "userIdentity": { + "autoUser": { + "elevationLevel": "Admin", + "scope": "Pool" + } + }, + "waitForSuccess": true + }, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "taskSlotsPerNode": 13, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "gid": 4567, + "uid": 1234 + } + } + ], + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_AcceleratedNetworking.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_AcceleratedNetworking.json new file mode 100644 index 000000000000..3ff4a8b5d409 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_AcceleratedNetworking.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-04-28T02:33:40.82831Z", + "creationTime": "2023-04-28T02:32:32.8696419Z", + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-04-28T02:32:32.8696419Z", + "networkConfiguration": { + "dynamicVnetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-04-28T02:32:32.8696419Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-04-28T02:32:32.8696419Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D1_V2" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - AcceleratedNetworking" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_SecurityProfile.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_SecurityProfile.json new file mode 100644 index 000000000000..4a4bfcfd5af5 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_SecurityProfile.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-06-14T07:04:57.3413444Z", + "creationTime": "2023-06-14T07:03:58.3231917Z", + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04", + "securityProfile": { + "encryptionAtHost": true, + "securityType": "trustedLaunch", + "uefiSettings": { + "vTpmEnabled": false + } + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-06-14T07:03:58.3231917Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-06-14T07:03:58.3231917Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB554F8E08BCF4\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - SecurityProfile" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_UpgradePolicy.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_UpgradePolicy.json new file mode 100644 index 000000000000..0fd769584059 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_UpgradePolicy.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-05-11T06:10:31.4670326Z", + "creationTime": "2023-05-11T06:09:38.3178089Z", + "currentDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "nodePlacementConfiguration": { + "policy": "Zonal" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-05-11T06:09:38.3178089Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T06:09:38.3178089Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T06:09:38.3178089Z", + "targetDedicatedNodes": 2 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "disableAutomaticRollback": true, + "enableAutomaticOSUpgrade": true, + "osRollingUpgradeDeferral": true, + "useRollingUpgradePolicy": true + }, + "mode": "automatic", + "rollingUpgradePolicy": { + "enableCrossZoneUpgrade": true, + "maxBatchInstancePercent": 20, + "maxUnhealthyInstancePercent": 20, + "maxUnhealthyUpgradedInstancePercent": 20, + "pauseTimeBetweenBatches": "PT0S", + "prioritizeUnhealthyInstances": false, + "rollbackFailedInstancesOnPolicyBreach": false + } + }, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - UpgradePolicy" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json new file mode 100644 index 000000000000..8c103788595f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_Extensions.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "0001-com-ubuntu-server-focal", + "publisher": "Canonical", + "sku": "20_04-lts" + }, + "nodeAgentSkuId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "publisher": "Microsoft.Azure.KeyVault", + "settings": { + "authenticationSettingsKey": "authenticationSettingsValue", + "secretsManagementSettingsKey": "secretsManagementSettingsValue" + }, + "typeHandlerVersion": "2.0" + } + ] + } + }, + "interNodeCommunication": "Enabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "taskSlotsPerNode": 13, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - VirtualMachineConfiguration Extensions" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json new file mode 100644 index 000000000000..8d359a25fe6b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-08-24T02:13:22.4881351Z", + "creationTime": "2023-08-24T02:12:27.7527697Z", + "currentDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "windowsserver", + "publisher": "microsoftwindowsserver", + "sku": "2022-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "osDisk": { + "caching": "ReadWrite", + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "StandardSSD_LRS" + }, + "writeAcceleratorEnabled": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-08-24T02:12:27.7527697Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-08-24T02:12:27.7527697Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D2_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - VirtualMachineConfiguration OSDisk" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json new file mode 100644 index 000000000000..290e27612847 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2023-05-11T07:45:42.0881659Z", + "creationTime": "2023-05-11T07:44:44.8580493Z", + "currentDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2019-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "serviceArtifactReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + } + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2023-05-11T07:44:44.8580493Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2023-05-11T07:44:44.8580493Z", + "targetDedicatedNodes": 2 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 2, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "upgradePolicy": { + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": true + }, + "mode": "automatic" + }, + "vmSize": "STANDARD_D4S_V3" + } + }, + "headers": { + "ETag": "W/\"0x8DB51E64D3C3B69\"" + } + } + }, + "operationId": "Pool_Get", + "title": "GetPool - VirtualMachineConfiguration ServiceArtifactReference" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolList.json new file mode 100644 index 000000000000..bdd02aed26bb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolList.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "applicationPackages": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Enabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "backendPort": 12001, + "frontendPortRangeEnd": 15100, + "frontendPortRangeStart": 15000, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "priority": 150, + "sourceAddressPrefix": "192.100.12.45", + "sourcePortRanges": [ + "*" + ] + }, + { + "access": "Deny", + "priority": 3500, + "sourceAddressPrefix": "*", + "sourcePortRanges": [ + "*" + ] + } + ], + "protocol": "TCP" + } + ] + }, + "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123" + }, + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "errors": [ + { + "code": "AllocationTimedout", + "message": "Desired number of dedicated nodes could not be allocated as the resize timeout was reached" + } + ], + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28 + } + }, + "startTask": { + "commandLine": "cmd /c SET", + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "maxTaskRetryCount": 6, + "resourceFiles": [ + { + "fileMode": "777", + "filePath": "c:\\temp\\gohere", + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file" + } + ], + "userIdentity": { + "autoUser": { + "elevationLevel": "Admin", + "scope": "Pool" + } + }, + "waitForSuccess": true + }, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "taskSlotsPerNode": 13, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "gid": 4567, + "uid": 1234 + } + } + ], + "vmSize": "STANDARD_D4" + } + } + ] + } + } + }, + "operationId": "Pool_ListByBatchAccount", + "title": "ListPool" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolListWithFilter.json new file mode 100644 index 000000000000..a3377bcae2f7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "$filter": "startswith(name, 'po') or (properties/allocationState eq 'Steady' and properties/provisioningStateTransitionTime lt datetime'2017-02-02')", + "$select": "properties/allocationState,properties/provisioningStateTransitionTime,properties/currentDedicatedNodes,properties/currentLowPriorityNodes", + "accountName": "sampleacct", + "api-version": "2025-06-01", + "maxResults": "50", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 2, + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z" + } + }, + { + "name": "pooltest", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/pooltest", + "properties": { + "allocationState": "Resizing", + "currentDedicatedNodes": 4, + "currentLowPriorityNodes": 0, + "provisioningStateTransitionTime": "2017-08-26T10:22:55.9407275Z" + } + } + ] + } + } + }, + "operationId": "Pool_ListByBatchAccount", + "title": "ListPoolWithFilter" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolStopResize.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolStopResize.json new file mode 100644 index 000000000000..9878b66d36f1 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolStopResize.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "18.04-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 18.04" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT10M", + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 1 + }, + "scaleSettings": { + "fixedScale": { + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_StopResize", + "title": "StopPoolResize" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_EnableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_EnableAutoScale.json new file mode 100644 index 000000000000..0d6fe825015b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_EnableAutoScale.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=34" + } + } + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-29T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34 + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT15M", + "formula": "$TargetDedicated=34" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Update", + "title": "UpdatePool - Enable Autoscale" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_OtherProperties.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_OtherProperties.json new file mode 100644 index 000000000000..7299561d10ba --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_OtherProperties.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "applicationPackages": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ] + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "applicationPackages": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-29T10:22:55.9407275Z", + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ], + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8 + }, + "scaleSettings": { + "fixedScale": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Update", + "title": "UpdatePool - Other Properties" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_RemoveStartTask.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_RemoveStartTask.json new file mode 100644 index 000000000000..ca679399f76e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_RemoveStartTask.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "startTask": {} + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-29T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M", + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34 + }, + "scaleSettings": { + "autoScale": { + "evaluationInterval": "PT15M", + "formula": "$TargetDedicated=34" + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Update", + "title": "UpdatePool - Remove Start Task" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_ResizePool.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_ResizePool.json new file mode 100644 index 000000000000..9d5221906d04 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PoolUpdate_ResizePool.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "scaleSettings": { + "fixedScale": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0 + } + } + } + }, + "poolName": "testpool", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "creationTime": "2017-08-28T10:22:55.9407275Z", + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "offer": "WindowsServer", + "publisher": "MicrosoftWindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64" + } + }, + "interNodeCommunication": "Disabled", + "lastModified": "2017-08-29T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "resizeOperationStatus": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8 + }, + "scaleSettings": { + "fixedScale": { + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "taskSlotsPerNode": 1, + "vmSize": "STANDARD_D4" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + } + }, + "operationId": "Pool_Update", + "title": "UpdatePool - Resize Pool" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateBatchAccountCreate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateBatchAccountCreate.json new file mode 100644 index 000000000000..7620588d3170 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateBatchAccountCreate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "keyVaultReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "publicNetworkAccess": "Disabled" + } + }, + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "identity": { + "type": "None" + }, + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "keyVaultReference": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + }, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "UserSubscription", + "poolQuota": 20, + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled" + } + } + }, + "202": {} + }, + "operationId": "BatchAccount_Create", + "title": "PrivateBatchAccountCreate" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateBatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateBatchAccountGet.json new file mode 100644 index 000000000000..0161169b1035 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateBatchAccountGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "lastKeySync": "2016-03-10T23:48:38.9878479Z", + "storageAccountId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolAllocationMode": "BatchService", + "poolQuota": 20, + "privateEndpointConnections": [ + { + "name": "testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + } + } + } + ], + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled" + } + } + } + }, + "operationId": "BatchAccount_Get", + "title": "PrivateBatchAccountGet" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionDelete.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..b64b73f6fca7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0/accountOperationResults/sampleacct-30a022cb-a64f-4fd5-9289-8b38b342e9de?api-version=2025-06-01" + } + }, + "204": {} + }, + "operationId": "PrivateEndpointConnection_Delete", + "title": "PrivateEndpointConnectionDelete" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..cd44d77073fc --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "privateEndpointConnectionName": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "properties": { + "groupIds": [ + "batchAccount" + ], + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "PrivateEndpointConnection_Get", + "title": "GetPrivateEndpointConnection" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..a3238485d8c4 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + } + } + }, + "privateEndpointConnectionName": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection5.24d6b4b5-e65c-4330-bbe9-3a290d62f8e0", + "properties": { + "groupIds": [ + "batchAccount" + ], + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + }, + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnectionProxyResults/Updating$testprivateEndpointConnection5.24d6b4b5$e65c-4330-bbe9-3a290d62f8e0-8D4EDFF164A11C9?api-version=2025-06-01", + "Retry-After": "15" + } + } + }, + "operationId": "PrivateEndpointConnection_Update", + "title": "UpdatePrivateEndpointConnection" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionsList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..812d776f1307 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "privateEndpointConnectionName": "testprivateEndpointConnection", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testprivateEndpointConnection", + "type": "Microsoft.Batch/batchAccounts/privateEndpointConnections", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateEndpointConnections/testprivateEndpointConnection", + "properties": { + "groupIds": [ + "batchAccount" + ], + "privateEndpoint": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Network/privateEndpoints/testprivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "Approved by xyz.abc@company.com", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnection_ListByBatchAccount", + "title": "ListPrivateEndpointConnections" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateLinkResourceGet.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..9f8f26231699 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateLinkResourceGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "privateLinkResourceName": "batchAccount", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + } + }, + "operationId": "PrivateLinkResource_Get", + "title": "GetPrivateLinkResource" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateLinkResourcesList.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..2c0ed091f035 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "api-version": "2025-06-01", + "resourceGroupName": "default-azurebatch-japaneast", + "subscriptionId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "batchAccount", + "type": "Microsoft.Batch/batchAccounts/privateLinkResources", + "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/privateLinkResources/batchAccount", + "properties": { + "groupId": "batchAccount", + "requiredMembers": [ + "batchAccount" + ], + "requiredZoneNames": [ + "privatelink.japaneast.batch.azure.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResource_ListByBatchAccount", + "title": "ListPrivateLinkResource" +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/openapi.json b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/openapi.json new file mode 100644 index 000000000000..66e3aca5bb5c --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/stable/2025-06-01/openapi.json @@ -0,0 +1,7063 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchManagementClient", + "version": "2025-06-01", + "description": "The Batch Management Client.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "BatchAccount" + }, + { + "name": "DetectorResponses" + }, + { + "name": "ApplicationPackage" + }, + { + "name": "Application" + }, + { + "name": "PrivateLinkResource" + }, + { + "name": "PrivateEndpointConnection" + }, + { + "name": "Pool" + }, + { + "name": "NetworkSecurityPerimeter" + }, + { + "name": "Location" + } + ], + "paths": { + "/providers/Microsoft.Batch/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "Lists available operations for the Microsoft.Batch provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts": { + "get": { + "operationId": "BatchAccount_List", + "tags": [ + "BatchAccount" + ], + "description": "Gets information about the Batch accounts associated with the subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountList": { + "$ref": "./examples/BatchAccountList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability": { + "post": { + "operationId": "Location_CheckNameAvailability", + "tags": [ + "Location" + ], + "description": "Checks whether the Batch account name is available in the specified region.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "The desired region for the name check.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Properties needed to check the availability of a name.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LocationCheckNameAvailability_AlreadyExists": { + "$ref": "./examples/LocationCheckNameAvailability_AlreadyExists.json" + }, + "LocationCheckNameAvailability_Available": { + "$ref": "./examples/LocationCheckNameAvailability_Available.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas": { + "get": { + "operationId": "Location_GetQuotas", + "tags": [ + "Location" + ], + "description": "Gets the Batch service quotas for the specified subscription at the given location.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "The region for which to retrieve Batch service quotas.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchLocationQuota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LocationGetQuotas": { + "$ref": "./examples/LocationGetQuotas.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/virtualMachineSkus": { + "get": { + "operationId": "Location_ListSupportedVirtualMachineSkus", + "tags": [ + "Location" + ], + "description": "Gets the list of Batch supported Virtual Machine VM sizes available at the given location.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "The region for which to retrieve Batch service supported SKUs.", + "required": true, + "type": "string" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are \"familyName\".", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportedSkusResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LocationListVirtualMachineSkus": { + "$ref": "./examples/LocationListVirtualMachineSkus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts": { + "get": { + "operationId": "BatchAccount_ListByResourceGroup", + "tags": [ + "BatchAccount" + ], + "description": "Gets information about the Batch accounts associated with the specified resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountListByResourceGroup": { + "$ref": "./examples/BatchAccountListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}": { + "get": { + "operationId": "BatchAccount_Get", + "tags": [ + "BatchAccount" + ], + "description": "Gets information about the specified Batch account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountGet": { + "$ref": "./examples/BatchAccountGet.json" + }, + "PrivateBatchAccountGet": { + "$ref": "./examples/PrivateBatchAccountGet.json" + } + } + }, + "put": { + "operationId": "BatchAccount_Create", + "tags": [ + "BatchAccount" + ], + "description": "Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Additional parameters for account creation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountCreateParameters" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BatchAccount' update operation succeeded", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountCreate_BYOS": { + "$ref": "./examples/BatchAccountCreate_BYOS.json" + }, + "BatchAccountCreate_Default": { + "$ref": "./examples/BatchAccountCreate_Default.json" + }, + "BatchAccountCreate_SystemAssignedIdentity": { + "$ref": "./examples/BatchAccountCreate_SystemAssignedIdentity.json" + }, + "BatchAccountCreate_UserAssignedIdentity": { + "$ref": "./examples/BatchAccountCreate_UserAssignedIdentity.json" + }, + "PrivateBatchAccountCreate": { + "$ref": "./examples/PrivateBatchAccountCreate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/BatchAccount" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "BatchAccount_Update", + "tags": [ + "BatchAccount" + ], + "description": "Updates the properties of an existing Batch account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "Additional parameters for account update.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountUpdate": { + "$ref": "./examples/BatchAccountUpdate.json" + } + } + }, + "delete": { + "operationId": "BatchAccount_Delete", + "tags": [ + "BatchAccount" + ], + "description": "Deletes the specified Batch account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountDelete": { + "$ref": "./examples/BatchAccountDelete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications": { + "get": { + "operationId": "Application_List", + "tags": [ + "Application" + ], + "description": "Lists all of the applications in the specified account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListApplicationsResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationList": { + "$ref": "./examples/ApplicationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}": { + "get": { + "operationId": "Application_Get", + "tags": [ + "Application" + ], + "description": "Gets information about the specified application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationGet": { + "$ref": "./examples/ApplicationGet.json" + } + } + }, + "put": { + "operationId": "Application_Create", + "tags": [ + "Application" + ], + "description": "Adds an application to the specified Batch account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for the request.", + "required": false, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Application' update operation succeeded", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationCreate": { + "$ref": "./examples/ApplicationCreate.json" + } + } + }, + "patch": { + "operationId": "Application_Update", + "tags": [ + "Application" + ], + "description": "Updates settings for the specified application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for the request.", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationUpdate": { + "$ref": "./examples/ApplicationUpdate.json" + } + } + }, + "delete": { + "operationId": "Application_Delete", + "tags": [ + "Application" + ], + "description": "Deletes an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationDelete": { + "$ref": "./examples/ApplicationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions": { + "get": { + "operationId": "ApplicationPackage_List", + "tags": [ + "ApplicationPackage" + ], + "description": "Lists all of the application packages in the specified application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListApplicationPackagesResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationPackageList": { + "$ref": "./examples/ApplicationPackageList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}": { + "get": { + "operationId": "ApplicationPackage_Get", + "tags": [ + "ApplicationPackage" + ], + "description": "Gets information about the specified application package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "versionName", + "in": "path", + "description": "The version of the application.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationPackageGet": { + "$ref": "./examples/ApplicationPackageGet.json" + } + } + }, + "put": { + "operationId": "ApplicationPackage_Create", + "tags": [ + "ApplicationPackage" + ], + "description": "Creates an application package record. The record contains a storageUrl where the package should be uploaded to. Once it is uploaded the `ApplicationPackage` needs to be activated using `ApplicationPackageActive` before it can be used. If the auto storage account was configured to use storage keys, the URL returned will contain a SAS.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "versionName", + "in": "path", + "description": "The version of the application.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for the request.", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApplicationPackage' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationPackageCreate": { + "$ref": "./examples/ApplicationPackageCreate.json" + } + } + }, + "delete": { + "operationId": "ApplicationPackage_Delete", + "tags": [ + "ApplicationPackage" + ], + "description": "Deletes an application package record and its associated binary file.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "versionName", + "in": "path", + "description": "The version of the application.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationPackageDelete": { + "$ref": "./examples/ApplicationPackageDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate": { + "post": { + "operationId": "ApplicationPackage_Activate", + "tags": [ + "ApplicationPackage" + ], + "description": "Activates the specified application package. This should be done after the `ApplicationPackage` was created and uploaded. This needs to be done before an `ApplicationPackage` can be used on Pools or Tasks.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "versionName", + "in": "path", + "description": "The version of the application.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for the request.", + "required": true, + "schema": { + "$ref": "#/definitions/ActivateApplicationPackageParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ApplicationPackageActivate": { + "$ref": "./examples/ApplicationPackageActivate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors": { + "get": { + "operationId": "BatchAccount_ListDetectors", + "tags": [ + "DetectorResponses" + ], + "description": "Gets information about the detectors available for a given Batch account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DetectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListDetectors": { + "$ref": "./examples/DetectorList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/detectors/{detectorId}": { + "get": { + "operationId": "BatchAccount_GetDetector", + "tags": [ + "DetectorResponses" + ], + "description": "Gets information about the given detector for a given Batch account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "detectorId", + "in": "path", + "description": "The name of the detector.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DetectorResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetDetector": { + "$ref": "./examples/DetectorGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys": { + "post": { + "operationId": "BatchAccount_GetKeys", + "tags": [ + "BatchAccount" + ], + "summary": "Gets the account keys for the specified Batch account.", + "description": "This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, getting the keys will fail.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BatchAccountKeys" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountGetKeys": { + "$ref": "./examples/BatchAccountGetKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/networkSecurityPerimeterConfigurations": { + "get": { + "operationId": "NetworkSecurityPerimeter_ListConfigurations", + "tags": [ + "NetworkSecurityPerimeter" + ], + "description": "Lists all of the NSP configurations in the specified account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfigurationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListNspConfigurations": { + "$ref": "./examples/NspConfigurationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}": { + "get": { + "operationId": "NetworkSecurityPerimeter_GetConfiguration", + "tags": [ + "NetworkSecurityPerimeter" + ], + "description": "Gets information about the specified NSP configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "networkSecurityPerimeterConfigurationName", + "in": "path", + "description": "The name for a network security perimeter configuration", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 512 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/networksecurityperimeter.json#/definitions/NetworkSecurityPerimeterConfiguration" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetNspConfiguration": { + "$ref": "./examples/NspConfigurationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile": { + "post": { + "operationId": "NetworkSecurityPerimeter_ReconcileConfiguration", + "tags": [ + "NetworkSecurityPerimeter" + ], + "description": "Reconciles the specified NSP configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "networkSecurityPerimeterConfigurationName", + "in": "path", + "description": "The name for a network security perimeter configuration", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 512 + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ReconcileNspConfiguration": { + "$ref": "./examples/NspConfigurationReconcile.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "BatchAccount_ListOutboundNetworkDependenciesEndpoints", + "tags": [ + "BatchAccount" + ], + "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://learn.microsoft.com/azure/batch/batch-virtual-network.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListOutboundNetworkDependencies": { + "$ref": "./examples/BatchAccountListOutboundNetworkDependenciesEndpoints.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools": { + "get": { + "operationId": "Pool_ListByBatchAccount", + "tags": [ + "Pool" + ], + "description": "Lists all of the pools in the specified account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$select", + "in": "query", + "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are:\n\nname\nproperties/allocationState\nproperties/allocationStateTransitionTime\nproperties/creationTime\nproperties/provisioningState\nproperties/provisioningStateTransitionTime\nproperties/lastModified\nproperties/vmSize\nproperties/interNodeCommunication\nproperties/scaleSettings/autoScale\nproperties/scaleSettings/fixedScale", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListPoolsResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListPool": { + "$ref": "./examples/PoolList.json" + }, + "ListPoolWithFilter": { + "$ref": "./examples/PoolListWithFilter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}": { + "get": { + "operationId": "Pool_Get", + "tags": [ + "Pool" + ], + "description": "Gets information about the specified pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "poolName", + "in": "path", + "description": "The pool name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetPool": { + "$ref": "./examples/PoolGet.json" + }, + "GetPool - AcceleratedNetworking": { + "$ref": "./examples/PoolGet_AcceleratedNetworking.json" + }, + "GetPool - SecurityProfile": { + "$ref": "./examples/PoolGet_SecurityProfile.json" + }, + "GetPool - UpgradePolicy": { + "$ref": "./examples/PoolGet_UpgradePolicy.json" + }, + "GetPool - VirtualMachineConfiguration Extensions": { + "$ref": "./examples/PoolGet_VirtualMachineConfiguration_Extensions.json" + }, + "GetPool - VirtualMachineConfiguration OSDisk": { + "$ref": "./examples/PoolGet_VirtualMachineConfiguration_MangedOSDisk.json" + }, + "GetPool - VirtualMachineConfiguration ServiceArtifactReference": { + "$ref": "./examples/PoolGet_VirtualMachineConfiguration_ServiceArtifactReference.json" + } + } + }, + "put": { + "operationId": "Pool_Create", + "tags": [ + "Pool" + ], + "description": "Creates a new pool inside the specified account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "poolName", + "in": "path", + "description": "The pool name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "The entity state (ETag) version of the pool to update. A value of \"*\" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied.", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Additional parameters for pool creation.", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreatePool - Custom Image": { + "$ref": "./examples/PoolCreate_SharedImageGallery.json" + }, + "CreatePool - Full VirtualMachineConfiguration": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration.json" + }, + "CreatePool - Minimal VirtualMachineConfiguration": { + "$ref": "./examples/PoolCreate_MinimalVirtualMachineConfiguration.json" + }, + "CreatePool - No public IP": { + "$ref": "./examples/PoolCreate_NoPublicIPAddresses.json" + }, + "CreatePool - Public IPs": { + "$ref": "./examples/PoolCreate_PublicIPs.json" + }, + "CreatePool - SecurityProfile": { + "$ref": "./examples/PoolCreate_SecurityProfile.json" + }, + "CreatePool - Tags": { + "$ref": "./examples/PoolCreate_Tags.json" + }, + "CreatePool - UpgradePolicy": { + "$ref": "./examples/PoolCreate_UpgradePolicy.json" + }, + "CreatePool - UserAssignedIdentities": { + "$ref": "./examples/PoolCreate_UserAssignedIdentities.json" + }, + "CreatePool - VirtualMachineConfiguration Extensions": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_Extensions.json" + }, + "CreatePool - VirtualMachineConfiguration OSDisk": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_ManagedOSDisk.json" + }, + "CreatePool - VirtualMachineConfiguration ServiceArtifactReference": { + "$ref": "./examples/PoolCreate_VirtualMachineConfiguration_ServiceArtifactReference.json" + }, + "CreatePool - accelerated networking": { + "$ref": "./examples/PoolCreate_AcceleratedNetworking.json" + }, + "CreatePool - confidential disk encryption set for user subscription accounts": { + "$ref": "./examples/PoolCreate_ConfidentialDiskEncryptionSet_ForUserSubscriptionAccounts.json" + }, + "CreatePool - customer managed key for Batch managed accounts": { + "$ref": "./examples/PoolCreate_CustomerManagedKey_ForBatchManagedAccounts.json" + }, + "CreatePool - disk encryption set for user subscription accounts": { + "$ref": "./examples/PoolCreate_DiskEncryptionSet_ForUserSubscriptionAccounts.json" + }, + "CreatePool - dual stack networking": { + "$ref": "./examples/PoolCreate_DualStackNetworking.json" + } + } + }, + "patch": { + "operationId": "Pool_Update", + "tags": [ + "Pool" + ], + "description": "Updates the properties of an existing pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "poolName", + "in": "path", + "description": "The pool name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + }, + { + "name": "If-Match", + "in": "header", + "description": "The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdatePool - Enable Autoscale": { + "$ref": "./examples/PoolUpdate_EnableAutoScale.json" + }, + "UpdatePool - Other Properties": { + "$ref": "./examples/PoolUpdate_OtherProperties.json" + }, + "UpdatePool - Remove Start Task": { + "$ref": "./examples/PoolUpdate_RemoveStartTask.json" + }, + "UpdatePool - Resize Pool": { + "$ref": "./examples/PoolUpdate_ResizePool.json" + } + } + }, + "delete": { + "operationId": "Pool_Delete", + "tags": [ + "Pool" + ], + "description": "Deletes the specified pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "poolName", + "in": "path", + "description": "The pool name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeletePool": { + "$ref": "./examples/PoolDelete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale": { + "post": { + "operationId": "Pool_DisableAutoScale", + "tags": [ + "Pool" + ], + "description": "Disables automatic scaling for a pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "poolName", + "in": "path", + "description": "The pool name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Disable AutoScale": { + "$ref": "./examples/PoolDisableAutoScale.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize": { + "post": { + "operationId": "Pool_StopResize", + "tags": [ + "Pool" + ], + "summary": "Stops an ongoing resize operation on the pool.", + "description": "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "poolName", + "in": "path", + "description": "The pool name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StopPoolResize": { + "$ref": "./examples/PoolStopResize.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnection_ListByBatchAccount", + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Lists all of the private endpoint connections in the specified account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListPrivateEndpointConnectionsResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListPrivateEndpointConnections": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnection_Get", + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Gets information about the specified private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The private endpoint connection name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 101, + "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetPrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + } + }, + "patch": { + "operationId": "PrivateEndpointConnection_Update", + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Updates the properties of an existing private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The private endpoint connection name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 101, + "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$" + }, + { + "name": "If-Match", + "in": "header", + "description": "The state (ETag) version of the private endpoint connection to update. This value can be omitted or set to \"*\" to apply the operation unconditionally.", + "required": false, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "PrivateEndpointConnection properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "A link to the status monitor" + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdatePrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/PrivateEndpointConnection" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PrivateEndpointConnection_Delete", + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Deletes the specified private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The private endpoint connection name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 101, + "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "A link to the status monitor" + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionDelete": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResource_ListByBatchAccount", + "tags": [ + "PrivateLinkResource" + ], + "description": "Lists all of the private link resources in the specified account.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ListPrivateLinkResourcesResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListPrivateLinkResource": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResource_Get", + "tags": [ + "PrivateLinkResource" + ], + "description": "Gets information about the specified private link resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "The private link resource name. This must be unique within the account.", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 101, + "pattern": "^[a-zA-Z0-9_-]+\\.?[a-fA-F0-9-]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetPrivateLinkResource": { + "$ref": "./examples/PrivateLinkResourceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys": { + "post": { + "operationId": "BatchAccount_RegenerateKey", + "tags": [ + "BatchAccount" + ], + "summary": "Regenerates the specified account key for the Batch account.", + "description": "This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + }, + { + "name": "parameters", + "in": "body", + "description": "The type of key to regenerate.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountRegenerateKeyParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BatchAccountKeys" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountRegenerateKey": { + "$ref": "./examples/BatchAccountRegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys": { + "post": { + "operationId": "BatchAccount_SynchronizeAutoStorageKeys", + "tags": [ + "BatchAccount" + ], + "description": "Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]+$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BatchAccountSynchronizeAutoStorageKeys": { + "$ref": "./examples/BatchAccountSynchronizeAutoStorageKeys.json" + } + } + } + } + }, + "definitions": { + "AccountKeyType": { + "type": "string", + "description": "The type of account key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AccountKeyType", + "modelAsString": false, + "values": [ + { + "name": "Primary", + "value": "Primary", + "description": "The primary account key." + }, + { + "name": "Secondary", + "value": "Secondary", + "description": "The secondary account key." + } + ] + } + }, + "ActivateApplicationPackageParameters": { + "type": "object", + "description": "Parameters for an activating an application package.", + "properties": { + "format": { + "type": "string", + "description": "The format of the application package binary file." + } + }, + "required": [ + "format" + ] + }, + "AllocationState": { + "type": "string", + "description": "Whether the pool is resizing.", + "enum": [ + "Steady", + "Resizing", + "Stopping" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": false, + "values": [ + { + "name": "Steady", + "value": "Steady", + "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes." + }, + { + "name": "Resizing", + "value": "Resizing", + "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool." + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] + } + }, + "Application": { + "type": "object", + "description": "Contains information about an application in a Batch account.", + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationProperties", + "description": "The properties associated with the Application.", + "x-ms-client-flatten": true + }, + "etag": { + "type": "string", + "description": "The ETag of the resource, used for concurrency statements.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "The tags of the resource.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApplicationPackage": { + "type": "object", + "description": "An application package which represents a particular version of an application.", + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationPackageProperties", + "description": "The properties associated with the Application Package.", + "x-ms-client-flatten": true + }, + "etag": { + "type": "string", + "description": "The ETag of the resource, used for concurrency statements.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "The tags of the resource.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ApplicationPackageProperties": { + "type": "object", + "description": "Properties of an application package", + "properties": { + "state": { + "$ref": "#/definitions/PackageState", + "description": "The current state of the application package.", + "readOnly": true + }, + "format": { + "type": "string", + "description": "The format of the application package, if the package is active.", + "readOnly": true + }, + "storageUrl": { + "type": "string", + "description": "The URL for the application package in Azure Storage.", + "readOnly": true + }, + "storageUrlExpiry": { + "type": "string", + "format": "date-time", + "description": "The UTC time at which the Azure Storage URL will expire.", + "readOnly": true + }, + "lastActivationTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the package was last activated, if the package is active.", + "readOnly": true + } + } + }, + "ApplicationPackageReference": { + "type": "object", + "title": "Link to an application package inside the batch account", + "description": "Link to an application package inside the batch account", + "properties": { + "id": { + "type": "string", + "title": "The ID of the application package to install. This must be inside the same Batch account as the pool. This can either be a reference to a specific version or the default version if one exists.", + "description": "The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists." + }, + "version": { + "type": "string", + "title": "The version of the application to deploy. If omitted, the default version is deployed.", + "description": "If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409." + } + }, + "required": [ + "id" + ] + }, + "ApplicationProperties": { + "type": "object", + "description": "The properties associated with the Application.", + "properties": { + "displayName": { + "type": "string", + "description": "The display name for the application." + }, + "allowUpdates": { + "type": "boolean", + "description": "A value indicating whether packages within the application may be overwritten using the same version string." + }, + "defaultVersion": { + "type": "string", + "description": "The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package." + } + } + }, + "AuthenticationMode": { + "type": "string", + "description": "The authentication mode for the Batch account.", + "enum": [ + "SharedKey", + "AAD", + "TaskAuthenticationToken" + ], + "x-ms-enum": { + "name": "AuthenticationMode", + "modelAsString": false, + "values": [ + { + "name": "SharedKey", + "value": "SharedKey", + "description": "The authentication mode using shared keys." + }, + { + "name": "AAD", + "value": "AAD", + "description": "The authentication mode using Microsoft Entra ID." + }, + { + "name": "TaskAuthenticationToken", + "value": "TaskAuthenticationToken", + "description": "The authentication mode using task authentication tokens." + } + ] + } + }, + "AutoScaleRun": { + "type": "object", + "title": "The results and errors from an execution of a pool autoscale formula.", + "description": "The results and errors from an execution of a pool autoscale formula.", + "properties": { + "evaluationTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the autoscale formula was last evaluated.", + "description": "The time at which the autoscale formula was last evaluated." + }, + "results": { + "type": "string", + "title": "The final values of all variables used in the evaluation of the autoscale formula.", + "description": "Each variable value is returned in the form $variable=value, and variables are separated by semicolons." + }, + "error": { + "$ref": "#/definitions/AutoScaleRunError", + "title": "Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful.", + "description": "An error that occurred when autoscaling a pool." + } + }, + "required": [ + "evaluationTime" + ] + }, + "AutoScaleRunError": { + "type": "object", + "title": "An error that occurred when autoscaling a pool.", + "description": "An error that occurred when autoscaling a pool.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "title": "Additional details about the error.", + "description": "Additional details about the error.", + "items": { + "$ref": "#/definitions/AutoScaleRunError" + }, + "x-ms-identifiers": [ + "code" + ] + } + }, + "required": [ + "code", + "message" + ] + }, + "AutoScaleSettings": { + "type": "object", + "title": "AutoScale settings for the pool.", + "description": "AutoScale settings for the pool.", + "properties": { + "formula": { + "type": "string", + "title": "A formula for the desired number of compute nodes in the pool.", + "description": "A formula for the desired number of compute nodes in the pool.", + "externalDocs": { + "description": "Create an automatic scaling formula for scaling compute nodes in a Batch pool", + "url": "https://learn.microsoft.com/azure/batch/batch-automatic-scaling" + } + }, + "evaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", + "description": "If omitted, the default value is 15 minutes (PT15M)." + } + }, + "required": [ + "formula" + ] + }, + "AutoStorageBaseProperties": { + "type": "object", + "description": "The properties related to the auto-storage account.", + "properties": { + "storageAccountId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the storage account to be used for auto-storage account.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "authenticationMode": { + "type": "string", + "description": "The authentication mode which the Batch service will use to manage the auto-storage account.", + "default": "StorageKeys", + "enum": [ + "StorageKeys", + "BatchAccountManagedIdentity" + ], + "x-ms-enum": { + "name": "AutoStorageAuthenticationMode", + "modelAsString": false, + "values": [ + { + "name": "StorageKeys", + "value": "StorageKeys", + "description": "The Batch service will authenticate requests to auto-storage using storage account keys." + }, + { + "name": "BatchAccountManagedIdentity", + "value": "BatchAccountManagedIdentity", + "description": "The Batch service will authenticate requests to auto-storage using the managed identity assigned to the Batch account." + } + ] + } + }, + "nodeIdentityReference": { + "$ref": "#/definitions/ComputeNodeIdentityReference", + "title": "The reference to the user assigned identity which compute nodes will use to access auto-storage.", + "description": "The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage." + } + }, + "required": [ + "storageAccountId" + ] + }, + "AutoStorageProperties": { + "type": "object", + "description": "Contains information about the auto-storage account associated with a Batch account.", + "properties": { + "lastKeySync": { + "type": "string", + "format": "date-time", + "description": "The UTC time at which storage keys were last synchronized with the Batch account." + } + }, + "required": [ + "lastKeySync" + ], + "allOf": [ + { + "$ref": "#/definitions/AutoStorageBaseProperties" + } + ] + }, + "AutoUserScope": { + "type": "string", + "description": "The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks.", + "enum": [ + "Task", + "Pool" + ], + "x-ms-enum": { + "name": "AutoUserScope", + "modelAsString": false, + "values": [ + { + "name": "Task", + "value": "Task", + "description": "Specifies that the service should create a new user for the task." + }, + { + "name": "Pool", + "value": "Pool", + "description": "Specifies that the task runs as the common auto user account which is created on every node in a pool." + } + ] + } + }, + "AutoUserSpecification": { + "type": "object", + "title": "Specifies the parameters for the auto user that runs a task on the Batch service.", + "description": "Specifies the parameters for the auto user that runs a task on the Batch service.", + "properties": { + "scope": { + "$ref": "#/definitions/AutoUserScope", + "title": "The scope for the auto user", + "description": "The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks." + }, + "elevationLevel": { + "$ref": "#/definitions/ElevationLevel", + "title": "The elevation level of the user.", + "description": "The default value is nonAdmin." + } + } + }, + "AutomaticOSUpgradePolicy": { + "type": "object", + "description": "The configuration parameters used for performing automatic OS upgrade.", + "properties": { + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled." + }, + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true." + }, + "useRollingUpgradePolicy": { + "type": "boolean", + "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS." + }, + "osRollingUpgradeDeferral": { + "type": "boolean", + "description": "Defer OS upgrades on the TVMs if they are running tasks." + } + } + }, + "AzureBlobFileSystemConfiguration": { + "type": "object", + "title": "Information used to connect to an Azure Storage Container using Blobfuse.", + "description": "Information used to connect to an Azure Storage Container using Blobfuse.", + "properties": { + "accountName": { + "type": "string", + "title": "The Azure Storage Account name.", + "description": "The Azure Storage Account name." + }, + "containerName": { + "type": "string", + "title": "The Azure Blob Storage Container name.", + "description": "The Azure Blob Storage Container name." + }, + "accountKey": { + "type": "string", + "format": "password", + "title": "The Azure Storage Account key.", + "description": "This property is mutually exclusive with both sasKey and identity; exactly one must be specified.", + "x-ms-secret": true + }, + "sasKey": { + "type": "string", + "format": "password", + "title": "The Azure Storage SAS token.", + "description": "This property is mutually exclusive with both accountKey and identity; exactly one must be specified.", + "x-ms-secret": true + }, + "blobfuseOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "identityReference": { + "$ref": "#/definitions/ComputeNodeIdentityReference", + "title": "The reference to the user assigned identity to use to access containerName", + "description": "This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified." + } + }, + "required": [ + "accountName", + "containerName", + "relativeMountPath" + ] + }, + "AzureFileShareConfiguration": { + "type": "object", + "title": "Information used to connect to an Azure Fileshare.", + "description": "Information used to connect to an Azure Fileshare.", + "properties": { + "accountName": { + "type": "string", + "title": "The Azure Storage account name.", + "description": "The Azure Storage account name." + }, + "azureFileUrl": { + "type": "string", + "title": "The Azure Files URL.", + "description": "This is of the form 'https://{account}.file.core.windows.net/'." + }, + "accountKey": { + "type": "string", + "format": "password", + "title": "The Azure Storage account key.", + "description": "The Azure Storage account key.", + "x-ms-secret": true + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "accountName", + "azureFileUrl", + "accountKey", + "relativeMountPath" + ] + }, + "BatchAccount": { + "type": "object", + "description": "Contains information about an Azure Batch account.", + "properties": { + "properties": { + "$ref": "#/definitions/BatchAccountProperties", + "description": "The properties associated with the account.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "BatchAccountCreateParameters": { + "type": "object", + "description": "Parameters supplied to the Create operation.", + "properties": { + "location": { + "type": "string", + "description": "The region in which to create the account." + }, + "tags": { + "type": "object", + "description": "The user-specified tags associated with the account.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/BatchAccountCreateProperties", + "description": "The properties of the Batch account.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + }, + "required": [ + "location" + ] + }, + "BatchAccountCreateProperties": { + "type": "object", + "description": "The properties of a Batch account.", + "properties": { + "autoStorage": { + "$ref": "#/definitions/AutoStorageBaseProperties", + "description": "The properties related to the auto-storage account." + }, + "poolAllocationMode": { + "$ref": "#/definitions/PoolAllocationMode", + "title": "The allocation mode to use for creating pools in the Batch account.", + "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService." + }, + "keyVaultReference": { + "$ref": "#/definitions/KeyVaultReference", + "description": "A reference to the Azure key vault associated with the Batch account." + }, + "publicNetworkAccess": { + "type": "string", + "title": "The network access type for accessing Azure Batch account.", + "description": "The network access type for operating on the resources in the Batch account.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": false, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enables connectivity to Azure Batch through public DNS." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource." + }, + { + "name": "SecuredByPerimeter", + "value": "SecuredByPerimeter", + "description": "Secures connectivity to Azure Batch through NSP configuration." + } + ] + } + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "title": "Network profile for Batch account, which contains network rule settings for each endpoint.", + "description": "The network profile only takes effect when publicNetworkAccess is enabled." + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead." + }, + "allowedAuthenticationModes": { + "type": "array", + "description": "List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/AuthenticationMode" + } + } + } + }, + "BatchAccountIdentity": { + "type": "object", + "description": "The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity` is selected as the auto-storage authentication mode.", + "properties": { + "principalId": { + "type": "string", + "description": "The principal id of the Batch account. This property will only be provided for a system assigned identity.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenant id associated with the Batch account. This property will only be provided for a system assigned identity.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/ResourceIdentityType", + "description": "The type of identity used for the Batch account." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the Batch account.", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentities" + } + } + }, + "required": [ + "type" + ] + }, + "BatchAccountKeys": { + "type": "object", + "description": "A set of Azure Batch account keys.", + "properties": { + "accountName": { + "type": "string", + "description": "The Batch account name.", + "readOnly": true + }, + "primary": { + "type": "string", + "description": "The primary key associated with the account.", + "readOnly": true + }, + "secondary": { + "type": "string", + "description": "The secondary key associated with the account.", + "readOnly": true + } + } + }, + "BatchAccountListResult": { + "type": "object", + "description": "Paged collection of BatchAccount items", + "properties": { + "value": { + "type": "array", + "description": "The BatchAccount items on this page", + "items": { + "$ref": "#/definitions/BatchAccount" + }, + "x-ms-identifiers": [ + "/properties/accountEndpoint" + ] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BatchAccountProperties": { + "type": "object", + "description": "Account specific properties.", + "properties": { + "accountEndpoint": { + "type": "string", + "description": "The account endpoint used to interact with the Batch service.", + "readOnly": true + }, + "nodeManagementEndpoint": { + "type": "string", + "description": "The endpoint used by compute node to connect to the Batch node management service.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioned state of the resource", + "readOnly": true + }, + "poolAllocationMode": { + "$ref": "#/definitions/PoolAllocationMode", + "title": "The allocation mode to use for creating pools in the Batch account.", + "description": "The allocation mode for creating pools in the Batch account.", + "readOnly": true + }, + "keyVaultReference": { + "$ref": "#/definitions/KeyVaultReference", + "title": "A reference to the Azure key vault associated with the Batch account.", + "description": "Identifies the Azure key vault associated with a Batch account.", + "readOnly": true + }, + "publicNetworkAccess": { + "type": "string", + "title": "The network interface type for accessing Azure Batch service and Batch account operations.", + "description": "The network access type for operating on the resources in the Batch account.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": false, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enables connectivity to Azure Batch through public DNS." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource." + }, + { + "name": "SecuredByPerimeter", + "value": "SecuredByPerimeter", + "description": "Secures connectivity to Azure Batch through NSP configuration." + } + ] + }, + "x-nullable": true + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "title": "Network profile for Batch account, which contains network rule settings for each endpoint.", + "description": "The network profile only takes effect when publicNetworkAccess is enabled.", + "x-nullable": true + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connections associated with the Batch account", + "x-nullable": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "autoStorage": { + "$ref": "#/definitions/AutoStorageProperties", + "title": "The properties and status of any auto-storage account associated with the Batch account.", + "description": "Contains information about the auto-storage account associated with a Batch account.", + "readOnly": true + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.", + "readOnly": true + }, + "dedicatedCoreQuota": { + "type": "integer", + "format": "int32", + "title": "The dedicated core quota for the Batch account.", + "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.", + "x-nullable": true, + "readOnly": true + }, + "lowPriorityCoreQuota": { + "type": "integer", + "format": "int32", + "title": "The Spot/low-priority core quota for the Batch account.", + "description": "For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.", + "x-nullable": true, + "readOnly": true + }, + "dedicatedCoreQuotaPerVMFamily": { + "type": "array", + "description": "A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/VirtualMachineFamilyCoreQuota" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "dedicatedCoreQuotaPerVMFamilyEnforced": { + "type": "boolean", + "title": "A value indicating whether core quotas per Virtual Machine family are enforced for this account", + "description": "If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.", + "readOnly": true + }, + "poolQuota": { + "type": "integer", + "format": "int32", + "title": "The pool quota for the Batch account.", + "description": "The pool quota for the Batch account.", + "readOnly": true + }, + "activeJobAndJobScheduleQuota": { + "type": "integer", + "format": "int32", + "title": "The active job and job schedule quota for the Batch account.", + "description": "The active job and job schedule quota for the Batch account.", + "readOnly": true + }, + "allowedAuthenticationModes": { + "type": "array", + "description": "List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/AuthenticationMode" + }, + "readOnly": true + } + } + }, + "BatchAccountRegenerateKeyParameters": { + "type": "object", + "description": "Parameters supplied to the RegenerateKey operation.", + "properties": { + "keyName": { + "$ref": "#/definitions/AccountKeyType", + "description": "The type of account key to regenerate." + } + }, + "required": [ + "keyName" + ] + }, + "BatchAccountUpdateParameters": { + "type": "object", + "description": "Parameters for updating an Azure Batch account.", + "properties": { + "tags": { + "type": "object", + "description": "The user-specified tags associated with the account.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/BatchAccountUpdateProperties", + "description": "The properties of the account.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/BatchAccountIdentity", + "description": "The identity of the Batch account." + } + } + }, + "BatchAccountUpdateProperties": { + "type": "object", + "description": "The properties of a Batch account.", + "properties": { + "autoStorage": { + "$ref": "#/definitions/AutoStorageBaseProperties", + "description": "The properties related to the auto-storage account." + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "title": "The encryption configuration for the Batch account.", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead." + }, + "allowedAuthenticationModes": { + "type": "array", + "description": "List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.", + "x-nullable": true, + "items": { + "$ref": "#/definitions/AuthenticationMode" + } + }, + "publicNetworkAccess": { + "type": "string", + "title": "The network access type for accessing Azure Batch account.", + "description": "The network access type for operating on the resources in the Batch account.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": false, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enables connectivity to Azure Batch through public DNS." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disables public connectivity and enables private connectivity to Azure Batch Service through private endpoint resource." + }, + { + "name": "SecuredByPerimeter", + "value": "SecuredByPerimeter", + "description": "Secures connectivity to Azure Batch through NSP configuration." + } + ] + } + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "title": "Network profile for Batch account, which contains network rule settings for each endpoint.", + "description": "The network profile only takes effect when publicNetworkAccess is enabled." + } + } + }, + "BatchLocationQuota": { + "type": "object", + "description": "Quotas associated with a Batch region for a particular subscription.", + "properties": { + "accountQuota": { + "type": "integer", + "format": "int32", + "description": "The number of Batch accounts that may be created under the subscription in the specified region.", + "readOnly": true + } + } + }, + "BatchPoolIdentity": { + "type": "object", + "description": "The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities", + "properties": { + "type": { + "$ref": "#/definitions/PoolIdentityType", + "description": "The type of identity used for the Batch Pool." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the Batch pool.", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentities" + } + } + }, + "required": [ + "type" + ] + }, + "CIFSMountConfiguration": { + "type": "object", + "title": "Information used to connect to a CIFS file system.", + "description": "Information used to connect to a CIFS file system.", + "properties": { + "userName": { + "type": "string", + "title": "The user to use for authentication against the CIFS file system.", + "description": "The user to use for authentication against the CIFS file system." + }, + "source": { + "type": "string", + "title": "The URI of the file system to mount.", + "description": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + }, + "password": { + "type": "string", + "format": "password", + "title": "The password to use for authentication against the CIFS file system.", + "description": "The password to use for authentication against the CIFS file system.", + "x-ms-secret": true + } + }, + "required": [ + "userName", + "source", + "relativeMountPath", + "password" + ] + }, + "CachingType": { + "type": "string", + "description": "The type of caching to enable for the disk.", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": false, + "values": [ + { + "name": "None", + "value": "None", + "description": "The caching mode for the disk is not enabled." + }, + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "The caching mode for the disk is read only." + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "The caching mode for the disk is read and write." + } + ] + } + }, + "CheckNameAvailabilityParameters": { + "type": "object", + "description": "Parameters for a check name availability request.", + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability" + }, + "type": { + "$ref": "#/definitions/ResourceType", + "description": "The resource type." + } + }, + "required": [ + "name", + "type" + ] + }, + "CheckNameAvailabilityResult": { + "type": "object", + "description": "The CheckNameAvailability operation response.", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/NameAvailabilityReason", + "description": "Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail.", + "readOnly": true + } + } + }, + "CloudError": { + "type": "object", + "description": "An error response from the Batch service.", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The body of the error response." + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "description": "An error response from the Batch service.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "description": "A list of additional details about the error.", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "message", + "target" + ] + } + }, + "x-ms-external": true + }, + "ComputeNodeDeallocationOption": { + "type": "string", + "description": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", + "enum": [ + "Requeue", + "Terminate", + "TaskCompletion", + "RetainedData" + ], + "x-ms-enum": { + "name": "ComputeNodeDeallocationOption", + "modelAsString": false, + "values": [ + { + "name": "Requeue", + "value": "Requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated." + }, + { + "name": "Terminate", + "value": "Terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated." + }, + { + "name": "TaskCompletion", + "value": "TaskCompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed." + }, + { + "name": "RetainedData", + "value": "RetainedData", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired." + } + ] + } + }, + "ComputeNodeIdentityReference": { + "type": "object", + "description": "The reference to a user assigned identity associated with the Batch pool which a compute node will use.", + "properties": { + "resourceId": { + "type": "string", + "description": "The ARM resource id of the user assigned identity." + } + } + }, + "ContainerConfiguration": { + "type": "object", + "title": "The configuration for container-enabled pools.", + "description": "The configuration for container-enabled pools.", + "properties": { + "type": { + "$ref": "#/definitions/ContainerType", + "title": "The container technology to be used.", + "description": "The container technology to be used." + }, + "containerImageNames": { + "type": "array", + "title": "The collection of container image names.", + "description": "This is the full image reference, as would be specified to \"docker pull\". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry.", + "items": { + "type": "string" + } + }, + "containerRegistries": { + "type": "array", + "title": "Additional private registries from which containers can be pulled.", + "description": "If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.", + "items": { + "$ref": "#/definitions/ContainerRegistry" + }, + "x-ms-identifiers": [ + "registryServer" + ] + } + }, + "required": [ + "type" + ] + }, + "ContainerHostBatchBindMountEntry": { + "type": "object", + "title": "The entry of path and mount mode you want to mount into task container.", + "description": "The entry of path and mount mode you want to mount into task container.", + "properties": { + "source": { + "$ref": "#/definitions/ContainerHostDataPath", + "title": "The paths which will be mounted to container task's container.", + "description": "The paths which will be mounted to container task's container." + }, + "isReadOnly": { + "type": "boolean", + "title": "Mount this source path as read-only mode or not. Default value is false (read/write mode).", + "description": "For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path." + } + } + }, + "ContainerHostDataPath": { + "type": "string", + "description": "The paths which will be mounted to container task's container.", + "enum": [ + "Shared", + "Startup", + "VfsMounts", + "Task", + "JobPrep", + "Applications" + ], + "x-ms-enum": { + "name": "ContainerHostDataPath", + "modelAsString": true, + "values": [ + { + "name": "Shared", + "value": "Shared", + "description": "The path for multi-instances task to shared their files." + }, + { + "name": "Startup", + "value": "Startup", + "description": "The path for start task." + }, + { + "name": "VfsMounts", + "value": "VfsMounts", + "description": "The path contains all virtual file systems are mounted on this node." + }, + { + "name": "Task", + "value": "Task", + "description": "The task path." + }, + { + "name": "JobPrep", + "value": "JobPrep", + "description": "The job-prep task path." + }, + { + "name": "Applications", + "value": "Applications", + "description": "The applications path." + } + ] + } + }, + "ContainerRegistry": { + "type": "object", + "title": "A private container registry.", + "description": "A private container registry.", + "properties": { + "username": { + "type": "string", + "title": "The user name to log into the registry server.", + "description": "The user name to log into the registry server.", + "x-ms-client-name": "userName" + }, + "password": { + "type": "string", + "format": "password", + "title": "The password to log into the registry server.", + "description": "The password to log into the registry server.", + "x-ms-secret": true + }, + "registryServer": { + "type": "string", + "title": "The registry URL.", + "description": "If omitted, the default is \"docker.io\"." + }, + "identityReference": { + "$ref": "#/definitions/ComputeNodeIdentityReference", + "title": "The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.", + "description": "The reference to a user assigned identity associated with the Batch pool which a compute node will use." + } + } + }, + "ContainerType": { + "type": "string", + "description": "The container technology to be used.", + "enum": [ + "DockerCompatible", + "CriCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "name": "DockerCompatible", + "value": "DockerCompatible", + "description": "A Docker compatible container technology will be used to launch the containers." + }, + { + "name": "CriCompatible", + "value": "CriCompatible", + "description": "A CRI based technology will be used to launch the containers." + } + ] + } + }, + "ContainerWorkingDirectory": { + "type": "string", + "description": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.", + "enum": [ + "TaskWorkingDirectory", + "ContainerImageDefault" + ], + "x-ms-enum": { + "name": "ContainerWorkingDirectory", + "modelAsString": false, + "values": [ + { + "name": "TaskWorkingDirectory", + "value": "TaskWorkingDirectory", + "description": "Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch." + }, + { + "name": "ContainerImageDefault", + "value": "ContainerImageDefault", + "description": "Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch." + } + ] + } + }, + "DataDisk": { + "type": "object", + "description": "Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.", + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "The type of caching to enable for the disk.", + "description": "Values are:\n\nnone - The caching mode for the disk is not enabled.\nreadOnly - The caching mode for the disk is read only.\nreadWrite - The caching mode for the disk is read and write.\n\nThe default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in GB when creating new data disk.", + "description": "The initial disk size in GB when creating new data disk." + }, + "managedDisk": { + "$ref": "#/definitions/ManagedDisk", + "title": "The managed disk parameters.", + "description": "The managed disk parameters." + } + }, + "required": [ + "lun", + "diskSizeGB" + ] + }, + "DeploymentConfiguration": { + "type": "object", + "title": "Deployment configuration properties.", + "description": "Deployment configuration properties.", + "properties": { + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the pool.", + "description": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure." + } + } + }, + "DetectorListResult": { + "type": "object", + "description": "Paged collection of DetectorResponse items", + "properties": { + "value": { + "type": "array", + "description": "The DetectorResponse items on this page", + "items": { + "$ref": "#/definitions/DetectorResponse" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DetectorResponse": { + "type": "object", + "description": "Contains the information for a detector.", + "properties": { + "properties": { + "$ref": "#/definitions/DetectorResponseProperties", + "description": "The properties associated with the detector.", + "x-ms-client-flatten": true + }, + "etag": { + "type": "string", + "description": "The ETag of the resource, used for concurrency statements.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "The tags of the resource.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DetectorResponseProperties": { + "type": "object", + "description": "Detector response properties.", + "properties": { + "value": { + "type": "string", + "description": "A base64 encoded string that represents the content of a detector." + } + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "The location where the OS disk should be placed.", + "enum": [ + "CacheDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": false, + "values": [ + { + "name": "CacheDisk", + "value": "CacheDisk", + "description": "The OS disk will be placed on the cache disk of the VM." + } + ] + } + }, + "DiffDiskSettings": { + "type": "object", + "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", + "properties": { + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "title": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.", + "description": "This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements." + } + } + }, + "DiskCustomerManagedKey": { + "type": "object", + "description": "The Customer Managed Key reference to encrypt the Disk.", + "properties": { + "keyUrl": { + "type": "string", + "format": "uri", + "description": "Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value." + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false." + }, + "identityReference": { + "$ref": "#/definitions/ComputeNodeIdentityReference", + "description": "The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault." + } + } + }, + "DiskEncryptionConfiguration": { + "type": "object", + "description": "The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Azure Compute Gallery Image.", + "properties": { + "targets": { + "type": "array", + "title": "The list of disk targets Batch Service will encrypt on the compute node", + "description": "On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified.", + "items": { + "$ref": "#/definitions/DiskEncryptionTarget" + } + }, + "customerManagedKey": { + "$ref": "#/definitions/DiskCustomerManagedKey", + "title": "The Customer Managed Key reference to encrypt the OS Disk.", + "description": "Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption." + } + } + }, + "DiskEncryptionSetParameters": { + "type": "object", + "description": "The ARM resource id of the disk encryption set.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "title": "The resource id of the disk encryption set.", + "description": "The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account." + } + }, + "required": [ + "id" + ] + }, + "DiskEncryptionTarget": { + "type": "string", + "description": "If omitted, no disks on the compute nodes in the pool will be encrypted.", + "enum": [ + "OsDisk", + "TemporaryDisk" + ], + "x-ms-enum": { + "name": "DiskEncryptionTarget", + "modelAsString": false, + "values": [ + { + "name": "OsDisk", + "value": "OsDisk", + "description": "The OS Disk on the compute node is encrypted." + }, + { + "name": "TemporaryDisk", + "value": "TemporaryDisk", + "description": "The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time." + } + ] + } + }, + "ElevationLevel": { + "type": "string", + "description": "The elevation level of the user.", + "enum": [ + "NonAdmin", + "Admin" + ], + "x-ms-enum": { + "name": "ElevationLevel", + "modelAsString": false, + "values": [ + { + "name": "NonAdmin", + "value": "NonAdmin", + "description": "The user is a standard user without elevated access." + }, + { + "name": "Admin", + "value": "Admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] + } + }, + "EncryptionProperties": { + "type": "object", + "description": "Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.", + "properties": { + "keySource": { + "$ref": "#/definitions/KeySource", + "description": "Type of the key source." + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Additional details when using Microsoft.KeyVault" + } + } + }, + "EndpointAccessDefaultAction": { + "type": "string", + "description": "Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "EndpointAccessDefaultAction", + "modelAsString": false, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Allow client access." + }, + { + "name": "Deny", + "value": "Deny", + "description": "Deny client access." + } + ] + } + }, + "EndpointAccessProfile": { + "type": "object", + "description": "Network access profile for Batch endpoint.", + "properties": { + "defaultAction": { + "$ref": "#/definitions/EndpointAccessDefaultAction", + "title": "The default action when there is no IPRule matched.", + "description": "Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled." + }, + "ipRules": { + "type": "array", + "description": "Array of IP ranges to filter client IP address.", + "items": { + "$ref": "#/definitions/IPRule" + }, + "x-ms-identifiers": [ + "action" + ] + } + }, + "required": [ + "defaultAction" + ] + }, + "EndpointDependency": { + "type": "object", + "description": "A domain name and connection details used to access a dependency.", + "properties": { + "domainName": { + "type": "string", + "description": "The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Human-readable supplemental information about the dependency and when it is applicable.", + "readOnly": true + }, + "endpointDetails": { + "type": "array", + "description": "The list of connection details for this endpoint.", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "readOnly": true, + "x-ms-identifiers": [ + "port" + ] + } + } + }, + "EndpointDetail": { + "type": "object", + "description": "Details about the connection between the Batch service and the endpoint.", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The port an endpoint is connected to.", + "readOnly": true + } + } + }, + "EnvironmentSetting": { + "type": "object", + "title": "An environment variable to be set on a task process.", + "description": "An environment variable to be set on a task process.", + "properties": { + "name": { + "type": "string", + "title": "The name of the environment variable.", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "title": "The value of the environment variable.", + "description": "The value of the environment variable." + } + }, + "required": [ + "name" + ] + }, + "FixedScaleSettings": { + "type": "object", + "title": "Fixed scale settings for the pool.", + "description": "Fixed scale settings for the pool.", + "properties": { + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool.", + "description": "The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "default": "PT15M" + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool.", + "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of Spot/low-priority compute nodes in the pool.", + "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set." + }, + "nodeDeallocationOption": { + "$ref": "#/definitions/ComputeNodeDeallocationOption", + "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", + "description": "If omitted, the default value is Requeue.", + "x-ms-mutability": [ + "update", + "create" + ] + } + } + }, + "HostEndpointSettings": { + "type": "object", + "description": "Specifies particular host endpoint settings.", + "properties": { + "mode": { + "$ref": "#/definitions/HostEndpointSettingsModeTypes", + "description": "Specifies the access control policy execution mode." + }, + "inVMAccessControlProfileReferenceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies the reference to the InVMAccessControlProfileVersion resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}." + } + } + }, + "HostEndpointSettingsModeTypes": { + "type": "string", + "description": "Specifies the access control policy execution mode.", + "enum": [ + "Audit", + "Enforce" + ], + "x-ms-enum": { + "name": "HostEndpointSettingsModeTypes", + "modelAsString": true, + "values": [ + { + "name": "Audit", + "value": "Audit", + "description": "In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints." + }, + { + "name": "Enforce", + "value": "Enforce", + "description": "Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'." + } + ] + } + }, + "IPAddressProvisioningType": { + "type": "string", + "description": "The provisioning type for Public IP Addresses for the Batch Pool.", + "enum": [ + "BatchManaged", + "UserManaged", + "NoPublicIPAddresses" + ], + "x-ms-enum": { + "name": "IPAddressProvisioningType", + "modelAsString": false, + "values": [ + { + "name": "BatchManaged", + "value": "BatchManaged", + "description": "A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool." + }, + { + "name": "UserManaged", + "value": "UserManaged", + "description": "Public IPs are provided by the user and will be used to provision the Compute Nodes." + }, + { + "name": "NoPublicIPAddresses", + "value": "NoPublicIPAddresses", + "description": "No public IP Address will be created for the Compute Nodes in the Pool." + } + ] + } + }, + "IPFamily": { + "type": "string", + "description": "The IP families used to specify IP versions available to the pool.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPFamily", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "IPv4 is available to the pool." + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "IPv6 is available to the pool." + } + ] + } + }, + "IPRule": { + "type": "object", + "description": "Rule to filter client IP address.", + "properties": { + "action": { + "$ref": "#/definitions/IPRuleAction", + "description": "Action when client IP address is matched." + }, + "value": { + "type": "string", + "title": "The IP address or IP address range to filter", + "description": "IPv4 address, or IPv4 address range in CIDR format." + } + }, + "required": [ + "action", + "value" + ] + }, + "IPRuleAction": { + "type": "string", + "description": "The action when client IP address is matched.", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "IPRuleAction", + "modelAsString": false, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Allow access for the matched client IP address." + } + ] + } + }, + "IPTag": { + "type": "object", + "title": "Specifies how tasks should be distributed across compute nodes.", + "description": "Specifies how tasks should be distributed across compute nodes.", + "properties": { + "ipTagType": { + "type": "string", + "title": "The IP Tag type.", + "description": "Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "title": "The value of the IP tag associated with the public IP.", + "description": "Example: SQL." + } + } + }, + "ImageReference": { + "type": "object", + "title": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.", + "description": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.", + "properties": { + "publisher": { + "type": "string", + "title": "The publisher of the Azure Virtual Machines Marketplace image.", + "description": "For example, Canonical or MicrosoftWindowsServer." + }, + "offer": { + "type": "string", + "title": "The offer type of the Azure Virtual Machines Marketplace image.", + "description": "For example, UbuntuServer or WindowsServer." + }, + "sku": { + "type": "string", + "title": "The SKU of the Azure Virtual Machines Marketplace image.", + "description": "For example, 18.04-LTS or 2022-datacenter." + }, + "version": { + "type": "string", + "title": "The version of the Azure Virtual Machines Marketplace image.", + "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "id": { + "type": "string", + "title": "The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.", + "description": "This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + }, + "sharedGalleryImageId": { + "type": "string", + "title": "The shared gallery image unique identifier", + "description": "This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call." + }, + "communityGalleryImageId": { + "type": "string", + "title": "The community gallery image unique identifier", + "description": "This property is mutually exclusive with other properties and can be fetched from community gallery image GET call." + } + } + }, + "InboundEndpointProtocol": { + "type": "string", + "description": "The protocol of the endpoint.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": false, + "values": [ + { + "name": "TCP", + "value": "TCP", + "description": "Use TCP for the endpoint." + }, + { + "name": "UDP", + "value": "UDP", + "description": "Use UDP for the endpoint." + } + ] + } + }, + "InboundNatPool": { + "type": "object", + "title": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.", + "description": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.", + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint.", + "description": "The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." + }, + "protocol": { + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint.", + "description": "The protocol of the endpoint." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The port number on the compute node.", + "description": "This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "networkSecurityGroupRules": { + "type": "array", + "title": "A list of network security group rules that will be applied to the endpoint.", + "description": "The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.", + "items": { + "$ref": "#/definitions/NetworkSecurityGroupRule" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name", + "protocol", + "backendPort", + "frontendPortRangeStart", + "frontendPortRangeEnd" + ] + }, + "InterNodeCommunicationState": { + "type": "string", + "description": "This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InterNodeCommunicationState", + "modelAsString": false, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enable network communication between virtual machines." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disable network communication between virtual machines." + } + ] + } + }, + "JobDefaultOrder": { + "type": "string", + "description": "The order for scheduling tasks from different jobs with the same priority.", + "enum": [ + "None", + "CreationTime" + ], + "x-ms-enum": { + "name": "JobDefaultOrder", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Tasks should be scheduled uniformly from all equal-priority jobs for the pool." + }, + { + "name": "CreationTime", + "value": "CreationTime", + "description": "If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first." + } + ] + } + }, + "KeySource": { + "type": "string", + "description": "Type of the key source.", + "enum": [ + "Microsoft.Batch", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": false, + "values": [ + { + "name": "Microsoft.Batch", + "value": "Microsoft.Batch", + "description": "Batch creates and manages the encryption keys used to protect the account data." + }, + { + "name": "Microsoft.KeyVault", + "value": "Microsoft.KeyVault", + "description": "The encryption keys used to protect the account data are stored in an external key vault. If this is set then the Batch Account identity must be set to `SystemAssigned` and a valid Key Identifier must also be supplied under the keyVaultProperties." + } + ] + } + }, + "KeyVaultProperties": { + "type": "object", + "description": "KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.", + "properties": { + "keyIdentifier": { + "type": "string", + "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\nThe Batch Account has a System Assigned identity\nThe account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions\nThe KeyVault has soft-delete and purge protection enabled" + } + } + }, + "KeyVaultReference": { + "type": "object", + "description": "Identifies the Azure key vault associated with a Batch account.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the Azure key vault associated with the Batch account.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "url": { + "type": "string", + "description": "The URL of the Azure key vault associated with the Batch account." + } + }, + "required": [ + "id", + "url" + ] + }, + "LinuxUserConfiguration": { + "type": "object", + "title": "Properties used to create a user account on a Linux node.", + "description": "Properties used to create a user account on a Linux node.", + "properties": { + "uid": { + "type": "integer", + "format": "int32", + "title": "The user ID of the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." + }, + "gid": { + "type": "integer", + "format": "int32", + "title": "The group ID for the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." + }, + "sshPrivateKey": { + "type": "string", + "format": "password", + "title": "The SSH private key for the user account.", + "description": "The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).", + "x-ms-secret": true + } + } + }, + "ListApplicationPackagesResult": { + "type": "object", + "description": "The result of performing list application packages.", + "properties": { + "value": { + "type": "array", + "description": "The ApplicationPackage items on this page", + "items": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ListApplicationsResult": { + "type": "object", + "description": "The result of performing list applications.", + "properties": { + "value": { + "type": "array", + "description": "The Application items on this page", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ListPoolsResult": { + "type": "object", + "description": "Values returned by the List operation.", + "properties": { + "value": { + "type": "array", + "description": "The Pool items on this page", + "items": { + "$ref": "#/definitions/Pool" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ListPrivateEndpointConnectionsResult": { + "type": "object", + "description": "Values returned by the List operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ListPrivateLinkResourcesResult": { + "type": "object", + "description": "Values returned by the List operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LoginMode": { + "type": "string", + "description": "Specifies login mode for the user. The default value is Interactive.", + "enum": [ + "Batch", + "Interactive" + ], + "x-ms-enum": { + "name": "LoginMode", + "modelAsString": false, + "values": [ + { + "name": "Batch", + "value": "Batch", + "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes." + }, + { + "name": "Interactive", + "value": "Interactive", + "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended." + } + ] + } + }, + "ManagedDisk": { + "type": "object", + "description": "The managed disk parameters.", + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "title": "The storage account type for use in creating data disks or OS disk.", + "description": "The storage account type for use in creating data disks or OS disk." + }, + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "title": "Specifies the security profile for the managed disk.", + "description": "Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode." + } + } + }, + "MetadataItem": { + "type": "object", + "title": "A name-value pair associated with a Batch service resource.", + "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.", + "properties": { + "name": { + "type": "string", + "title": "The name of the metadata item.", + "description": "The name of the metadata item." + }, + "value": { + "type": "string", + "title": "The value of the metadata item.", + "description": "The value of the metadata item." + } + }, + "required": [ + "name", + "value" + ] + }, + "MountConfiguration": { + "type": "object", + "title": "The file system to mount on each node.", + "description": "The file system to mount on each node.", + "properties": { + "azureBlobFileSystemConfiguration": { + "$ref": "#/definitions/AzureBlobFileSystemConfiguration", + "title": "The Azure Storage Container to mount using blob FUSE on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "nfsMountConfiguration": { + "$ref": "#/definitions/NFSMountConfiguration", + "title": "The NFS file system to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "cifsMountConfiguration": { + "$ref": "#/definitions/CIFSMountConfiguration", + "title": "The CIFS/SMB file system to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + }, + "azureFileShareConfiguration": { + "$ref": "#/definitions/AzureFileShareConfiguration", + "title": "The Azure File Share to mount on each node.", + "description": "This property is mutually exclusive with all other properties." + } + } + }, + "NFSMountConfiguration": { + "type": "object", + "title": "Information used to connect to an NFS file system.", + "description": "Information used to connect to an NFS file system.", + "properties": { + "source": { + "type": "string", + "title": "The URI of the file system to mount.", + "description": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "title": "The relative path on the compute node where the file system will be mounted", + "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "title": "Additional command line options to pass to the mount command.", + "description": "These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "source", + "relativeMountPath" + ] + }, + "NameAvailabilityReason": { + "type": "string", + "description": "Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false, + "values": [ + { + "name": "Invalid", + "value": "Invalid", + "description": "The requested name is invalid." + }, + { + "name": "AlreadyExists", + "value": "AlreadyExists", + "description": "The requested name is already in use." + } + ] + } + }, + "NetworkConfiguration": { + "type": "object", + "description": "The network configuration for a pool.", + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.", + "description": "The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration", + "externalDocs": { + "description": "Create an Azure Batch pool in a virtual network", + "url": "https://learn.microsoft.com/azure/batch/batch-virtual-networks" + } + }, + "dynamicVnetAssignmentScope": { + "type": "string", + "title": "The scope of dynamic vnet assignment.", + "description": "The scope of dynamic vnet assignment.", + "default": "none", + "enum": [ + "none", + "job" + ], + "x-ms-enum": { + "name": "DynamicVNetAssignmentScope", + "modelAsString": false, + "values": [ + { + "name": "none", + "value": "none", + "description": "No dynamic VNet assignment is enabled." + }, + { + "name": "job", + "value": "job", + "description": "Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support" + } + ] + } + }, + "endpointConfiguration": { + "$ref": "#/definitions/PoolEndpointConfiguration", + "title": "The configuration for endpoints on compute nodes in the Batch pool.", + "description": "The endpoint configuration for a pool." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/PublicIPAddressConfiguration", + "title": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.", + "description": "The public IP Address configuration of the networking configuration of a Pool." + }, + "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": { + "description": "Create a VM with Accelerated Networking.", + "url": "https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview" + } + } + } + }, + "NetworkProfile": { + "type": "object", + "description": "Network profile for Batch account, which contains network rule settings for each endpoint.", + "properties": { + "accountAccess": { + "$ref": "#/definitions/EndpointAccessProfile", + "description": "Network access profile for batchAccount endpoint (Batch account data plane API)." + }, + "nodeManagementAccess": { + "$ref": "#/definitions/EndpointAccessProfile", + "description": "Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools)." + } + } + }, + "NetworkSecurityGroupRule": { + "type": "object", + "title": "A network security group rule to apply to an inbound endpoint.", + "description": "A network security group rule to apply to an inbound endpoint.", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority for this rule.", + "description": "Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400." + }, + "access": { + "$ref": "#/definitions/NetworkSecurityGroupRuleAccess", + "title": "The action that should be taken for a specified IP address, subnet range or tag.", + "description": "The action that should be taken for a specified IP address, subnet range or tag." + }, + "sourceAddressPrefix": { + "type": "string", + "title": "The source address prefix or tag to match for the rule.", + "description": "Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400." + }, + "sourcePortRanges": { + "type": "array", + "title": "The source port ranges to match for the rule.", + "description": "Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.", + "items": { + "type": "string" + } + } + }, + "required": [ + "priority", + "access", + "sourceAddressPrefix" + ] + }, + "NetworkSecurityGroupRuleAccess": { + "type": "string", + "description": "The action that should be taken for a specified IP address, subnet range or tag.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkSecurityGroupRuleAccess", + "modelAsString": false, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Allow access." + }, + { + "name": "Deny", + "value": "Deny", + "description": "Deny access." + } + ] + } + }, + "NodePlacementConfiguration": { + "type": "object", + "title": "Node placement configuration for Batch pools.", + "description": "Allocation configuration used by Batch Service to provision the nodes.", + "properties": { + "policy": { + "$ref": "#/definitions/NodePlacementPolicyType", + "title": "Node placement Policy type on Batch pools.", + "description": "Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy." + } + } + }, + "NodePlacementPolicyType": { + "type": "string", + "description": "The default value is regional.", + "enum": [ + "Regional", + "Zonal" + ], + "x-ms-enum": { + "name": "NodePlacementPolicyType", + "modelAsString": false, + "values": [ + { + "name": "Regional", + "value": "Regional", + "description": "All nodes in the pool will be allocated in the same region." + }, + { + "name": "Zonal", + "value": "Zonal", + "description": "Nodes in the pool will be spread across different zones with best effort balancing." + } + ] + } + }, + "OSDisk": { + "type": "object", + "title": "Settings for the operating system disk of the virtual machine.", + "description": "Settings for the operating system disk of the virtual machine.", + "properties": { + "ephemeralOSDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "The type of caching to enable for the disk.", + "description": "The type of caching to enable for the disk." + }, + "managedDisk": { + "$ref": "#/definitions/ManagedDisk", + "title": "The managed disk parameters.", + "description": "The managed disk parameters." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in GB when creating new OS disk.", + "description": "The initial disk size in GB when creating new OS disk." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "title": "Specifies whether writeAccelerator should be enabled or disabled on the disk.", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + } + }, + "Operation": { + "type": "object", + "title": "A REST API operation", + "description": "A REST API operation", + "properties": { + "name": { + "type": "string", + "title": "The operation name.", + "description": "This is of the format {provider}/{resource}/{operation}" + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "title": "The object that describes the operation.", + "description": "The object that describes the operation." + }, + "origin": { + "type": "string", + "title": "The intended executor of the operation.", + "description": "The intended executor of the operation." + }, + "properties": { + "title": "Properties of the operation.", + "description": "Properties of the operation." + } + } + }, + "OperationDisplay": { + "type": "object", + "description": "The object that describes the operation.", + "properties": { + "provider": { + "type": "string", + "title": "Friendly name of the resource provider.", + "description": "Friendly name of the resource provider." + }, + "operation": { + "type": "string", + "title": "The operation type.", + "description": "For example: read, write, delete, or listKeys/action" + }, + "resource": { + "type": "string", + "title": "The resource type on which the operation is performed.", + "description": "The resource type on which the operation is performed." + }, + "description": { + "type": "string", + "title": "The friendly name of the operation", + "description": "The friendly name of the operation" + } + } + }, + "OperationListResult": { + "type": "object", + "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "description": "Paged collection of Operation items", + "properties": { + "value": { + "type": "array", + "title": "The list of operations supported by the resource provider.", + "description": "The Operation items on this page", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "type": "string", + "format": "uri", + "title": "The URL to get the next set of operation list results if there are any.", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OutboundEnvironmentEndpoint": { + "type": "object", + "description": "A collection of related endpoints from the same service for which the Batch service requires outbound access.", + "properties": { + "category": { + "type": "string", + "description": "The type of service that the Batch service connects to.", + "readOnly": true + }, + "endpoints": { + "type": "array", + "description": "The endpoints for this service to which the Batch service makes outbound calls.", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "readOnly": true, + "x-ms-identifiers": [ + "domainName" + ] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "type": "object", + "description": "Values returned by the List operation.", + "properties": { + "value": { + "type": "array", + "description": "The OutboundEnvironmentEndpoint items on this page", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PackageState": { + "type": "string", + "description": "The current state of the application package.", + "enum": [ + "Pending", + "Active" + ], + "x-ms-enum": { + "name": "PackageState", + "modelAsString": false, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "The application package has been created but has not yet been activated." + }, + { + "name": "Active", + "value": "Active", + "description": "The application package is ready for use." + } + ] + } + }, + "Pool": { + "type": "object", + "description": "Contains information about a pool.", + "properties": { + "properties": { + "$ref": "#/definitions/PoolProperties", + "description": "The properties associated with the pool.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/BatchPoolIdentity", + "description": "The type of identity used for the Batch Pool." + }, + "etag": { + "type": "string", + "description": "The ETag of the resource, used for concurrency statements.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "The tags of the resource.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PoolAllocationMode": { + "type": "string", + "description": "The allocation mode for creating pools in the Batch account.", + "enum": [ + "BatchService", + "UserSubscription" + ], + "x-ms-enum": { + "name": "PoolAllocationMode", + "modelAsString": false, + "values": [ + { + "name": "BatchService", + "value": "BatchService", + "description": "Pools will be allocated in subscriptions owned by the Batch service." + }, + { + "name": "UserSubscription", + "value": "UserSubscription", + "description": "Pools will be allocated in a subscription owned by the user." + } + ] + } + }, + "PoolEndpointConfiguration": { + "type": "object", + "title": "The endpoint configuration for a pool.", + "description": "The endpoint configuration for a pool.", + "properties": { + "inboundNatPools": { + "type": "array", + "title": "A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally.", + "description": "The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "inboundNatPools" + ] + }, + "PoolIdentityType": { + "type": "string", + "description": "The type of identity used for the Batch Pool.", + "enum": [ + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "PoolIdentityType", + "modelAsString": false, + "values": [ + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "Batch pool has user assigned identities with it." + }, + { + "name": "None", + "value": "None", + "description": "Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities." + } + ] + } + }, + "PoolProperties": { + "type": "object", + "description": "Pool properties.", + "properties": { + "displayName": { + "type": "string", + "title": "The display name for the pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the pool.", + "description": "This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the pool.", + "description": "The creation time of the pool.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/PoolProvisioningState", + "title": "The current state of the pool.", + "description": "The current state of the pool.", + "readOnly": true + }, + "provisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current state.", + "description": "The time at which the pool entered its current state.", + "readOnly": true + }, + "allocationState": { + "$ref": "#/definitions/AllocationState", + "title": "Whether the pool is resizing.", + "description": "Whether the pool is resizing.", + "readOnly": true + }, + "allocationStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current allocation state.", + "description": "The time at which the pool entered its current allocation state.", + "readOnly": true + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", + "description": "For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + }, + "deploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "title": "This property describes the virtual machines that the pool nodes will be deployed on.", + "description": "Deployment configuration properties." + }, + "currentDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The number of dedicated compute nodes currently in the pool.", + "description": "The number of dedicated compute nodes currently in the pool.", + "readOnly": true + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The number of Spot/low-priority compute nodes currently in the pool.", + "description": "The number of Spot/low-priority compute nodes currently in the pool.", + "readOnly": true + }, + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Settings which configure the number of nodes in the pool.", + "description": "Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes." + }, + "autoScaleRun": { + "$ref": "#/definitions/AutoScaleRun", + "title": "The results and errors from the last execution of the autoscale formula.", + "description": "This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.", + "readOnly": true + }, + "interNodeCommunication": { + "$ref": "#/definitions/InterNodeCommunicationState", + "title": "Whether the pool permits direct communication between nodes.", + "description": "This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the pool.", + "description": "The network configuration for a pool." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "title": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.", + "description": "The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.", + "default": 1 + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How tasks are distributed across compute nodes in a pool.", + "description": "If not specified, the default is spread." + }, + "userAccounts": { + "type": "array", + "title": "The list of user accounts to be created on each node in the pool.", + "description": "The list of user accounts to be created on each node in the pool.", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "metadata": { + "type": "array", + "title": "A list of name-value pairs associated with the pool as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task specified to run on each compute node as it joins the pool.", + "description": "In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool." + }, + "applicationPackages": { + "type": "array", + "title": "The list of application packages to be installed on each compute node in the pool.", + "description": "Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + } + }, + "resizeOperationStatus": { + "$ref": "#/definitions/ResizeOperationStatus", + "title": "Contains details about the current or last completed resize operation.", + "description": "Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).", + "readOnly": true + }, + "mountConfiguration": { + "type": "array", + "title": "A list of file systems to mount on each node in the pool.", + "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "x-ms-identifiers": [] + }, + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "title": "The upgrade policy for the pool.", + "description": "Describes an upgrade policy - automatic, manual, or rolling." + } + } + }, + "PoolProvisioningState": { + "type": "string", + "description": "The current state of the pool.", + "enum": [ + "Succeeded", + "Deleting" + ], + "x-ms-enum": { + "name": "PoolProvisioningState", + "modelAsString": false, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The pool is available to run tasks subject to the availability of compute nodes." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed." + } + ] + } + }, + "PrivateEndpoint": { + "type": "object", + "description": "The private endpoint of the private endpoint connection.", + "properties": { + "id": { + "type": "string", + "title": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.", + "description": "The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}.", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "Contains information about a private link resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties associated with the private endpoint connection.", + "x-ms-client-flatten": true + }, + "etag": { + "type": "string", + "description": "The ETag of the resource, used for concurrency statements.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "The tags of the resource.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Private endpoint connection properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "title": "The provisioning state of the private endpoint connection.", + "description": "The provisioning state of the private endpoint connection.", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "title": "The ARM resource identifier of the private endpoint.", + "description": "The private endpoint of the private endpoint connection.", + "readOnly": true + }, + "groupIds": { + "type": "array", + "title": "The group id of the private endpoint connection.", + "description": "The value has one and only one group id.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "title": "The private link service connection state of the private endpoint connection.", + "description": "The private link service connection state of the private endpoint connection." + } + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "description": "The provisioning state of the private endpoint connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": false, + "values": [ + { + "name": "Creating", + "value": "Creating", + "description": "The connection is creating." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The user has requested that the connection status be updated, but the update operation has not yet completed. You may not reference the connection when connecting the Batch account." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The connection is deleting." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The connection status is final and is ready for use if Status is Approved." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The user requested that the connection be updated and it failed. You may retry the update operation." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "The user has cancelled the connection creation." + } + ] + }, + "readOnly": true + }, + "PrivateLinkResource": { + "type": "object", + "description": "Contains information about a private link resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "The properties associated with the private link resource.", + "x-ms-client-flatten": true + }, + "etag": { + "type": "string", + "description": "The ETag of the resource, used for concurrency statements.", + "readOnly": true + }, + "tags": { + "type": "object", + "description": "The tags of the resource.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Private link resource properties.", + "properties": { + "groupId": { + "type": "string", + "title": "The group id of the private link resource.", + "description": "The group id is used to establish the private link connection.", + "readOnly": true + }, + "requiredMembers": { + "type": "array", + "title": "The list of required members that are used to establish the private link connection.", + "description": "The list of required members that are used to establish the private link connection.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "title": "The list of required zone names for the private DNS resource name.", + "description": "The list of required zone names for the private DNS resource name", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "The private link service connection state of the private endpoint connection", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "title": "The status of the Batch private endpoint connection", + "description": "The status of the Batch private endpoint connection" + }, + "description": { + "type": "string", + "title": "Description of the private Connection state", + "description": "Description of the private Connection state" + }, + "actionsRequired": { + "type": "string", + "title": "Action required on the private connection state", + "description": "Action required on the private connection state", + "readOnly": true + } + }, + "required": [ + "status" + ] + }, + "PrivateLinkServiceConnectionStatus": { + "type": "string", + "description": "The status of the Batch private endpoint connection", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": false, + "values": [ + { + "name": "Approved", + "value": "Approved", + "description": "The private endpoint connection is approved and can be used to access Batch account" + }, + { + "name": "Pending", + "value": "Pending", + "description": "The private endpoint connection is pending and cannot be used to access Batch account" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "The private endpoint connection is rejected and cannot be used to access Batch account" + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "The private endpoint connection is disconnected and cannot be used to access Batch account" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioned state of the resource", + "enum": [ + "Invalid", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false, + "values": [ + { + "name": "Invalid", + "value": "Invalid", + "description": "The account is in an invalid state." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The account is being created." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The account is being deleted." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The account has been created and is ready for use." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The last operation for the account is failed." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "The last operation for the account is cancelled." + } + ] + }, + "readOnly": true + }, + "ProxyAgentSettings": { + "type": "object", + "description": "Specifies ProxyAgent settings while creating the virtual machine.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether Metadata Security Protocol feature should be enabled on the virtual machine or virtual machine scale set. Default is False." + }, + "imds": { + "$ref": "#/definitions/HostEndpointSettings", + "description": "Settings for the IMDS endpoint." + }, + "wireServer": { + "$ref": "#/definitions/HostEndpointSettings", + "description": "Settings for the WireServer endpoint." + } + } + }, + "PublicIPAddressConfiguration": { + "type": "object", + "description": "The public IP Address configuration of the networking configuration of a Pool.", + "properties": { + "provision": { + "$ref": "#/definitions/IPAddressProvisioningType", + "title": "The provisioning type for Public IP Addresses for the Batch Pool.", + "description": "The default value is BatchManaged" + }, + "ipAddressIds": { + "type": "array", + "title": "The list of public IPs which the Batch service will use when provisioning Compute Nodes.", + "description": "The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.", + "items": { + "type": "string" + } + }, + "ipFamilies": { + "type": "array", + "title": "The IP families used to specify IP versions available to the pool.", + "description": "IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.", + "items": { + "$ref": "#/definitions/IPFamily" + } + }, + "ipTags": { + "type": "array", + "title": "IP Tags that will applied to new Public IPs that Batch creates.", + "description": "IP Tags that will applied to new Public IPs that Batch creates.", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [] + } + } + }, + "ResizeError": { + "type": "object", + "title": "An error that occurred when resizing a pool.", + "description": "An error that occurred when resizing a pool.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "title": "Additional details about the error.", + "description": "Additional details about the error.", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "x-ms-identifiers": [ + "code" + ] + } + }, + "required": [ + "code", + "message" + ] + }, + "ResizeOperationStatus": { + "type": "object", + "title": "Details about the current or last completed resize operation.", + "description": "Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).", + "properties": { + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool.", + "description": "The desired number of dedicated compute nodes in the pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of Spot/low-priority compute nodes in the pool.", + "description": "The desired number of Spot/low-priority compute nodes in the pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.", + "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "$ref": "#/definitions/ComputeNodeDeallocationOption", + "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", + "description": "The default value is requeue." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time when this resize operation was started.", + "description": "The time when this resize operation was started." + }, + "errors": { + "type": "array", + "title": "Details of any errors encountered while performing the last resize on the pool.", + "description": "This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "x-ms-identifiers": [ + "code" + ] + } + } + }, + "ResourceFile": { + "type": "object", + "title": "A single file or multiple files to be downloaded to a compute node.", + "description": "A single file or multiple files to be downloaded to a compute node.", + "properties": { + "autoStorageContainerName": { + "type": "string", + "title": "The storage container name in the auto storage account.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified." + }, + "storageContainerUrl": { + "type": "string", + "title": "The URL of the blob container within Azure Blob Storage.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access." + }, + "httpUrl": { + "type": "string", + "title": "The URL of the file to download.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access." + }, + "blobPrefix": { + "type": "string", + "title": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.", + "description": "The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded." + }, + "filePath": { + "type": "string", + "title": "The location on the compute node to which to download the file, relative to the task's working directory.", + "description": "If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')." + }, + "fileMode": { + "type": "string", + "title": "The file permission mode attribute in octal format.", + "description": "This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file." + }, + "identityReference": { + "$ref": "#/definitions/ComputeNodeIdentityReference", + "title": "The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl", + "description": "The reference to a user assigned identity associated with the Batch pool which a compute node will use." + } + } + }, + "ResourceIdentityType": { + "type": "string", + "description": "The type of identity used for the Batch account.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "name": "SystemAssigned", + "value": "SystemAssigned", + "description": "Batch account has a system assigned identity with it." + }, + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "Batch account has user assigned identities with it." + }, + { + "name": "None", + "value": "None", + "description": "Batch account has no identity associated with it. Setting `None` in update account will remove existing identities." + } + ] + } + }, + "ResourceType": { + "type": "string", + "description": "The result of the request to list operations.", + "enum": [ + "Microsoft.Batch/batchAccounts" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": false, + "values": [ + { + "name": "MicrosoftBatchBatchAccounts", + "value": "Microsoft.Batch/batchAccounts", + "description": "The resource type for Microsoft.Batch/batchAccounts" + } + ] + } + }, + "RollingUpgradePolicy": { + "type": "object", + "description": "The configuration parameters used while performing a rolling upgrade.", + "properties": { + "enableCrossZoneUpgrade": { + "type": "boolean", + "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal." + }, + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.", + "minimum": 5, + "maximum": 100 + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.", + "minimum": 5, + "maximum": 100 + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive.", + "minimum": 0, + "maximum": 100 + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format." + }, + "prioritizeUnhealthyInstances": { + "type": "boolean", + "description": "Upgrade all unhealthy instances in a scale set before any healthy instances." + }, + "rollbackFailedInstancesOnPolicyBreach": { + "type": "boolean", + "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated." + } + } + }, + "ScaleSettings": { + "type": "object", + "title": "Scale settings for the pool", + "description": "Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.", + "properties": { + "fixedScale": { + "$ref": "#/definitions/FixedScaleSettings", + "title": "Fixed scale settings for the pool.", + "description": "This property and autoScale are mutually exclusive and one of the properties must be specified." + }, + "autoScale": { + "$ref": "#/definitions/AutoScaleSettings", + "title": "AutoScale settings for the pool.", + "description": "This property and fixedScale are mutually exclusive and one of the properties must be specified." + } + } + }, + "SecurityEncryptionTypes": { + "type": "string", + "description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs.", + "enum": [ + "NonPersistedTPM", + "VMGuestStateOnly", + "DiskWithVMGuestState" + ], + "x-ms-enum": { + "name": "SecurityEncryptionTypes", + "modelAsString": true, + "values": [ + { + "name": "NonPersistedTPM", + "value": "NonPersistedTPM", + "description": "EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob." + }, + { + "name": "VMGuestStateOnly", + "value": "VMGuestStateOnly", + "description": "EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob." + }, + { + "name": "DiskWithVMGuestState", + "value": "DiskWithVMGuestState", + "description": "EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks." + } + ] + } + }, + "SecurityProfile": { + "type": "object", + "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set.", + "properties": { + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "title": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings." + }, + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself." + }, + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "title": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.", + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine." + }, + "proxyAgentSettings": { + "$ref": "#/definitions/ProxyAgentSettings", + "description": "Specifies ProxyAgent settings while creating the virtual machine." + } + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.", + "enum": [ + "trustedLaunch", + "confidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": false, + "values": [ + { + "name": "trustedLaunch", + "value": "trustedLaunch", + "description": "Trusted launch protects against advanced and persistent attack techniques." + }, + { + "name": "confidentialVM", + "value": "confidentialVM", + "description": "Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified." + } + ] + } + }, + "ServiceArtifactReference": { + "type": "object", + "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.", + "properties": { + "id": { + "type": "string", + "title": "The service artifact reference id of ServiceArtifactReference", + "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "required": [ + "id" + ] + }, + "SkuCapability": { + "type": "object", + "description": "A SKU capability, such as the number of cores.", + "properties": { + "name": { + "type": "string", + "description": "The name of the feature.", + "readOnly": true + }, + "value": { + "type": "string", + "description": "The value of the feature.", + "readOnly": true + } + } + }, + "StartTask": { + "type": "object", + "title": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.", + "description": "In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.", + "properties": { + "commandLine": { + "type": "string", + "title": "The command line of the start task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. Required if any other properties of the startTask are specified." + }, + "resourceFiles": { + "type": "array", + "title": "A list of files that the Batch service will download to the compute node before running the command line.", + "description": "A list of files that the Batch service will download to the compute node before running the command line.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [ + "httpUrl" + ] + }, + "environmentSettings": { + "type": "array", + "title": "A list of environment variable settings for the start task.", + "description": "A list of environment variable settings for the start task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the start task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times the task may be retried.", + "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0", + "default": 0 + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.", + "description": "If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the start task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + } + } + }, + "StorageAccountType": { + "type": "string", + "description": "The storage account type for use in creating data disks or OS disk.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": false, + "values": [ + { + "name": "Standard_LRS", + "value": "Standard_LRS", + "description": "The data disk / OS disk should use standard locally redundant storage." + }, + { + "name": "Premium_LRS", + "value": "Premium_LRS", + "description": "The data disk / OS disk should use premium locally redundant storage." + }, + { + "name": "StandardSSD_LRS", + "value": "StandardSSD_LRS", + "description": "The data disk / OS disk should use standard SSD locally redundant storage." + } + ] + } + }, + "SupportedSku": { + "type": "object", + "description": "Describes a Batch supported SKU.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU.", + "readOnly": true + }, + "familyName": { + "type": "string", + "description": "The family name of the SKU.", + "readOnly": true + }, + "capabilities": { + "type": "array", + "description": "A collection of capabilities which this SKU supports.", + "items": { + "$ref": "#/definitions/SkuCapability" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "batchSupportEndOfLife": { + "type": "string", + "format": "date-time", + "description": "The time when Azure Batch service will retire this SKU.", + "readOnly": true + } + } + }, + "SupportedSkusResult": { + "type": "object", + "description": "The Batch List supported SKUs operation response.", + "properties": { + "value": { + "type": "array", + "description": "The SupportedSku items on this page", + "items": { + "$ref": "#/definitions/SupportedSku" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TaskContainerSettings": { + "type": "object", + "title": "The container settings for a task.", + "description": "The container settings for a task.", + "properties": { + "containerRunOptions": { + "type": "string", + "title": "Additional options to the container create command.", + "description": "These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." + }, + "imageName": { + "type": "string", + "title": "The image to use to create the container in which the task will run.", + "description": "This is the full image reference, as would be specified to \"docker pull\". If no tag is provided as part of the image name, the tag \":latest\" is used as a default." + }, + "registry": { + "$ref": "#/definitions/ContainerRegistry", + "title": "The private registry which contains the container image.", + "description": "This setting can be omitted if was already provided at pool creation." + }, + "workingDirectory": { + "$ref": "#/definitions/ContainerWorkingDirectory", + "title": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.", + "description": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'." + }, + "containerHostBatchBindMounts": { + "type": "array", + "title": "The paths you want to mounted to container task.", + "description": "If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.", + "items": { + "$ref": "#/definitions/ContainerHostBatchBindMountEntry" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "imageName" + ] + }, + "TaskSchedulingPolicy": { + "type": "object", + "title": "Specifies how tasks should be distributed across compute nodes.", + "description": "Specifies how tasks should be distributed across compute nodes.", + "properties": { + "jobDefaultOrder": { + "$ref": "#/definitions/JobDefaultOrder", + "title": "If not specified, the default is none.", + "description": "The order for scheduling tasks from different jobs with the same priority." + }, + "nodeFillType": { + "type": "string", + "title": "How tasks should be distributed across compute nodes.", + "description": "How tasks should be distributed across compute nodes.", + "default": "Spread", + "enum": [ + "Spread", + "Pack" + ], + "x-ms-enum": { + "name": "ComputeNodeFillType", + "modelAsString": false, + "values": [ + { + "name": "Spread", + "value": "Spread", + "description": "Tasks should be assigned evenly across all nodes in the pool." + }, + { + "name": "Pack", + "value": "Pack", + "description": "As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool." + } + ] + } + } + }, + "required": [ + "nodeFillType" + ] + }, + "UefiSettings": { + "type": "object", + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine." + } + } + }, + "UpgradeMode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.", + "enum": [ + "automatic", + "manual", + "rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false, + "values": [ + { + "name": "automatic", + "value": "automatic", + "description": "All virtual machines in the scale set are automatically updated at the same time." + }, + { + "name": "manual", + "value": "manual", + "description": "You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action." + }, + { + "name": "rolling", + "value": "rolling", + "description": "The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date." + } + ] + } + }, + "UpgradePolicy": { + "type": "object", + "description": "Describes an upgrade policy - automatic, manual, or rolling.", + "properties": { + "mode": { + "$ref": "#/definitions/UpgradeMode", + "title": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between." + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "title": "Configuration parameters used for performing automatic OS Upgrade.", + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "title": "The configuration parameters used while performing a rolling upgrade.", + "description": "The configuration parameters used while performing a rolling upgrade." + } + }, + "required": [ + "mode" + ] + }, + "UserAccount": { + "type": "object", + "title": "Properties used to create a user on an Azure Batch node.", + "description": "Properties used to create a user on an Azure Batch node.", + "properties": { + "name": { + "type": "string", + "title": "The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.", + "description": "The name of the user account. Names can contain any Unicode characters up to a maximum length of 20." + }, + "password": { + "type": "string", + "format": "password", + "title": "The password for the user account.", + "description": "The password for the user account.", + "x-ms-secret": true + }, + "elevationLevel": { + "$ref": "#/definitions/ElevationLevel", + "title": "The elevation level of the user.", + "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin." + }, + "linuxUserConfiguration": { + "$ref": "#/definitions/LinuxUserConfiguration", + "title": "The Linux-specific user configuration for the user account.", + "description": "This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options." + }, + "windowsUserConfiguration": { + "$ref": "#/definitions/WindowsUserConfiguration", + "title": "The Windows-specific user configuration for the user account.", + "description": "This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options." + } + }, + "required": [ + "name", + "password" + ] + }, + "UserAssignedIdentities": { + "type": "object", + "description": "The list of associated user identities.", + "properties": { + "principalId": { + "type": "string", + "description": "The principal id of user assigned identity.", + "readOnly": true + }, + "clientId": { + "type": "string", + "description": "The client id of user assigned identity.", + "readOnly": true + } + } + }, + "UserIdentity": { + "type": "object", + "title": "The definition of the user identity under which the task is run.", + "description": "Specify either the userName or autoUser property, but not both.", + "properties": { + "userName": { + "type": "string", + "title": "The name of the user identity under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + }, + "autoUser": { + "$ref": "#/definitions/AutoUserSpecification", + "title": "The auto user under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + } + } + }, + "VMDiskSecurityProfile": { + "type": "object", + "description": "Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs.", + "properties": { + "securityEncryptionType": { + "$ref": "#/definitions/SecurityEncryptionTypes", + "title": "Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs.", + "description": "Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode." + } + } + }, + "VMExtension": { + "type": "object", + "title": "The configuration for virtual machine extensions.", + "description": "The configuration for virtual machine extensions.", + "properties": { + "name": { + "type": "string", + "title": "The name of the virtual machine extension.", + "description": "The name of the virtual machine extension." + }, + "publisher": { + "type": "string", + "title": "The name of the extension handler publisher.", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "title": "The type of the extensions.", + "description": "The type of the extensions." + }, + "typeHandlerVersion": { + "type": "string", + "title": "The version of script handler.", + "description": "The version of script handler." + }, + "autoUpgradeMinorVersion": { + "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": { + "title": "JSON formatted public settings for the extension.", + "description": "JSON formatted public settings for the extension." + }, + "protectedSettings": { + "format": "password", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.", + "x-ms-secret": true + }, + "provisionAfterExtensions": { + "type": "array", + "title": "The collection of extension names.", + "description": "Collection of extension names after which this extension needs to be provisioned.", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "publisher", + "type" + ] + }, + "VirtualMachineConfiguration": { + "type": "object", + "title": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.", + "description": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.", + "description": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation." + }, + "nodeAgentSkuId": { + "type": "string", + "title": "The SKU of the Batch node agent to be provisioned on compute nodes in the pool.", + "description": "The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "title": "Windows operating system settings on the virtual machine.", + "description": "This property must not be specified if the imageReference specifies a Linux OS image." + }, + "dataDisks": { + "type": "array", + "title": "The configuration for data disks attached to the compute nodes in the pool.", + "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "x-ms-identifiers": [ + "lun" + ] + }, + "licenseType": { + "type": "string", + "title": "The type of on-premises license to be used when deploying the operating system.", + "description": "This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\nWindows_Server - The on-premises license is for Windows Server.\nWindows_Client - The on-premises license is for Windows Client." + }, + "containerConfiguration": { + "$ref": "#/definitions/ContainerConfiguration", + "title": "The container configuration for the pool.", + "description": "If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it." + }, + "diskEncryptionConfiguration": { + "$ref": "#/definitions/DiskEncryptionConfiguration", + "title": "The disk encryption configuration for the pool.", + "description": "If specified, encryption is performed on each node in the pool during node provisioning." + }, + "nodePlacementConfiguration": { + "$ref": "#/definitions/NodePlacementConfiguration", + "title": "The node placement configuration for the pool.", + "description": "This configuration will specify rules on how nodes in the pool will be physically allocated." + }, + "extensions": { + "type": "array", + "title": "The virtual machine extension for the pool.", + "description": "If specified, the extensions mentioned in this configuration will be installed on each node.", + "items": { + "$ref": "#/definitions/VMExtension" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "title": "Settings for the operating system disk of the Virtual Machine.", + "description": "Contains configuration for ephemeral OSDisk settings." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "title": "Specifies the security profile settings for the virtual machine or virtual machine scale set.", + "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "title": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.", + "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "required": [ + "imageReference", + "nodeAgentSkuId" + ] + }, + "VirtualMachineFamilyCoreQuota": { + "type": "object", + "description": "A VM Family and its associated core quota for the Batch account.", + "properties": { + "name": { + "type": "string", + "description": "The Virtual Machine family name.", + "readOnly": true + }, + "coreQuota": { + "type": "integer", + "format": "int32", + "description": "The core quota for the VM family for the Batch account.", + "readOnly": true + } + } + }, + "WindowsConfiguration": { + "type": "object", + "title": "Windows operating system settings to apply to the virtual machine.", + "description": "Windows operating system settings to apply to the virtual machine.", + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "title": "Whether automatic updates are enabled on the virtual machine.", + "description": "If omitted, the default value is true." + } + } + }, + "WindowsUserConfiguration": { + "type": "object", + "title": "Properties used to create a user account on a Windows node.", + "description": "Properties used to create a user account on a Windows node.", + "properties": { + "loginMode": { + "$ref": "#/definitions/LoginMode", + "title": "Login mode for user", + "description": "Specifies login mode for the user. The default value is Interactive." + } + } + } + }, + "parameters": {} +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/suppressions.yaml b/specification/batch/resource-manager/Microsoft.Batch/Batch/suppressions.yaml index a32fb67a7166..dd42a8ef1cb5 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/suppressions.yaml +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/suppressions.yaml @@ -51,7 +51,4 @@ reason: Brownfield service not ready to migrate - tool: TypeSpecRequirement path: ./stable/2024-02-01/*.json - reason: Brownfield service not ready to migrate -- tool: TypeSpecRequirement - path: ./stable/2025-06-01/*.json reason: Brownfield service not ready to migrate \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/Batch/tspconfig.yaml b/specification/batch/resource-manager/Microsoft.Batch/Batch/tspconfig.yaml index f25def26fcd7..6dca0c6c9573 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/Batch/tspconfig.yaml +++ b/specification/batch/resource-manager/Microsoft.Batch/Batch/tspconfig.yaml @@ -12,6 +12,7 @@ options: arm-types-dir: "{project-root}/../../../../common-types/resource-management" examples-dir: "{project-root}/examples" emit-lro-options: "all" + use-read-only-status-schema: true "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-batch" namespace: "azure.mgmt.batch"