Skip to content

Commit 2c0bef6

Browse files
authored
[AutoPR compute/resource-manager] More detail added to the descriptions. (#3379)
* Generated from 3e469dd4a038e012849e46c67479c06383438b59 More detail added to the descriptions. Changes made to description strings. * Generated from 67ce182a3a8d197dc80e43e909f4497f5187447e Addressed review comments Addressed review comments on the updateable fields. * Generated from a92afaeaf927c92e6784981875d29e83174a6e07 Added another updateable property description Added another updateable property description
1 parent e2fd2c5 commit 2c0bef6

37 files changed

+194
-143
lines changed

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313

1414

1515
class Gallery(Resource):
16-
"""Specifies information about the gallery that you want to create or update.
16+
"""Specifies information about the Shared Image Gallery that you want to
17+
create or update.
1718
1819
Variables are only populated by the server, and will be ignored when
1920
sending a request.
@@ -30,7 +31,8 @@ class Gallery(Resource):
3031
:type location: str
3132
:param tags: Resource tags
3233
:type tags: dict[str, str]
33-
:param description: The description of this gallery resource.
34+
:param description: The description of this Shared Image Gallery resource.
35+
This property is updateable.
3436
:type description: str
3537
:param identifier:
3638
:type identifier: ~azure.mgmt.compute.v2018_06_01.models.GalleryIdentifier

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_artifact_publishing_profile_base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ class GalleryArtifactPublishingProfileBase(Model):
1717
1818
All required parameters must be populated in order to send to Azure.
1919
20-
:param target_regions: The target regions where the artifact is going to
21-
be published.
20+
:param target_regions: The target regions where the Image Version is going
21+
to be replicated to. This property is updateable.
2222
:type target_regions:
2323
list[~azure.mgmt.compute.v2018_06_01.models.TargetRegion]
2424
:param source: Required.

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_artifact_publishing_profile_base_py3.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ class GalleryArtifactPublishingProfileBase(Model):
1717
1818
All required parameters must be populated in order to send to Azure.
1919
20-
:param target_regions: The target regions where the artifact is going to
21-
be published.
20+
:param target_regions: The target regions where the Image Version is going
21+
to be replicated to. This property is updateable.
2222
:type target_regions:
2323
list[~azure.mgmt.compute.v2018_06_01.models.TargetRegion]
2424
:param source: Required.

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_artifact_source.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
class GalleryArtifactSource(Model):
16-
"""The source of the gallery artifact.
16+
"""The source image from which the Image Version is going to be created.
1717
1818
All required parameters must be populated in order to send to Azure.
1919

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_artifact_source_py3.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
class GalleryArtifactSource(Model):
16-
"""The source of the gallery artifact.
16+
"""The source image from which the Image Version is going to be created.
1717
1818
All required parameters must be populated in order to send to Azure.
1919

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_data_disk_image.py

+6-4
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,18 @@ class GalleryDataDiskImage(GalleryDiskImage):
1818
Variables are only populated by the server, and will be ignored when
1919
sending a request.
2020
21-
:ivar size_in_gb: It indicates the size of the VHD to create.
21+
:ivar size_in_gb: This property indicates the size of the VHD to be
22+
created.
2223
:vartype size_in_gb: int
2324
:ivar host_caching: The host caching of the disk. Valid values are 'None',
2425
'ReadOnly', and 'ReadWrite'. Possible values include: 'None', 'ReadOnly',
2526
'ReadWrite'
2627
:vartype host_caching: str or
2728
~azure.mgmt.compute.v2018_06_01.models.HostCaching
28-
:ivar lun: Specifies the logical unit number of the data disk. This value
29-
is used to identify data disks within the VM and therefore must be unique
30-
for each data disk attached to a VM.
29+
:ivar lun: This property specifies the logical unit number of the data
30+
disk. This value is used to identify data disks within the Virtual Machine
31+
and therefore must be unique for each data disk attached to the Virtual
32+
Machine.
3133
:vartype lun: int
3234
"""
3335

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_data_disk_image_py3.py

+6-4
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,18 @@ class GalleryDataDiskImage(GalleryDiskImage):
1818
Variables are only populated by the server, and will be ignored when
1919
sending a request.
2020
21-
:ivar size_in_gb: It indicates the size of the VHD to create.
21+
:ivar size_in_gb: This property indicates the size of the VHD to be
22+
created.
2223
:vartype size_in_gb: int
2324
:ivar host_caching: The host caching of the disk. Valid values are 'None',
2425
'ReadOnly', and 'ReadWrite'. Possible values include: 'None', 'ReadOnly',
2526
'ReadWrite'
2627
:vartype host_caching: str or
2728
~azure.mgmt.compute.v2018_06_01.models.HostCaching
28-
:ivar lun: Specifies the logical unit number of the data disk. This value
29-
is used to identify data disks within the VM and therefore must be unique
30-
for each data disk attached to a VM.
29+
:ivar lun: This property specifies the logical unit number of the data
30+
disk. This value is used to identify data disks within the Virtual Machine
31+
and therefore must be unique for each data disk attached to the Virtual
32+
Machine.
3133
:vartype lun: int
3234
"""
3335

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_disk_image.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ class GalleryDiskImage(Model):
1818
Variables are only populated by the server, and will be ignored when
1919
sending a request.
2020
21-
:ivar size_in_gb: It indicates the size of the VHD to create.
21+
:ivar size_in_gb: This property indicates the size of the VHD to be
22+
created.
2223
:vartype size_in_gb: int
2324
:ivar host_caching: The host caching of the disk. Valid values are 'None',
2425
'ReadOnly', and 'ReadWrite'. Possible values include: 'None', 'ReadOnly',

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_disk_image_py3.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ class GalleryDiskImage(Model):
1818
Variables are only populated by the server, and will be ignored when
1919
sending a request.
2020
21-
:ivar size_in_gb: It indicates the size of the VHD to create.
21+
:ivar size_in_gb: This property indicates the size of the VHD to be
22+
created.
2223
:vartype size_in_gb: int
2324
:ivar host_caching: The host caching of the disk. Valid values are 'None',
2425
'ReadOnly', and 'ReadWrite'. Possible values include: 'None', 'ReadOnly',

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_identifier.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ class GalleryIdentifier(Model):
1818
Variables are only populated by the server, and will be ignored when
1919
sending a request.
2020
21-
:ivar unique_name: The unique name of the gallery
21+
:ivar unique_name: The unique name of the Shared Image Gallery. This name
22+
is generated automatically by Azure.
2223
:vartype unique_name: str
2324
"""
2425

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_identifier_py3.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ class GalleryIdentifier(Model):
1818
Variables are only populated by the server, and will be ignored when
1919
sending a request.
2020
21-
:ivar unique_name: The unique name of the gallery
21+
:ivar unique_name: The unique name of the Shared Image Gallery. This name
22+
is generated automatically by Azure.
2223
:vartype unique_name: str
2324
"""
2425

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_image.py

+17-14
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414

1515
class GalleryImage(Resource):
16-
"""Specifies information about the gallery image that you want to create or
17-
update.
16+
"""Specifies information about the gallery Image Definition that you want to
17+
create or update.
1818
1919
Variables are only populated by the server, and will be ignored when
2020
sending a request.
@@ -31,25 +31,28 @@ class GalleryImage(Resource):
3131
:type location: str
3232
:param tags: Resource tags
3333
:type tags: dict[str, str]
34-
:param description: The description of this gallery image resource.
34+
:param description: The description of this gallery Image Definition
35+
resource. This property is updateable.
3536
:type description: str
36-
:param eula: The Eula agreement for the gallery image.
37+
:param eula: The Eula agreement for the gallery Image Definition.
3738
:type eula: str
3839
:param privacy_statement_uri: The privacy statement uri.
3940
:type privacy_statement_uri: str
4041
:param release_note_uri: The release note uri.
4142
:type release_note_uri: str
4243
:param os_type: Required. This property allows you to specify the type of
43-
the OS that is included in the disk if creating a VM from user-image or a
44-
specialized VHD. <br><br> Possible values are: <br><br> **Windows**
45-
<br><br> **Linux**. Possible values include: 'Windows', 'Linux'
44+
the OS that is included in the disk when creating a VM from a managed
45+
image. <br><br> Possible values are: <br><br> **Windows** <br><br>
46+
**Linux**. Possible values include: 'Windows', 'Linux'
4647
:type os_type: str or
4748
~azure.mgmt.compute.v2018_06_01.models.OperatingSystemTypes
48-
:param os_state: Required. The OS State. Possible values include:
49-
'Generalized', 'Specialized'
49+
:param os_state: Required. The allowed values for OS State are
50+
'Generalized'. Possible values include: 'Generalized', 'Specialized'
5051
:type os_state: str or
5152
~azure.mgmt.compute.v2018_06_01.models.OperatingSystemStateTypes
52-
:param end_of_life_date: The end of life of this gallery image.
53+
:param end_of_life_date: The end of life date of the gallery Image
54+
Definition. This property can be used for decommissioning purposes. This
55+
property is updateable.
5356
:type end_of_life_date: datetime
5457
:param identifier: Required.
5558
:type identifier:
@@ -62,10 +65,10 @@ class GalleryImage(Resource):
6265
:param purchase_plan:
6366
:type purchase_plan:
6467
~azure.mgmt.compute.v2018_06_01.models.ImagePurchasePlan
65-
:ivar provisioning_state: The current state of the gallery image. The
66-
provisioning state, which only appears in the response. Possible values
67-
include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting',
68-
'Migrating'
68+
:ivar provisioning_state: The current state of the gallery Image
69+
Definition. The provisioning state, which only appears in the response.
70+
Possible values include: 'Creating', 'Updating', 'Failed', 'Succeeded',
71+
'Deleting', 'Migrating'
6972
:vartype provisioning_state: str or
7073
~azure.mgmt.compute.v2018_06_01.models.enum
7174
"""

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_image_identifier.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@
1313

1414

1515
class GalleryImageIdentifier(Model):
16-
"""This is the gallery image identifier.
16+
"""This is the gallery Image Definition identifier.
1717
1818
All required parameters must be populated in order to send to Azure.
1919
20-
:param publisher: Required. The gallery image publisher name.
20+
:param publisher: Required. The name of the gallery Image Definition
21+
publisher.
2122
:type publisher: str
22-
:param offer: Required. The gallery image offer name.
23+
:param offer: Required. The name of the gallery Image Definition offer.
2324
:type offer: str
24-
:param sku: Required. The gallery image sku name.
25+
:param sku: Required. The name of the gallery Image Definition SKU.
2526
:type sku: str
2627
"""
2728

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_image_identifier_py3.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@
1313

1414

1515
class GalleryImageIdentifier(Model):
16-
"""This is the gallery image identifier.
16+
"""This is the gallery Image Definition identifier.
1717
1818
All required parameters must be populated in order to send to Azure.
1919
20-
:param publisher: Required. The gallery image publisher name.
20+
:param publisher: Required. The name of the gallery Image Definition
21+
publisher.
2122
:type publisher: str
22-
:param offer: Required. The gallery image offer name.
23+
:param offer: Required. The name of the gallery Image Definition offer.
2324
:type offer: str
24-
:param sku: Required. The gallery image sku name.
25+
:param sku: Required. The name of the gallery Image Definition SKU.
2526
:type sku: str
2627
"""
2728

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_image_py3.py

+17-14
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414

1515
class GalleryImage(Resource):
16-
"""Specifies information about the gallery image that you want to create or
17-
update.
16+
"""Specifies information about the gallery Image Definition that you want to
17+
create or update.
1818
1919
Variables are only populated by the server, and will be ignored when
2020
sending a request.
@@ -31,25 +31,28 @@ class GalleryImage(Resource):
3131
:type location: str
3232
:param tags: Resource tags
3333
:type tags: dict[str, str]
34-
:param description: The description of this gallery image resource.
34+
:param description: The description of this gallery Image Definition
35+
resource. This property is updateable.
3536
:type description: str
36-
:param eula: The Eula agreement for the gallery image.
37+
:param eula: The Eula agreement for the gallery Image Definition.
3738
:type eula: str
3839
:param privacy_statement_uri: The privacy statement uri.
3940
:type privacy_statement_uri: str
4041
:param release_note_uri: The release note uri.
4142
:type release_note_uri: str
4243
:param os_type: Required. This property allows you to specify the type of
43-
the OS that is included in the disk if creating a VM from user-image or a
44-
specialized VHD. <br><br> Possible values are: <br><br> **Windows**
45-
<br><br> **Linux**. Possible values include: 'Windows', 'Linux'
44+
the OS that is included in the disk when creating a VM from a managed
45+
image. <br><br> Possible values are: <br><br> **Windows** <br><br>
46+
**Linux**. Possible values include: 'Windows', 'Linux'
4647
:type os_type: str or
4748
~azure.mgmt.compute.v2018_06_01.models.OperatingSystemTypes
48-
:param os_state: Required. The OS State. Possible values include:
49-
'Generalized', 'Specialized'
49+
:param os_state: Required. The allowed values for OS State are
50+
'Generalized'. Possible values include: 'Generalized', 'Specialized'
5051
:type os_state: str or
5152
~azure.mgmt.compute.v2018_06_01.models.OperatingSystemStateTypes
52-
:param end_of_life_date: The end of life of this gallery image.
53+
:param end_of_life_date: The end of life date of the gallery Image
54+
Definition. This property can be used for decommissioning purposes. This
55+
property is updateable.
5356
:type end_of_life_date: datetime
5457
:param identifier: Required.
5558
:type identifier:
@@ -62,10 +65,10 @@ class GalleryImage(Resource):
6265
:param purchase_plan:
6366
:type purchase_plan:
6467
~azure.mgmt.compute.v2018_06_01.models.ImagePurchasePlan
65-
:ivar provisioning_state: The current state of the gallery image. The
66-
provisioning state, which only appears in the response. Possible values
67-
include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting',
68-
'Migrating'
68+
:ivar provisioning_state: The current state of the gallery Image
69+
Definition. The provisioning state, which only appears in the response.
70+
Possible values include: 'Creating', 'Updating', 'Failed', 'Succeeded',
71+
'Deleting', 'Migrating'
6972
:vartype provisioning_state: str or
7073
~azure.mgmt.compute.v2018_06_01.models.enum
7174
"""

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_image_version.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515
class GalleryImageVersion(Resource):
16-
"""Specifies information about the gallery image version that you want to
16+
"""Specifies information about the gallery Image Version that you want to
1717
create or update.
1818
1919
Variables are only populated by the server, and will be ignored when
@@ -34,7 +34,7 @@ class GalleryImageVersion(Resource):
3434
:param publishing_profile: Required.
3535
:type publishing_profile:
3636
~azure.mgmt.compute.v2018_06_01.models.GalleryImageVersionPublishingProfile
37-
:ivar provisioning_state: The current state of the gallery image version.
37+
:ivar provisioning_state: The current state of the gallery Image Version.
3838
The provisioning state, which only appears in the response. Possible
3939
values include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting',
4040
'Migrating'

azure-mgmt-compute/azure/mgmt/compute/v2018_06_01/models/gallery_image_version_publishing_profile.py

+12-10
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,32 @@
1313

1414

1515
class GalleryImageVersionPublishingProfile(GalleryArtifactPublishingProfileBase):
16-
"""The publishing profile of a gallery image version.
16+
"""The publishing profile of a gallery Image Version.
1717
1818
Variables are only populated by the server, and will be ignored when
1919
sending a request.
2020
2121
All required parameters must be populated in order to send to Azure.
2222
23-
:param target_regions: The target regions where the artifact is going to
24-
be published.
23+
:param target_regions: The target regions where the Image Version is going
24+
to be replicated to. This property is updateable.
2525
:type target_regions:
2626
list[~azure.mgmt.compute.v2018_06_01.models.TargetRegion]
2727
:param source: Required.
2828
:type source: ~azure.mgmt.compute.v2018_06_01.models.GalleryArtifactSource
29-
:param replica_count: This is the number of source blob copies in a
30-
region.
29+
:param replica_count: The number of replicas of the Image Version to be
30+
created per region. This property would take effect for a region when
31+
regionalReplicaCount is not specified. This property is updateable.
3132
:type replica_count: int
32-
:param exclude_from_latest: The flag means that if it is set to true,
33-
people deploying VMs with 'latest' as version will not use this version.
33+
:param exclude_from_latest: If set to true, Virtual Machines deployed from
34+
the latest version of the Image Definition won't use this Image Version.
3435
:type exclude_from_latest: bool
35-
:ivar published_date: The time when the gallery image version is
36+
:ivar published_date: The timestamp for when the gallery Image Version is
3637
published.
3738
:vartype published_date: datetime
38-
:param end_of_life_date: The end of life date of the gallery image
39-
version.
39+
:param end_of_life_date: The end of life date of the gallery Image
40+
Version. This property can be used for decommissioning purposes. This
41+
property is updateable.
4042
:type end_of_life_date: datetime
4143
"""
4244

0 commit comments

Comments
 (0)