Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
78aa558
Property update - remove adjacent double capital case naming
Mar 21, 2025
c83cef5
compile update
Mar 21, 2025
f54bd66
updating the name of httpheader and BatchTaskAddCollectionResult
wiboris Mar 26, 2025
7a41a7d
updated BatchTaskAddResult
wiboris Mar 26, 2025
d16aa7f
Update more property names from Java API View review
Mar 28, 2025
ce1bf62
compile
Mar 28, 2025
c294249
additional fix
Mar 28, 2025
fcf71ac
Replace Content suffix on model names with Options
skapur12 Mar 31, 2025
ba13bed
updating AccessScope and AffinityInfo names, changing the type of all…
wiboris Mar 31, 2025
40bf25a
Change Java options bag model naming convention
skapur12 Apr 1, 2025
8687dd3
Fix names of task number properties
skapur12 Apr 1, 2025
6e2dd7f
Update swagger
skapur12 Apr 1, 2025
38efd8a
Python overrides for fileproperties
Apr 3, 2025
65c4386
timeout changed from int32 to duration
wiboris Apr 5, 2025
c58a624
test
wiboris Apr 7, 2025
5ec1738
removing test
wiboris Apr 7, 2025
db50f2f
BatchImageReference -> BatchVMImageReference
wiboris Apr 23, 2025
cc290c5
replacing deletejob
wiboris Apr 23, 2025
f346b56
Csharp lro apis
wiboris Apr 24, 2025
4e41237
regenerating the swagger
wiboris Apr 24, 2025
883e8ec
adding more CSharp LRO overrides
wiboris Apr 25, 2025
74fc47b
last LRO's for csharp
wiboris Apr 29, 2025
6ea11ba
Fix go overrides
skapur12 Apr 29, 2025
5f30725
Fix formatting
skapur12 Apr 29, 2025
09a7839
Move Java name overrides into Java client file
skapur12 May 1, 2025
8e207e3
updating samples to fit the new defined types
wiboris May 5, 2025
23b5338
fix data type
wiboris May 5, 2025
49b7b47
small fix
wiboris May 5, 2025
22bea6d
Change content to parameters for Java
skapur12 May 10, 2025
ae3483a
updating BatchNodeRebootKinds to BatchNodeRebootOptions
wiboris May 12, 2025
4479426
Make model name order noun then verb in all cases
skapur12 May 13, 2025
54e99e7
Rename parameters to options for SDKs except Java
skapur12 May 13, 2025
06567f6
Revert autoscale evaluate and enable model names
skapur12 May 14, 2025
7440253
Update Java options bag names for autoscale models
skapur12 May 14, 2025
60b5a7d
Update Java Disable AutoScale option bag name
skapur12 May 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updating AccessScope and AffinityInfo names, changing the type of all…
… urls from string to url, changing etag, changing batch certificate data to bytes
  • Loading branch information
wiboris authored and skapur12 committed May 12, 2025
commit ba13bedd790d850b532187717bbb1a73dbdee909
97 changes: 60 additions & 37 deletions specification/batch/Azure.Batch/models.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -303,8 +303,8 @@ union ContainerType {
CriCompatible: "criCompatible",
}

@doc("AccessScope enums")
union AccessScope {
@doc("BatchAccessScope enums")
union BatchAccessScope {
string,

@doc("Grants access to perform all operations on the Job containing the Task.")
Expand Down Expand Up @@ -1000,7 +1000,8 @@ model BatchNodeCounts {
@doc("Contains utilization and resource usage statistics for the lifetime of a Pool.")
model BatchPoolStatistics {
@doc("The URL for the statistics.")
url: string;
@clientName("uri", "csharp")
url: url;

@doc("The start time of the time range covered by the statistics.")
startTime: utcDateTime;
Expand Down Expand Up @@ -1079,7 +1080,8 @@ model BatchPoolResourceStatistics {
@doc("Resource usage statistics for a Job.")
model BatchJobStatistics {
@doc("The URL of the statistics.")
url: string;
@clientName("uri", "csharp")
url: url;

@doc("The start time of the time range covered by the statistics.")
startTime: utcDateTime;
Expand Down Expand Up @@ -1145,7 +1147,8 @@ model BatchCertificate {

@doc("The URL of the Certificate.")
@visibility(Lifecycle.Read)
url?: string;
@clientName("uri", "csharp")
url?: url;

@doc("The state of the Certificate.")
@visibility(Lifecycle.Read)
Expand Down Expand Up @@ -1173,7 +1176,7 @@ model BatchCertificate {

@doc("The base64-encoded contents of the Certificate. The maximum size is 10KB.")
@visibility(Lifecycle.Create)
data: string;
data: bytes;

@doc("The format of the Certificate data.")
@visibility(Lifecycle.Create)
Expand Down Expand Up @@ -1240,7 +1243,8 @@ model BatchNodeFile {
name?: string;

@doc("The URL of the file.")
url?: string;
@clientName("uri", "csharp")
url?: url;

@doc("Whether the object represents a directory.")
isDirectory?: boolean;
Expand Down Expand Up @@ -1283,11 +1287,12 @@ model BatchJobSchedule {

@doc("The URL of the Job Schedule.")
@visibility(Lifecycle.Read)
url?: string;
@clientName("uri", "csharp")
url?: url;

@doc("The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.")
@visibility(Lifecycle.Read)
eTag?: string;
eTag?: eTag;

@doc("The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state.")
@visibility(Lifecycle.Read)
Expand Down Expand Up @@ -1613,10 +1618,12 @@ model ResourceFile {
autoStorageContainerName?: string;

@doc("The URL of the blob container within Azure Blob Storage. 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.")
storageContainerUrl?: string;
@clientName("storageContainerUri", "csharp")
storageContainerUrl?: url;

@doc("The URL of the file to download. 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.")
httpUrl?: string;
@clientName("httpUri", "csharp")
httpUrl?: url;

@doc("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. 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.")
blobPrefix?: string;
Expand Down Expand Up @@ -1657,7 +1664,8 @@ model OutputFileBlobContainerDestination {
path?: string;

@doc("The URL of the container within Azure Blob Storage to which to upload the file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container.")
containerUrl: string;
@clientName("containerUri", "csharp")
containerUrl: url;

@doc("The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container.")
identityReference?: BatchNodeIdentityReference;
Expand Down Expand Up @@ -1749,7 +1757,7 @@ model BatchApplicationPackageReference {
""")
model AuthenticationTokenSettings {
@doc("The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task.")
access?: AccessScope[];
access?: BatchAccessScope[];
}

@doc("""
Expand Down Expand Up @@ -2409,13 +2417,14 @@ model AzureFileShareConfiguration {
@doc("The Azure Storage account name.")
accountName: string;

@doc("The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.")
azureFileUrl: string;

@secret
@doc("The Azure Storage account key.")
accountKey: string;

@doc("The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.")
@clientName("azureFileUri", "csharp")
azureFileUrl: url;

@doc("The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.")
relativeMountPath: string;

Expand Down Expand Up @@ -2444,14 +2453,16 @@ model RecentBatchJob {
id?: string;

@doc("The URL of the Job.")
url?: string;
@clientName("uri", "csharp")
url?: url;
}

#suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase"
@doc("Resource usage statistics for a Job Schedule.")
model BatchJobScheduleStatistics {
@doc("The URL of the statistics.")
url: string;
@clientName("uri", "csharp")
url: url;

@doc("The start time of the time range covered by the statistics.")
startTime: utcDateTime;
Expand Down Expand Up @@ -2533,11 +2544,12 @@ model BatchJob {

@doc("The URL of the Job.")
@visibility(Lifecycle.Read)
url?: string;
@clientName("uri", "csharp")
url?: url;

@doc("The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime.")
@visibility(Lifecycle.Read)
eTag?: string;
eTag?: eTag;

@doc("The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state.")
@visibility(Lifecycle.Read)
Expand Down Expand Up @@ -2784,7 +2796,8 @@ model BatchJobPreparationAndReleaseTaskStatus {
nodeId?: string;

@doc("The URL of the Compute Node to which this entry refers.")
nodeUrl?: string;
@clientName("nodeUri", "csharp")
nodeUrl?: url;

@doc("Information about the execution status of the Job Preparation Task on this Compute Node.")
jobPreparationTaskExecutionInfo?: BatchJobPreparationTaskExecutionInfo;
Expand All @@ -2811,7 +2824,8 @@ model BatchJobPreparationTaskExecutionInfo {
taskRootDirectory?: string;

@doc("The URL to the root directory of the Job Preparation Task on the Compute Node.")
taskRootDirectoryUrl?: string;
@clientName("taskRootDirectoryUri", "csharp")
taskRootDirectoryUrl?: url;

@doc("The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated.")
exitCode?: int32;
Expand Down Expand Up @@ -2877,7 +2891,8 @@ model BatchJobReleaseTaskExecutionInfo {
taskRootDirectory?: string;

@doc("The URL to the root directory of the Job Release Task on the Compute Node.")
taskRootDirectoryUrl?: string;
@clientName("taskRootDirectoryUri", "csharp")
taskRootDirectoryUrl?: url;

@doc("The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated.")
exitCode?: int32;
Expand Down Expand Up @@ -2949,11 +2964,12 @@ model BatchPool {

@doc("The URL of the Pool.")
@visibility(Lifecycle.Read)
url?: string;
@clientName("uri", "csharp")
url?: url;

@doc("The ETag of the Pool. This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime.")
@visibility(Lifecycle.Read)
eTag?: string;
eTag?: eTag;

@doc("The last modified time of the Pool. This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state.")
@visibility(Lifecycle.Read)
Expand Down Expand Up @@ -3404,11 +3420,12 @@ model BatchTask {

@doc("The URL of the Task.")
@visibility(Lifecycle.Read)
url?: string;
@clientName("uri", "csharp")
url?: url;

@doc("The ETag of the Task. This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime.")
@visibility(Lifecycle.Read)
eTag?: string;
eTag?: eTag;

@doc("The last modified time of the Task.")
@visibility(Lifecycle.Read)
Expand Down Expand Up @@ -3460,7 +3477,7 @@ model BatchTask {

@doc("A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task.")
@visibility(Lifecycle.Read)
affinityInfo?: AffinityInfo;
affinityInfo?: BatchAffinityInfo;

@doc("The execution constraints that apply to this Task.")
constraints?: BatchTaskConstraints;
Expand Down Expand Up @@ -3532,7 +3549,7 @@ model BatchTaskCreateOptions {
environmentSettings?: EnvironmentSetting[];

@doc("A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task.")
affinityInfo?: AffinityInfo;
affinityInfo?: BatchAffinityInfo;

@doc("The execution constraints that apply to this Task. If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the Job, the maxWallClockTime is infinite, and the retentionTime is 7 days.")
constraints?: BatchTaskConstraints;
Expand Down Expand Up @@ -3622,7 +3639,7 @@ model ExitCodeRangeMapping {
A locality hint that can be used by the Batch service to select a Compute Node
on which to start a Task.
""")
model AffinityInfo {
model BatchAffinityInfo {
@doc("An opaque string representing the location of a Compute Node or a Task that has run previously. You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere.")
affinityId: string;
}
Expand Down Expand Up @@ -3666,7 +3683,8 @@ model BatchNodeInfo {
affinityId?: string;

@doc("The URL of the Compute Node on which the Task ran.")
nodeUrl?: string;
@clientName("nodeUri", "csharp")
nodeUrl?: url;

@doc("The ID of the Pool on which the Task ran.")
poolId?: string;
Expand All @@ -3678,7 +3696,8 @@ model BatchNodeInfo {
taskRootDirectory?: string;

@doc("The URL to the root directory of the Task on the Compute Node.")
taskRootDirectoryUrl?: string;
@clientName("taskRootDirectoryUri", "csharp")
taskRootDirectoryUrl?: url;
}

@doc("""
Expand All @@ -3702,7 +3721,8 @@ model MultiInstanceSettings {
@doc("Resource usage statistics for a Task.")
model BatchTaskStatistics {
@doc("The URL of the statistics.")
url: string;
@clientName("uri", "csharp")
url: url;

@doc("The start time of the time range covered by the statistics.")
startTime: utcDateTime;
Expand Down Expand Up @@ -3802,7 +3822,7 @@ model BatchTaskCreateResult {
taskId: string;

@doc("The ETag of the Task, if the Task was successfully added. You can use this to detect whether the Task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the Job in the meantime.")
eTag?: string;
eTag?: eTag;

@doc("The last modified time of the Task.")
lastModified?: utcDateTime;
Expand Down Expand Up @@ -3961,7 +3981,8 @@ model BatchNode {
id?: string;

@doc("The URL of the Compute Node.")
url?: string;
@clientName("uri", "csharp")
url?: url;

@doc("The current state of the Compute Node. The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available.")
state?: BatchNodeState;
Expand Down Expand Up @@ -4035,7 +4056,8 @@ model BatchNode {
@doc("Information about a Task running on a Compute Node.")
model BatchTaskInfo {
@doc("The URL of the Task.")
taskUrl?: string;
@clientName("taskUri", "csharp")
taskUrl?: url;

@doc("The ID of the Job to which the Task belongs.")
jobId?: string;
Expand Down Expand Up @@ -4181,7 +4203,8 @@ model BatchNodeRemoteLoginSettings {
@clientName("UploadBatchServiceLogsContent", "java")
model UploadBatchServiceLogsOptions {
@doc("The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If a user assigned managed identity is not being used, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified.")
containerUrl: string;
@clientName("containerUri", "csharp")
containerUrl: url;

@doc("The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested.")
startTime: utcDateTime;
Expand Down
Loading