Skip to content

[cplat-2024-03-03] Update spec for ValidationProfile #30658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
grizzlytheodore merged 8 commits into from
Oct 28, 2024
Merged

[cplat-2024-03-03] Update spec for ValidationProfile #30658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0df10e5
Update spec with validationsProfile
lkumaar Sep 20, 2024
0436cf4
Add examples for GetGalleryImageVersion with ValidationProfile
lkumaar Sep 20, 2024
d5d0b33
Run jq to format for prettier
lkumaar Sep 20, 2024
011f429
LintDiff - add type:object for new definitions
lkumaar Sep 20, 2024
1a2a5aa
Reorder validationsProfile to preserve param ordering
lkumaar Sep 24, 2024
57c5d22
Make validations profile readonly
lkumaar Oct 9, 2024
c82d906
Merge branch 'feature/cplat-2024-03-03' into gallery-2024-03-03-valid…
Oct 28, 2024
ff6bb6d
Update gallery.json
Oct 28, 2024
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
118 changes: 118 additions & 0 deletions ...le/2024-03-03/examples/galleryExamples/GalleryImageVersion_Get_WithValidationProfile.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"api-version": "2024-03-03",
"galleryName": "myGalleryName",
"galleryImageName": "myGalleryImageName",
"galleryImageVersionName": "1.0.0",
"$expand": "ValidationProfile"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0",
"properties": {
"publishingProfile": {
"targetRegions": [
{
"name": "West US",
"regionalReplicaCount": 1,
"storageAccountType": "Standard_LRS",
"encryption": {
"osDiskImage": {
"diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet"
},
"dataDiskImages": [
{
"lun": 0,
"diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet"
},
{
"lun": 1,
"diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet"
}
]
},
"excludeFromLatest": false
},
{
"name": "East US",
"regionalReplicaCount": 2,
"storageAccountType": "Standard_LRS",
"excludeFromLatest": false
}
],
"replicaCount": 1,
"publishedDate": "2018-01-01T00:00:00Z",
"storageAccountType": "Standard_LRS"
},
"storageProfile": {
"source": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}"
},
"osDiskImage": {
"sizeInGB": 10,
"hostCaching": "ReadOnly"
},
"dataDiskImages": [
{
"lun": 1,
"sizeInGB": 10,
"hostCaching": "None"
}
]
},
"safetyProfile": {
"allowDeletionOfReplicatedLocations": false,
"reportedForPolicyViolation": true,
"policyViolations": [
{
"category": "ImageFlaggedUnsafe",
"details": "This is the policy violation details."
}
]
},
"validationsProfile": {
"executedValidations": [
{
"type": "LinuxSecurityBaseline",
"status": "failed",
"version": "beta",
"executionTime": "2018-01-01T00:00:00Z"
},
{
"type": "AzCertify",
"status": "success",
"version": "10.0.4",
"executionTime": "2018-01-01T00:00:00Z"
}
],
"platformAttributes": [
{
"name": "source_image_publisher",
"value": "publishValue"
},
{
"name": "source_image_offer",
"value": "OfferValue"
},
{
"name": "source_image_sku",
"value": "SkuValue"
},
{
"name": "source_image_version",
"value": "1.0.0"
}
],
"validationEtag": "2018-01-01T00:00:00Z"
},
"provisioningState": "Succeeded"
},
"location": "West US",
"name": "1.0.0"
}
}
}
}
135 changes: 135 additions & 0 deletions ...es/galleryExamples/GalleryImageVersion_Get_WithValidationProfileAndReplicationStatus.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"api-version": "2024-03-03",
"galleryName": "myGalleryName",
"galleryImageName": "myGalleryImageName",
"galleryImageVersionName": "1.0.0",
"$expand": "ValidationProfile,ReplicationStatus"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/locations/westus/Galleries/myGalleryName/Images/myGalleryImageName/Versions/1.0.0",
"properties": {
"publishingProfile": {
"targetRegions": [
{
"name": "West US",
"regionalReplicaCount": 1,
"storageAccountType": "Standard_LRS",
"encryption": {
"osDiskImage": {
"diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet"
},
"dataDiskImages": [
{
"lun": 0,
"diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myOtherDiskEncryptionSet"
},
{
"lun": 1,
"diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myDiskEncryptionSet"
}
]
},
"excludeFromLatest": false
},
{
"name": "East US",
"regionalReplicaCount": 2,
"storageAccountType": "Standard_LRS",
"excludeFromLatest": false
}
],
"replicaCount": 1,
"publishedDate": "2018-01-01T00:00:00Z",
"storageAccountType": "Standard_LRS"
},
"storageProfile": {
"source": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}"
},
"osDiskImage": {
"sizeInGB": 10,
"hostCaching": "ReadOnly"
},
"dataDiskImages": [
{
"lun": 1,
"sizeInGB": 10,
"hostCaching": "None"
}
]
},
"safetyProfile": {
"allowDeletionOfReplicatedLocations": false,
"reportedForPolicyViolation": true,
"policyViolations": [
{
"category": "ImageFlaggedUnsafe",
"details": "This is the policy violation details."
}
]
},
"replicationStatus": {
"aggregatedState": "Completed",
"summary": [
{
"region": "West US",
"state": "Completed",
"details": "",
"progress": 100
},
{
"region": "East US",
"state": "Completed",
"details": "",
"progress": 100
}
]
},
"validationsProfile": {
"executedValidations": [
{
"type": "LinuxSecurityBaseline",
"status": "failed",
"version": "beta",
"executionTime": "2018-01-01T00:00:00Z"
},
{
"type": "AzCertify",
"status": "success",
"version": "10.0.4",
"executionTime": "2018-01-01T00:00:00Z"
}
],
"platformAttributes": [
{
"name": "source_image_publisher",
"value": "publishValue"
},
{
"name": "source_image_offer",
"value": "OfferValue"
},
{
"name": "source_image_sku",
"value": "SkuValue"
},
{
"name": "source_image_version",
"value": "1.0.0"
}
],
"validationEtag": "2018-01-01T00:00:00Z"
},
"provisioningState": "Succeeded"
},
"location": "West US",
"name": "1.0.0"
}
}
}
}
73 changes: 73 additions & 0 deletions ...ation/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/gallery.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -798,6 +798,12 @@
},
"Get a gallery image version with vhd as a source.": {
"$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithVhdAsSource.json"
},
"Get a gallery image version with validation profile.": {
"$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithValidationProfile.json"
},
"Get a gallery image version with validation profile and replication status.": {
"$ref": "./examples/galleryExamples/GalleryImageVersion_Get_WithValidationProfileAndReplicationStatus.json"
}
}
},
Expand Down Expand Up @@ -3832,6 +3838,13 @@
"nextLink": {
"type": "string",
"description": "The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries."
},
"securityProfile": {
"$ref": "#/definitions/ImageVersionSecurityProfile"
},
"validationsProfile": {
"readOnly": true,
"$ref": "#/definitions/ValidationsProfile"
}
},
"required": [
Expand Down Expand Up @@ -4091,6 +4104,29 @@
}
}
},
"ValidationsProfile": {
"type": "object",
"properties": {
"validationEtag": {
"type": "string",
"description": "The published time of the image version"
},
"executedValidations": {
"type": "array",
"items": {
"$ref": "#/definitions/ExecutedValidation"
}
},
"platformAttributes": {
"type": "array",
"items": {
"$ref": "#/definitions/PlatformAttribute"
},
"description": "This specifies the pub, offer, sku and version of the image version metadata"
}
},
"description": "This is the validations profile of a Gallery Image Version."
},
"UefiKey": {
"type": "object",
"description": "A UEFI key signature.",
Expand Down Expand Up @@ -4131,6 +4167,43 @@
],
"description": "Specifies information about the gallery inVMAccessControlProfile that you want to create or update."
},
"ExecutedValidation": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "This property specifies the type of image version validation."
},
"status": {
"type": "string",
"description": "This property specifies the status of the validationProfile of the image version."
},
"version": {
"type": "string",
"description": "This property specifies the valid version of the validation."
},
"executionTime": {
"type": "string",
"format": "date-time",
"description": "This property specifies the starting timestamp."
}
},
"description": "This is the executed Validation."
},
"PlatformAttribute": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This property specifies the name of the platformAttributes. It could be either source_image_publisher or source_image_offer or source_image_sku or source_image_version"
Copy link
Contributor

@grizzlytheodore grizzlytheodore Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want this to be enum? model-as-string?

Copy link
Contributor Author

@lkumaar lkumaar Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

service has this as string, so would like to keep as is

Copy link
Contributor

@grizzlytheodore grizzlytheodore Oct 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its possible to keep as string but have enum values. See:

azure-rest-api-specs/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2024-03-03/gallery.json

Lines 190 to 202 in 57c5d22

{
"name": "$select",
"in": "query",
"required": false,
"type": "string",
"description": "The select expression to apply on the operation.",
"enum": [
"Permissions"
],
"x-ms-enum": {
"name": "SelectPermissions",
"modelAsString": true
}

},
"value": {
"type": "string",
"description": "This property specifies the value of the corresponding name property."
}
},
"description": "This is the platform attribute of the image version."
},
"GalleryInVMAccessControlProfileUpdate": {
"type": "object",
"properties": {
Expand Down