Microsoft.Compute (stable:2024-03-03)

2025/06/25 • 49 new, 49 deleted methods

Galleries_List (new)
Description :  List galleries under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of galleries. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries. ,
Required: False ,
}
string ,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleries_Get (new)
Description :  Get a community gallery by gallery public name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a community gallery. ,
Required: False ,
}
{
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
communityMetadata:
{
Description: The metadata of community gallery. ,
Required: False ,
}
{
publisherUri:
{
Description: The publisher URI of this community gallery. ,
Format: uri ,
Required: False ,
}
string ,
publisherContact:
{
Description: The publisher email id of this community gallery. ,
Required: True ,
}
string ,
eula:
{
Description: The end-user license agreement for this community gallery. ,
Required: False ,
}
string ,
publicNames:
{
Description: A list of public names the gallery has. ,
Required: True ,
}
[
string ,
]
,
privacyStatementUri:
{
Description: The link for the privacy statement of this community gallery from the gallery publisher. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleryImages_List (new)
Description :  List community gallery images inside a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of community gallery images. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the community gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: False ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: False ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
privacyStatementUri:
{
Description: Privacy statement URI for the current community gallery image. ,
Required: False ,
}
string ,
eula:
{
Description: The end-user license agreement for the current community gallery image. ,
Required: False ,
}
string ,
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of community gallery images. Call ListNext() with this to fetch the next page of community gallery images. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleryImages_Get (new)
Description :  Get a community gallery image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the community gallery image definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the community gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: False ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: False ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
privacyStatementUri:
{
Description: Privacy statement URI for the current community gallery image. ,
Required: False ,
}
string ,
eula:
{
Description: The end-user license agreement for the current community gallery image. ,
Required: False ,
}
string ,
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleryImageVersions_List (new)
Description :  List community gallery image versions inside an image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the community gallery image definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of community gallery image versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishedDate:
{
Description: The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. ,
Required: False ,
}
boolean ,
storageProfile:
{
Description: Describes the storage profile of the image version. ,
Required: False ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleryImageVersions_Get (new)
Description :  Get a community gallery image version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the community gallery image definition. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the community gallery image version. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishedDate:
{
Description: The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. ,
Required: False ,
}
boolean ,
storageProfile:
{
Description: Describes the storage profile of the image version. ,
Required: False ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleries_List (new)
Description :  List shared galleries by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
sharedTo:
{
Description: The query parameter to decide what shared galleries to fetch when doing listing operations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of shared galleries. ,
Required: True ,
}
[
{
properties:
{
Description: Specifies the properties of a shared gallery ,
Required: False ,
}
{
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleries_Get (new)
Description :  Get a shared gallery by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Specifies the properties of a shared gallery ,
Required: False ,
}
{
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleryImages_List (new)
Description :  List shared gallery images by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
sharedTo:
{
Description: The query parameter to decide what shared galleries to fetch when doing listing operations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of shared gallery images. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
privacyStatementUri:
{
Description: Privacy statement uri for the current community gallery image. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for the current community gallery image. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleryImages_Get (new)
Description :  Get a shared gallery image by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the Shared Gallery Image Definition from which the Image Versions are to be listed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
privacyStatementUri:
{
Description: Privacy statement uri for the current community gallery image. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for the current community gallery image. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleryImageVersions_List (new)
Description :  List shared gallery image versions by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the Shared Gallery Image Definition from which the Image Versions are to be listed. ,
Required: True ,
}
string ,
sharedTo:
{
Description: The query parameter to decide what shared galleries to fetch when doing listing operations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of shared gallery images versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishedDate:
{
Description: The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. ,
Required: False ,
}
boolean ,
storageProfile:
{
Description: Describes the storage profile of the image version. ,
Required: False ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of shared gallery image versions. Call ListNext() with this to fetch the next page of shared gallery image versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleryImageVersions_Get (new)
Description :  Get a shared gallery image version by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the Shared Gallery Image Definition from which the Image Versions are to be listed. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishedDate:
{
Description: The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. ,
Required: False ,
}
boolean ,
storageProfile:
{
Description: Describes the storage profile of the image version. ,
Required: False ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_ListByResourceGroup (new)
Description :  List galleries under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of galleries. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries. ,
Required: False ,
}
string ,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_Get (new)
Description :  Retrieves information about a Shared Image Gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$select:
{
Description: The select expression to apply on the operation. ,
Required: False ,
}
string ,
$expand:
{
Description: The expand query option to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_CreateOrUpdate (new)
Description :  Create or update a Shared Image Gallery.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
gallery:
{
Description: Parameters supplied to the create or update Shared Image Gallery operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_Update (new)
Description :  Update a Shared Image Gallery.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
gallery:
{
Description: Parameters supplied to the update Shared Image Gallery operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_Delete (new)
Description :  Delete a Shared Image Gallery.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_ListByGallery (new)
Description :  List gallery Application Definitions in a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery from which Application Definitions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Gallery Applications. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_Get (new)
Description :  Retrieves information about a gallery Application Definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery from which the Application Definitions are to be retrieved. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition to be retrieved. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_CreateOrUpdate (new)
Description :  Create or update a gallery Application Definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition is to be created. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryApplication:
{
Description: Parameters supplied to the create or update gallery Application operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_Update (new)
Description :  Update a gallery Application Definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition is to be updated. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryApplication:
{
Description: Parameters supplied to the update gallery Application operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_Delete (new)
Description :  Delete a gallery Application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition is to be deleted. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_ListByGalleryApplication (new)
Description :  List gallery Application Versions in a gallery Application Definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of gallery Application Versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_Get (new)
Description :  Retrieves information about a gallery Application Version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition in which the Application Version resides. ,
Required: True ,
}
string ,
galleryApplicationVersionName:
{
Description: The name of the gallery Application Version to be retrieved. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_CreateOrUpdate (new)
Description :  Create or update a gallery Application Version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition in which the Application Version is to be created. ,
Required: True ,
}
string ,
galleryApplicationVersionName:
{
Description: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryApplicationVersion:
{
Description: Parameters supplied to the create or update gallery Application Version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_Update (new)
Description :  Update a gallery Application Version.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition in which the Application Version is to be updated. ,
Required: True ,
}
string ,
galleryApplicationVersionName:
{
Description: The name of the gallery Application Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryApplicationVersion:
{
Description: Parameters supplied to the update gallery Application Version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_Delete (new)
Description :  Delete a gallery Application Version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition in which the Application Version resides. ,
Required: True ,
}
string ,
galleryApplicationVersionName:
{
Description: The name of the gallery Application Version to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_ListByGallery (new)
Description :  List gallery image definitions in a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery from which Image Definitions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Shared Image Gallery images. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_Get (new)
Description :  Retrieves information about a gallery image definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition to be retrieved. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_CreateOrUpdate (new)
Description :  Create or update a gallery image definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition is to be created. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryImage:
{
Description: Parameters supplied to the create or update gallery image operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_Update (new)
Description :  Update a gallery image definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition is to be updated. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryImage:
{
Description: Parameters supplied to the update gallery image operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_Delete (new)
Description :  Delete a gallery image.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition is to be deleted. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_ListByGalleryImage (new)
Description :  List gallery image versions in a gallery image definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of gallery image versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_Get (new)
Description :  Retrieves information about a gallery image version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition in which the Image Version resides. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be retrieved. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_CreateOrUpdate (new)
Description :  Create or update a gallery image version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition in which the Image Version is to be created. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryImageVersion:
{
Description: Parameters supplied to the create or update gallery image version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_Update (new)
Description :  Update a gallery image version.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition in which the Image Version is to be updated. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryImageVersion:
{
Description: Parameters supplied to the update gallery image version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_Delete (new)
Description :  Delete a gallery image version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition in which the Image Version resides. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_ListByGallery (new)
Description :  List gallery inVMAccessControlProfiles in a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery from which the InVMAccessControlProfiles are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Gallery InVMAccessControlProfiles. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of inVMAccessControlProfiles in the gallery. Call ListNext() with this to fetch the next page of gallery inVMAccessControlProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_Get (new)
Description :  Retrieves information about a gallery inVMAccessControlProfile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery from which the InVMAccessControlProfiles are to be retrieved. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile to be retrieved. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_CreateOrUpdate (new)
Description :  Create or update a gallery inVMAccessControlProfile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the InVMAccessControlProfile is to be created. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryInVMAccessControlProfile:
{
Description: Parameters supplied to the create or update gallery inVMAccessControlProfile operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_Update (new)
Description :  Update a gallery inVMAccessControlProfile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the InVMAccessControlProfile is to be updated. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryInVMAccessControlProfile:
{
Description: Parameters supplied to the update gallery inVMAccessControlProfile operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_Delete (new)
Description :  Delete a gallery inVMAccessControlProfile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: he name of the Shared Image Gallery in which the InVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_ListByGalleryInVMAccessControlProfile (new)
Description :  List gallery inVMAccessControlProfile versions in a gallery inVMAccessControlProfile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile from which the inVMAccessControlProfile versions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Gallery InVMAccessControlProfile Versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of inVMAccessControlProfile versions. Call ListNext() with this to fetch the next page of gallery inVMAccessControlProfile versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_Get (new)
Description :  Retrieves information about a gallery inVMAccessControlProfile version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions/{inVMAccessControlProfileVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile in which the inVMAccessControlProfile version resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileVersionName:
{
Description: The name of the gallery inVMAccessControlProfile version to be retrieved. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_CreateOrUpdate (new)
Description :  Create or update a gallery inVMAccessControlProfile version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions/{inVMAccessControlProfileVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile in which the inVMAccessControlProfile version is to be created. ,
Required: True ,
}
string ,
inVMAccessControlProfileVersionName:
{
Description: The name of the gallery inVMAccessControlProfile version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryInVMAccessControlProfileVersion:
{
Description: Parameters supplied to the create or update gallery inVMAccessControlProfile version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_Update (new)
Description :  Update a gallery inVMAccessControlProfile version.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions/{inVMAccessControlProfileVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile in which the inVMAccessControlProfile version is to be updated. ,
Required: True ,
}
string ,
inVMAccessControlProfileVersionName:
{
Description: The name of the gallery inVMAccessControlProfile version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryInVMAccessControlProfileVersion:
{
Description: Parameters supplied to the update gallery inVMAccessControlProfile version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_Delete (new)
Description :  Delete a gallery inVMAccessControlProfile version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions/{inVMAccessControlProfileVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile in which the inVMAccessControlProfile version resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileVersionName:
{
Description: The name of the gallery inVMAccessControlProfile version to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GallerySharingProfile_Update (new)
Description :  Update sharing profile of a gallery.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/share
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
sharingUpdate:
{
Description: Parameters supplied to the update gallery sharing profile. ,
Required: True ,
}
{
operationType:
{
Description: This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.** ,
Enum:
{
Add: No description available. ,
Remove: No description available. ,
Reset: No description available. ,
EnableCommunity: No description available. ,
}
,
Required: True ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
operationType:
{
Description: This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.** ,
Enum:
{
Add: No description available. ,
Remove: No description available. ,
Reset: No description available. ,
EnableCommunity: No description available. ,
}
,
Required: True ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (202)

{
operationType:
{
Description: This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.** ,
Enum:
{
Add: No description available. ,
Remove: No description available. ,
Reset: No description available. ,
EnableCommunity: No description available. ,
}
,
Required: True ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SoftDeletedResource_ListByArtifactName (new)
Description :  List soft-deleted resources of an artifact in the gallery, such as soft-deleted gallery image version of an image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/softdeletedartifacttypes/{artifactType}/artifacts/{artifactName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Gallery in which the soft-deleted resources resides. ,
Required: True ,
}
string ,
artifactType:
{
Description: The type of the artifact to be listed, such as gallery image version. ,
Required: True ,
}
string ,
artifactName:
{
Description: The artifact name to be listed. If artifact type is Images, then the artifact name should be the gallery image name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of soft-deleted resources. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a soft-deleted resource. ,
Required: False ,
}
{
resourceArmId:
{
Description: arm id of the soft-deleted resource ,
Format: arm-id ,
Required: False ,
}
string ,
softDeletedArtifactType:
{
Description: artifact type of the soft-deleted resource ,
Enum:
{
Images: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletedTime:
{
Description: The timestamp for when the resource is soft-deleted. In dateTime offset format. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of soft-deleted resources. Call ListNext() with this to fetch the next page of soft-deleted resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleries_Get (removed)
Description :  Get a community gallery by gallery public name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a community gallery. ,
Required: False ,
}
{
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
communityMetadata:
{
Description: The metadata of community gallery. ,
Required: False ,
}
{
publisherUri:
{
Description: The publisher URI of this community gallery. ,
Format: uri ,
Required: False ,
}
string ,
publisherContact:
{
Description: The publisher email id of this community gallery. ,
Required: True ,
}
string ,
eula:
{
Description: The end-user license agreement for this community gallery. ,
Required: False ,
}
string ,
publicNames:
{
Description: A list of public names the gallery has. ,
Required: True ,
}
[
string ,
]
,
privacyStatementUri:
{
Description: The link for the privacy statement of this community gallery from the gallery publisher. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleryImages_Get (removed)
Description :  Get a community gallery image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the community gallery image definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the community gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: False ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: False ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
privacyStatementUri:
{
Description: Privacy statement URI for the current community gallery image. ,
Required: False ,
}
string ,
eula:
{
Description: The end-user license agreement for the current community gallery image. ,
Required: False ,
}
string ,
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleryImageVersions_Get (removed)
Description :  Get a community gallery image version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the community gallery image definition. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the community gallery image version. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishedDate:
{
Description: The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. ,
Required: False ,
}
boolean ,
storageProfile:
{
Description: Describes the storage profile of the image version. ,
Required: False ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleryImages_List (removed)
Description :  List community gallery images inside a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of community gallery images. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the community gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: False ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: False ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: False ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
privacyStatementUri:
{
Description: Privacy statement URI for the current community gallery image. ,
Required: False ,
}
string ,
eula:
{
Description: The end-user license agreement for the current community gallery image. ,
Required: False ,
}
string ,
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of community gallery images. Call ListNext() with this to fetch the next page of community gallery images. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
CommunityGalleryImageVersions_List (removed)
Description :  List community gallery image versions inside an image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/communityGalleries/{publicGalleryName}/images/{galleryImageName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
publicGalleryName:
{
Description: The public name of the community gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the community gallery image definition. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of community gallery image versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishedDate:
{
Description: The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. ,
Required: False ,
}
boolean ,
storageProfile:
{
Description: Describes the storage profile of the image version. ,
Required: False ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
disclaimer:
{
Description: The disclaimer for a community gallery resource. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a community gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of community gallery image versions. Call ListNext() with this to fetch the next page of community gallery image versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_CreateOrUpdate (removed)
Description :  Create or update a Shared Image Gallery.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
gallery:
{
Description: Parameters supplied to the create or update Shared Image Gallery operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_Update (removed)
Description :  Update a Shared Image Gallery.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery. The allowed characters are alphabets and numbers with dots and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
gallery:
{
Description: Parameters supplied to the update Shared Image Gallery operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_Get (removed)
Description :  Retrieves information about a Shared Image Gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$select:
{
Description: The select expression to apply on the operation. ,
Required: False ,
}
string ,
$expand:
{
Description: The expand query option to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_Delete (removed)
Description :  Delete a Shared Image Gallery.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_CreateOrUpdate (removed)
Description :  Create or update a gallery image definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition is to be created. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryImage:
{
Description: Parameters supplied to the create or update gallery image operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_Update (removed)
Description :  Update a gallery image definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition is to be updated. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryImage:
{
Description: Parameters supplied to the update gallery image operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_Get (removed)
Description :  Retrieves information about a gallery image definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery from which the Image Definitions are to be retrieved. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition to be retrieved. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_Delete (removed)
Description :  Delete a gallery image.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition is to be deleted. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_CreateOrUpdate (removed)
Description :  Create or update a gallery image version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition in which the Image Version is to be created. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryImageVersion:
{
Description: Parameters supplied to the create or update gallery image version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_Update (removed)
Description :  Update a gallery image version.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition in which the Image Version is to be updated. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryImageVersion:
{
Description: Parameters supplied to the update gallery image version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_Get (removed)
Description :  Retrieves information about a gallery image version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition in which the Image Version resides. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be retrieved. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_Delete (removed)
Description :  Delete a gallery image version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the gallery image definition in which the Image Version resides. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_CreateOrUpdate (removed)
Description :  Create or update a gallery Application Definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition is to be created. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryApplication:
{
Description: Parameters supplied to the create or update gallery Application operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_Update (removed)
Description :  Update a gallery Application Definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition is to be updated. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryApplication:
{
Description: Parameters supplied to the update gallery Application operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_Get (removed)
Description :  Retrieves information about a gallery Application Definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery from which the Application Definitions are to be retrieved. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition to be retrieved. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_Delete (removed)
Description :  Delete a gallery Application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition is to be deleted. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_CreateOrUpdate (removed)
Description :  Create or update a gallery Application Version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition in which the Application Version is to be created. ,
Required: True ,
}
string ,
galleryApplicationVersionName:
{
Description: The name of the gallery Application Version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryApplicationVersion:
{
Description: Parameters supplied to the create or update gallery Application Version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_Update (removed)
Description :  Update a gallery Application Version.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition in which the Application Version is to be updated. ,
Required: True ,
}
string ,
galleryApplicationVersionName:
{
Description: The name of the gallery Application Version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryApplicationVersion:
{
Description: Parameters supplied to the update gallery Application Version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_Get (removed)
Description :  Retrieves information about a gallery Application Version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition in which the Application Version resides. ,
Required: True ,
}
string ,
galleryApplicationVersionName:
{
Description: The name of the gallery Application Version to be retrieved. ,
Required: True ,
}
string ,
$expand:
{
Description: The expand expression to apply on the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_Delete (removed)
Description :  Delete a gallery Application Version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions/{galleryApplicationVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the gallery Application Definition in which the Application Version resides. ,
Required: True ,
}
string ,
galleryApplicationVersionName:
{
Description: The name of the gallery Application Version to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_ListByResourceGroup (removed)
Description :  List galleries under a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of galleries. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries. ,
Required: False ,
}
string ,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
Galleries_List (removed)
Description :  List galleries under a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/galleries
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of galleries. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a Shared Image Gallery. ,
Required: False ,
}
{
description:
{
Description: The description of this Shared Image Gallery resource. This property is updatable. ,
Required: False ,
}
string ,
identifier:
{
Description: Describes the gallery unique name. ,
Required: False ,
}
{
uniqueName:
{
Description: The unique name of the Shared Image Gallery. This name is generated automatically by Azure. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
sharingProfile:
{
Description: Profile for gallery sharing to subscription or tenant ,
Required: False ,
}
{
permissions:
{
Description: This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** ,
Enum:
{
Private: No description available. ,
Groups: No description available. ,
Community: No description available. ,
}
,
Required: False ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
communityGalleryInfo:
{
Description: Information of community gallery if current gallery is shared to community. ,
Required: False ,
}
{
publisherUri:
{
Description: The link to the publisher website. Visible to all users. ,
Required: False ,
}
string ,
publisherContact:
{
Description: Community gallery publisher support email. The email address of the publisher. Visible to all users. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for community gallery image. ,
Required: False ,
}
string ,
publicNamePrefix:
{
Description: The prefix of the gallery name that will be displayed publicly. Visible to all users. ,
Required: False ,
}
string ,
communityGalleryEnabled:
{
Description: Contains info about whether community gallery sharing is enabled. ,
Required: False ,
}
boolean ,
publicNames:
{
Description: Community gallery public name list. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
softDeletePolicy:
{
Description: Contains information about the soft deletion policy of the gallery. ,
Required: False ,
}
{
isSoftDeleteEnabled:
{
Description: Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. ,
Required: False ,
}
boolean ,
}
,
sharingStatus:
{
Description: Sharing status of current gallery. ,
Required: False ,
}
{
aggregatedState:
{
Description: Aggregated sharing state of current gallery. ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary of all regional sharing status. ,
Required: False ,
}
[
{
region:
{
Description: Region name ,
Required: False ,
}
string ,
state:
{
Description: Gallery sharing state in current region ,
Enum:
{
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Details of gallery regional sharing failure. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
identity:
{
Description: The identity of the gallery, if configured. ,
Required: False ,
}
{
principalId:
{
Description: The principal id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. ,
Required: False ,
}
string ,
type:
{
Description: The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of galleries. Call ListNext() with this to fetch the next page of galleries. ,
Required: False ,
}
string ,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImages_ListByGallery (removed)
Description :  List gallery image definitions in a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery from which Image Definitions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Shared Image Gallery images. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery image definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery image definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
allowUpdateImage:
{
Description: Optional. Must be set to true if the gallery image features are being updated. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Image Definitions in the Shared Image Gallery. Call ListNext() with this to fetch the next page of gallery image definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryImageVersions_ListByGalleryImage (removed)
Description :  List gallery image versions in a gallery image definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{galleryImageName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the Image Definition resides. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the Shared Image Gallery Image Definition from which the Image Versions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of gallery image versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image Version. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
storageProfile:
{
Description: This is the storage profile of a Gallery Image Version. ,
Required: True ,
}
{
source:
{
Description: The source of the gallery artifact version. ,
Required: False ,
}
{
communityGalleryImageId:
{
Description: The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. ,
Required: False ,
}
string ,
virtualMachineId:
{
Description: The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. ,
Required: False ,
}
string ,
}
,
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
safetyProfile:
{
Description: This is the safety profile of the Gallery Image Version. ,
Required: False ,
}
{
reportedForPolicyViolation:
{
Description: Indicates whether this image has been reported as violating Microsoft's policies. ,
Required: False ,
}
boolean ,
policyViolations:
{
Description: A list of Policy Violations that have been reported for this Gallery Image Version. ,
Required: False ,
}
[
{
category:
{
Description: Describes the nature of the policy violation. ,
Enum:
{
Other: No description available. ,
ImageFlaggedUnsafe: No description available. ,
CopyrightValidation: No description available. ,
IpTheft: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Describes specific details about why this policy violation was reported. ,
Required: False ,
}
string ,
}
,
]
,
blockDeletionBeforeEndOfLife:
{
Description: Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. ,
Required: False ,
}
boolean ,
}
,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
securityProfile:
{
Description: The security profile of a gallery image version ,
Required: False ,
}
{
uefiSettings:
{
Description: Contains UEFI settings for the image version. ,
Required: False ,
}
{
signatureTemplateNames:
{
Description: The name of the template(s) that contains default UEFI key signatures that will be added to the image. ,
Required: False ,
}
[
string ,
]
,
additionalSignatures:
{
Description: Additional UEFI key signatures that will be added to the image in addition to the signature templates ,
Required: False ,
}
{
pk:
{
Description: The Platform Key of this image version. ,
Required: False ,
}
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
kek:
{
Description: The Key Encryption Keys of this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
db:
{
Description: The database of UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dbx:
{
Description: The database of revoked UEFI keys for this image version. ,
Required: False ,
}
[
{
type:
{
Description: The type of key signature. ,
Enum:
{
sha256: No description available. ,
x509: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The value of the key signature. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
restore:
{
Description: Indicates if this is a soft-delete resource restoration request. ,
Required: False ,
}
boolean ,
validationsProfile:
{
Description: This is the validations profile of a Gallery Image Version. ,
Required: False ,
}
{
validationEtag:
{
Description: The published time of the image version ,
Required: False ,
}
string ,
executedValidations:
{
Required: False ,
}
[
{
type:
{
Description: This property specifies the type of image version validation. ,
Required: False ,
}
string ,
status:
{
Description: This property specifies the status of the validationProfile of the image version. ,
Enum:
{
Unknown: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: This property specifies the valid version of the validation. ,
Required: False ,
}
string ,
executionTime:
{
Description: This property specifies the starting timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
platformAttributes:
{
Description: This specifies the pub, offer, sku and version of the image version metadata ,
Required: False ,
}
[
{
name:
{
Description: This property specifies the name of the platformAttribute. It is read-only. ,
Required: False ,
}
string ,
value:
{
Description: This property specifies the value of the corresponding name property. It is read-only. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of gallery image versions. Call ListNext() with this to fetch the next page of gallery image versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplications_ListByGallery (removed)
Description :  List gallery Application Definitions in a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery from which Application Definitions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Gallery Applications. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery Application Definition. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery Application Definition resource. This property is updatable. ,
Required: False ,
}
string ,
eula:
{
Description: The Eula agreement for the gallery Application Definition. ,
Required: False ,
}
string ,
privacyStatementUri:
{
Description: The privacy statement uri. ,
Required: False ,
}
string ,
releaseNoteUri:
{
Description: The release note uri. ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery Application Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
supportedOSType:
{
Description: This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
customActions:
{
Description: A list of custom actions that can be performed with all of the Gallery Application Versions within this Gallery Application. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of Application Definitions in the Application Gallery. Call ListNext() with this to fetch the next page of gallery Application Definitions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryApplicationVersions_ListByGalleryApplication (removed)
Description :  List gallery Application Versions in a gallery Application Definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{galleryApplicationName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Application Gallery in which the Application Definition resides. ,
Required: True ,
}
string ,
galleryApplicationName:
{
Description: The name of the Shared Application Gallery Application Definition from which the Application Versions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of gallery Application Versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishingProfile:
{
Description: The publishing profile of a gallery image version. ,
Required: True ,
}
{
source:
{
Description: The source image from which the Image Version is going to be created. ,
Required: True ,
}
{
mediaLink:
{
Description: Required. The mediaLink of the artifact, must be a readable storage page blob. ,
Required: True ,
}
string ,
defaultConfigurationLink:
{
Description: Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. ,
Required: False ,
}
string ,
}
,
manageActions:
{
Required: False ,
}
{
install:
{
Description: Required. The path and arguments to install the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
remove:
{
Description: Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. ,
Required: True ,
}
string ,
update:
{
Description: Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. ,
Required: False ,
}
string ,
}
,
settings:
{
Description: Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. ,
Required: False ,
}
{
packageFileName:
{
Description: Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. ,
Required: False ,
}
string ,
configFileName:
{
Description: Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". ,
Required: False ,
}
string ,
scriptBehaviorAfterReboot:
{
Description: Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. ,
Enum:
{
None: No description available. ,
Rerun: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
advancedSettings:
{
Description: Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. ,
Required: False ,
}
object ,
enableHealthCheck:
{
Description: Optional. Whether or not this application reports health. ,
Required: False ,
}
boolean ,
customActions:
{
Description: A list of custom actions that can be performed with this Gallery Application Version. ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
script:
{
Description: The script to run when executing this custom action. ,
Required: True ,
}
string ,
description:
{
Description: Description to help the users understand what this custom action does. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters that this custom action uses ,
Required: False ,
}
[
{
name:
{
Description: The name of the custom action. Must be unique within the Gallery Application Version. ,
Required: True ,
}
string ,
required:
{
Description: Indicates whether this parameter must be passed when running the custom action. ,
Required: False ,
}
boolean ,
type:
{
Description: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob ,
Enum:
{
String: No description available. ,
ConfigurationDataBlob: No description available. ,
LogOutputBlob: No description available. ,
}
,
Required: False ,
}
enum ,
defaultValue:
{
Description: The default value of the parameter. Only applies to string types ,
Required: False ,
}
string ,
description:
{
Description: A description to help users understand what this parameter means ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
safetyProfile:
{
Description: The safety profile of the Gallery Application Version. ,
Required: False ,
}
object ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
replicationStatus:
{
Description: This is the replication status of the gallery image version. ,
Required: False ,
}
{
aggregatedState:
{
Description: This is the aggregated replication status based on all the regional replication status flags. ,
Enum:
{
Unknown: No description available. ,
InProgress: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: This is a summary of replication status for each region. ,
Required: False ,
}
[
{
region:
{
Description: The region to which the gallery image version is being replicated to. ,
Required: False ,
}
string ,
state:
{
Description: This is the regional replication state. ,
Enum:
{
Unknown: No description available. ,
Replicating: No description available. ,
Completed: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: The details of the replication status. ,
Required: False ,
}
string ,
progress:
{
Description: It indicates progress of the replication job. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of gallery Application Versions. Call ListNext() with this to fetch the next page of gallery Application Versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SoftDeletedResource_ListByArtifactName (removed)
Description :  List soft-deleted resources of an artifact in the gallery, such as soft-deleted gallery image version of an image.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/softDeletedArtifactTypes/{artifactType}/artifacts/{artifactName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Gallery in which the soft-deleted resources resides. ,
Required: True ,
}
string ,
artifactType:
{
Description: The type of the artifact to be listed, such as gallery image version. ,
Required: True ,
}
string ,
artifactName:
{
Description: The artifact name to be listed. If artifact type is Images, then the artifact name should be the gallery image name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of soft-deleted resources. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a soft-deleted resource. ,
Required: False ,
}
{
resourceArmId:
{
Description: arm id of the soft-deleted resource ,
Format: arm-id ,
Required: False ,
}
string ,
softDeletedArtifactType:
{
Description: artifact type of the soft-deleted resource ,
Enum:
{
Images: No description available. ,
}
,
Required: False ,
}
enum ,
softDeletedTime:
{
Description: The timestamp for when the resource is soft-deleted. In dateTime offset format. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of soft-deleted resources. Call ListNext() with this to fetch the next page of soft-deleted resources. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GallerySharingProfile_Update (removed)
Description :  Update sharing profile of a gallery.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/share
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
sharingUpdate:
{
Description: Parameters supplied to the update gallery sharing profile. ,
Required: True ,
}
{
operationType:
{
Description: This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.** ,
Enum:
{
Add: No description available. ,
Remove: No description available. ,
Reset: No description available. ,
EnableCommunity: No description available. ,
}
,
Required: True ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
operationType:
{
Description: This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.** ,
Enum:
{
Add: No description available. ,
Remove: No description available. ,
Reset: No description available. ,
EnableCommunity: No description available. ,
}
,
Required: True ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (202)

{
operationType:
{
Description: This property allows you to specify the operation type of gallery sharing update. Possible values are: **Add,** **Remove,** **Reset.** ,
Enum:
{
Add: No description available. ,
Remove: No description available. ,
Reset: No description available. ,
EnableCommunity: No description available. ,
}
,
Required: True ,
}
enum ,
groups:
{
Description: A list of sharing profile groups. ,
Required: False ,
}
[
{
type:
{
Description: This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** ,
Enum:
{
Subscriptions: No description available. ,
AADTenants: No description available. ,
}
,
Required: False ,
}
enum ,
ids:
{
Description: A list of subscription/tenant ids the gallery is aimed to be shared to. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_CreateOrUpdate (removed)
Description :  Create or update a gallery inVMAccessControlProfile.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the InVMAccessControlProfile is to be created. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile to be created or updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryInVMAccessControlProfile:
{
Description: Parameters supplied to the create or update gallery inVMAccessControlProfile operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_Update (removed)
Description :  Update a gallery inVMAccessControlProfile.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the InVMAccessControlProfile is to be updated. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile to be updated. The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle. The maximum length is 80 characters. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryInVMAccessControlProfile:
{
Description: Parameters supplied to the update gallery inVMAccessControlProfile operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_Get (removed)
Description :  Retrieves information about a gallery inVMAccessControlProfile.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery from which the InVMAccessControlProfiles are to be retrieved. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile to be retrieved. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_Delete (removed)
Description :  Delete a gallery inVMAccessControlProfile.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: he name of the Shared Image Gallery in which the InVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_CreateOrUpdate (removed)
Description :  Create or update a gallery inVMAccessControlProfile version.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions/{inVMAccessControlProfileVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile in which the inVMAccessControlProfile version is to be created. ,
Required: True ,
}
string ,
inVMAccessControlProfileVersionName:
{
Description: The name of the gallery inVMAccessControlProfile version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryInVMAccessControlProfileVersion:
{
Description: Parameters supplied to the create or update gallery inVMAccessControlProfile version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_Update (removed)
Description :  Update a gallery inVMAccessControlProfile version.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions/{inVMAccessControlProfileVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile in which the inVMAccessControlProfile version is to be updated. ,
Required: True ,
}
string ,
inVMAccessControlProfileVersionName:
{
Description: The name of the gallery inVMAccessControlProfile version to be updated. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryInVMAccessControlProfileVersion:
{
Description: Parameters supplied to the update gallery inVMAccessControlProfile version operation. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_Get (removed)
Description :  Retrieves information about a gallery inVMAccessControlProfile version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions/{inVMAccessControlProfileVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile in which the inVMAccessControlProfile version resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileVersionName:
{
Description: The name of the gallery inVMAccessControlProfile version to be retrieved. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_Delete (removed)
Description :  Delete a gallery inVMAccessControlProfile version.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions/{inVMAccessControlProfileVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile in which the inVMAccessControlProfile version resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileVersionName:
{
Description: The name of the gallery inVMAccessControlProfile version to be deleted. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
azure-asyncoperation: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfiles_ListByGallery (removed)
Description :  List gallery inVMAccessControlProfiles in a gallery.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery from which the InVMAccessControlProfiles are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Gallery InVMAccessControlProfiles. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery inVMAccessControlProfile. ,
Required: False ,
}
{
description:
{
Description: The description of this gallery inVMAccessControlProfile resources. This property is updatable. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
applicableHostEndpoint:
{
Description: This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' ,
Enum:
{
WireServer: No description available. ,
IMDS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of inVMAccessControlProfiles in the gallery. Call ListNext() with this to fetch the next page of gallery inVMAccessControlProfiles. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GalleryInVMAccessControlProfileVersions_ListByGalleryInVMAccessControlProfile (removed)
Description :  List gallery inVMAccessControlProfile versions in a gallery inVMAccessControlProfile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{inVMAccessControlProfileName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
galleryName:
{
Description: The name of the Shared Image Gallery in which the inVMAccessControlProfile resides. ,
Required: True ,
}
string ,
inVMAccessControlProfileName:
{
Description: The name of the gallery inVMAccessControlProfile from which the inVMAccessControlProfile versions are to be listed. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Gallery InVMAccessControlProfile Versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of an inVMAccessControlProfile version. ,
Required: False ,
}
{
mode:
{
Description: This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. ,
Enum:
{
Audit: No description available. ,
Enforce: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
defaultAccess:
{
Description: This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: True ,
}
enum ,
rules:
{
Description: This is the Access Control Rules specification for an inVMAccessControlProfile version. ,
Required: False ,
}
{
privileges:
{
Description: A list of privileges. ,
Required: False ,
}
[
{
name:
{
Description: The name of the privilege. ,
Required: True ,
}
string ,
path:
{
Description: The HTTP path corresponding to the privilege. ,
Required: True ,
}
string ,
queryParameters:
{
Description: The query parameters to match in the path. ,
Required: False ,
}
object ,
}
,
]
,
roles:
{
Description: A list of roles. ,
Required: False ,
}
[
{
name:
{
Description: The name of the role. ,
Required: True ,
}
string ,
privileges:
{
Description: A list of privileges needed by this role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
identities:
{
Description: A list of identities. ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity. ,
Required: True ,
}
string ,
userName:
{
Description: The username corresponding to this identity. ,
Required: False ,
}
string ,
groupName:
{
Description: The groupName corresponding to this identity. ,
Required: False ,
}
string ,
exePath:
{
Description: The path to the executable. ,
Required: False ,
}
string ,
processName:
{
Description: The process name of the executable. ,
Required: False ,
}
string ,
}
,
]
,
roleAssignments:
{
Description: A list of role assignments. ,
Required: False ,
}
[
{
role:
{
Description: The name of the role. ,
Required: True ,
}
string ,
identities:
{
Description: A list of identities that can access the privileges defined by the role. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of inVMAccessControlProfile versions. Call ListNext() with this to fetch the next page of gallery inVMAccessControlProfile versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleries_List (removed)
Description :  List shared galleries by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
sharedTo:
{
Description: The query parameter to decide what shared galleries to fetch when doing listing operations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of shared galleries. ,
Required: True ,
}
[
{
properties:
{
Description: Specifies the properties of a shared gallery ,
Required: False ,
}
{
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of shared galleries. Call ListNext() with this to fetch the next page of shared galleries. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleryImages_List (removed)
Description :  List shared gallery images by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
sharedTo:
{
Description: The query parameter to decide what shared galleries to fetch when doing listing operations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of shared gallery images. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
privacyStatementUri:
{
Description: Privacy statement uri for the current community gallery image. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for the current community gallery image. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of shared gallery images. Call ListNext() with this to fetch the next page of shared gallery images. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleryImageVersions_List (removed)
Description :  List shared gallery image versions by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the Shared Gallery Image Definition from which the Image Versions are to be listed. ,
Required: True ,
}
string ,
sharedTo:
{
Description: The query parameter to decide what shared galleries to fetch when doing listing operations. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of shared gallery images versions. ,
Required: True ,
}
[
{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishedDate:
{
Description: The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. ,
Required: False ,
}
boolean ,
storageProfile:
{
Description: Describes the storage profile of the image version. ,
Required: False ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The uri to fetch the next page of shared gallery image versions. Call ListNext() with this to fetch the next page of shared gallery image versions. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleries_Get (removed)
Description :  Get a shared gallery by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Specifies the properties of a shared gallery ,
Required: False ,
}
{
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleryImages_Get (removed)
Description :  Get a shared gallery image by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the Shared Gallery Image Definition from which the Image Versions are to be listed. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image definition. ,
Required: False ,
}
{
osType:
{
Description: This property allows you to specify the type of the OS that is included in the disk when creating a VM from a managed image. Possible values are: **Windows,** **Linux.** ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
osState:
{
Description: This property allows the user to specify whether the virtual machines created under this image are 'Generalized' or 'Specialized'. ,
Enum:
{
Generalized: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
endOfLifeDate:
{
Description: The end of life date of the gallery image definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
identifier:
{
Description: This is the gallery image definition identifier. ,
Required: True ,
}
{
publisher:
{
Description: The name of the gallery image definition publisher. ,
Required: True ,
}
string ,
offer:
{
Description: The name of the gallery image definition offer. ,
Required: True ,
}
string ,
sku:
{
Description: The name of the gallery image definition SKU. ,
Required: True ,
}
string ,
}
,
recommended:
{
Description: The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. ,
Required: False ,
}
{
vCPUs:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
memory:
{
Description: Describes the resource range. ,
Required: False ,
}
{
min:
{
Description: The minimum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
max:
{
Description: The maximum number of the resource. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
disallowed:
{
Description: Describes the disallowed disk types. ,
Required: False ,
}
{
diskTypes:
{
Description: A list of disk types. ,
Required: False ,
}
[
string ,
]
,
}
,
hyperVGeneration:
{
Description: The hypervisor generation of the Virtual Machine. Applicable to OS disks only. ,
Enum:
{
V1: No description available. ,
V2: No description available. ,
}
,
Required: False ,
}
enum ,
features:
{
Description: A list of gallery image features. ,
Required: False ,
}
[
{
name:
{
Description: The name of the gallery image feature. ,
Required: False ,
}
string ,
value:
{
Description: The value of the gallery image feature. ,
Required: False ,
}
string ,
startsAtVersion:
{
Description: The minimum gallery image version which supports this feature. ,
Required: False ,
}
string ,
}
,
]
,
purchasePlan:
{
Description: Describes the gallery image definition purchase plan. This is used by marketplace images. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The product ID. ,
Required: False ,
}
string ,
}
,
architecture:
{
Description: The architecture of the image. Applicable to OS disks only. ,
Enum:
{
x64: No description available. ,
Arm64: No description available. ,
}
,
Required: False ,
}
enum ,
privacyStatementUri:
{
Description: Privacy statement uri for the current community gallery image. ,
Required: False ,
}
string ,
eula:
{
Description: End-user license agreement for the current community gallery image. ,
Required: False ,
}
string ,
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
SharedGalleryImageVersions_Get (removed)
Description :  Get a shared gallery image version by subscription id or tenant id.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/sharedGalleries/{galleryUniqueName}/images/{galleryImageName}/versions/{galleryImageVersionName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
galleryUniqueName:
{
Description: The unique name of the Shared Gallery. ,
Required: True ,
}
string ,
galleryImageName:
{
Description: The name of the Shared Gallery Image Definition from which the Image Versions are to be listed. ,
Required: True ,
}
string ,
galleryImageVersionName:
{
Description: The name of the gallery image version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: .. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a gallery image version. ,
Required: False ,
}
{
publishedDate:
{
Description: The published date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
endOfLifeDate:
{
Description: The end of life date of the gallery image version Definition. This property can be used for decommissioning purposes. This property is updatable. ,
Format: date-time ,
Required: False ,
}
string ,
excludeFromLatest:
{
Description: If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. ,
Required: False ,
}
boolean ,
storageProfile:
{
Description: Describes the storage profile of the image version. ,
Required: False ,
}
{
osDiskImage:
{
Description: This is the OS disk image. ,
Required: False ,
}
string ,
dataDiskImages:
{
Description: A list of data disk images. ,
Required: False ,
}
[
{
lun:
{
Description: This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
artifactTags:
{
Description: The artifact tags of a shared gallery resource. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}