Skip to content

Commit

Permalink
[AutoPR compute/resource-manager] More detail added to the descriptio…
Browse files Browse the repository at this point in the history
…ns. (#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
  • Loading branch information
AutorestCI authored Sep 19, 2018
1 parent e2fd2c5 commit 2c0bef6
Show file tree
Hide file tree
Showing 37 changed files with 194 additions and 143 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@


class Gallery(Resource):
"""Specifies information about the gallery that you want to create or update.
"""Specifies information about the Shared Image Gallery that you want to
create or update.
Variables are only populated by the server, and will be ignored when
sending a request.
Expand All @@ -30,7 +31,8 @@ class Gallery(Resource):
:type location: str
:param tags: Resource tags
:type tags: dict[str, str]
:param description: The description of this gallery resource.
:param description: The description of this Shared Image Gallery resource.
This property is updateable.
:type description: str
:param identifier:
:type identifier: ~azure.mgmt.compute.v2018_06_01.models.GalleryIdentifier
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ class GalleryArtifactPublishingProfileBase(Model):
All required parameters must be populated in order to send to Azure.
:param target_regions: The target regions where the artifact is going to
be published.
:param target_regions: The target regions where the Image Version is going
to be replicated to. This property is updateable.
:type target_regions:
list[~azure.mgmt.compute.v2018_06_01.models.TargetRegion]
:param source: Required.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ class GalleryArtifactPublishingProfileBase(Model):
All required parameters must be populated in order to send to Azure.
:param target_regions: The target regions where the artifact is going to
be published.
:param target_regions: The target regions where the Image Version is going
to be replicated to. This property is updateable.
:type target_regions:
list[~azure.mgmt.compute.v2018_06_01.models.TargetRegion]
:param source: Required.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


class GalleryArtifactSource(Model):
"""The source of the gallery artifact.
"""The source image from which the Image Version is going to be created.
All required parameters must be populated in order to send to Azure.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


class GalleryArtifactSource(Model):
"""The source of the gallery artifact.
"""The source image from which the Image Version is going to be created.
All required parameters must be populated in order to send to Azure.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@ class GalleryDataDiskImage(GalleryDiskImage):
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar size_in_gb: It indicates the size of the VHD to create.
:ivar size_in_gb: This property indicates the size of the VHD to be
created.
:vartype size_in_gb: int
:ivar host_caching: The host caching of the disk. Valid values are 'None',
'ReadOnly', and 'ReadWrite'. Possible values include: 'None', 'ReadOnly',
'ReadWrite'
:vartype host_caching: str or
~azure.mgmt.compute.v2018_06_01.models.HostCaching
:ivar lun: Specifies the logical unit number of the data disk. This value
is used to identify data disks within the VM and therefore must be unique
for each data disk attached to a VM.
:ivar lun: 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.
:vartype lun: int
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@ class GalleryDataDiskImage(GalleryDiskImage):
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar size_in_gb: It indicates the size of the VHD to create.
:ivar size_in_gb: This property indicates the size of the VHD to be
created.
:vartype size_in_gb: int
:ivar host_caching: The host caching of the disk. Valid values are 'None',
'ReadOnly', and 'ReadWrite'. Possible values include: 'None', 'ReadOnly',
'ReadWrite'
:vartype host_caching: str or
~azure.mgmt.compute.v2018_06_01.models.HostCaching
:ivar lun: Specifies the logical unit number of the data disk. This value
is used to identify data disks within the VM and therefore must be unique
for each data disk attached to a VM.
:ivar lun: 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.
:vartype lun: int
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ class GalleryDiskImage(Model):
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar size_in_gb: It indicates the size of the VHD to create.
:ivar size_in_gb: This property indicates the size of the VHD to be
created.
:vartype size_in_gb: int
:ivar host_caching: The host caching of the disk. Valid values are 'None',
'ReadOnly', and 'ReadWrite'. Possible values include: 'None', 'ReadOnly',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ class GalleryDiskImage(Model):
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar size_in_gb: It indicates the size of the VHD to create.
:ivar size_in_gb: This property indicates the size of the VHD to be
created.
:vartype size_in_gb: int
:ivar host_caching: The host caching of the disk. Valid values are 'None',
'ReadOnly', and 'ReadWrite'. Possible values include: 'None', 'ReadOnly',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ class GalleryIdentifier(Model):
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar unique_name: The unique name of the gallery
:ivar unique_name: The unique name of the Shared Image Gallery. This name
is generated automatically by Azure.
:vartype unique_name: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ class GalleryIdentifier(Model):
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar unique_name: The unique name of the gallery
:ivar unique_name: The unique name of the Shared Image Gallery. This name
is generated automatically by Azure.
:vartype unique_name: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@


class GalleryImage(Resource):
"""Specifies information about the gallery image that you want to create or
update.
"""Specifies information about the gallery Image Definition that you want to
create or update.
Variables are only populated by the server, and will be ignored when
sending a request.
Expand All @@ -31,25 +31,28 @@ class GalleryImage(Resource):
:type location: str
:param tags: Resource tags
:type tags: dict[str, str]
:param description: The description of this gallery image resource.
:param description: The description of this gallery Image Definition
resource. This property is updateable.
:type description: str
:param eula: The Eula agreement for the gallery image.
:param eula: The Eula agreement for the gallery Image Definition.
:type eula: str
:param privacy_statement_uri: The privacy statement uri.
:type privacy_statement_uri: str
:param release_note_uri: The release note uri.
:type release_note_uri: str
:param os_type: Required. This property allows you to specify the type of
the OS that is included in the disk if creating a VM from user-image or a
specialized VHD. <br><br> Possible values are: <br><br> **Windows**
<br><br> **Linux**. Possible values include: 'Windows', 'Linux'
the OS that is included in the disk when creating a VM from a managed
image. <br><br> Possible values are: <br><br> **Windows** <br><br>
**Linux**. Possible values include: 'Windows', 'Linux'
:type os_type: str or
~azure.mgmt.compute.v2018_06_01.models.OperatingSystemTypes
:param os_state: Required. The OS State. Possible values include:
'Generalized', 'Specialized'
:param os_state: Required. The allowed values for OS State are
'Generalized'. Possible values include: 'Generalized', 'Specialized'
:type os_state: str or
~azure.mgmt.compute.v2018_06_01.models.OperatingSystemStateTypes
:param end_of_life_date: The end of life of this gallery image.
:param end_of_life_date: The end of life date of the gallery Image
Definition. This property can be used for decommissioning purposes. This
property is updateable.
:type end_of_life_date: datetime
:param identifier: Required.
:type identifier:
Expand All @@ -62,10 +65,10 @@ class GalleryImage(Resource):
:param purchase_plan:
:type purchase_plan:
~azure.mgmt.compute.v2018_06_01.models.ImagePurchasePlan
:ivar provisioning_state: The current state of the gallery image. The
provisioning state, which only appears in the response. Possible values
include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting',
'Migrating'
:ivar provisioning_state: The current state of the gallery Image
Definition. The provisioning state, which only appears in the response.
Possible values include: 'Creating', 'Updating', 'Failed', 'Succeeded',
'Deleting', 'Migrating'
:vartype provisioning_state: str or
~azure.mgmt.compute.v2018_06_01.models.enum
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,16 @@


class GalleryImageIdentifier(Model):
"""This is the gallery image identifier.
"""This is the gallery Image Definition identifier.
All required parameters must be populated in order to send to Azure.
:param publisher: Required. The gallery image publisher name.
:param publisher: Required. The name of the gallery Image Definition
publisher.
:type publisher: str
:param offer: Required. The gallery image offer name.
:param offer: Required. The name of the gallery Image Definition offer.
:type offer: str
:param sku: Required. The gallery image sku name.
:param sku: Required. The name of the gallery Image Definition SKU.
:type sku: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,16 @@


class GalleryImageIdentifier(Model):
"""This is the gallery image identifier.
"""This is the gallery Image Definition identifier.
All required parameters must be populated in order to send to Azure.
:param publisher: Required. The gallery image publisher name.
:param publisher: Required. The name of the gallery Image Definition
publisher.
:type publisher: str
:param offer: Required. The gallery image offer name.
:param offer: Required. The name of the gallery Image Definition offer.
:type offer: str
:param sku: Required. The gallery image sku name.
:param sku: Required. The name of the gallery Image Definition SKU.
:type sku: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@


class GalleryImage(Resource):
"""Specifies information about the gallery image that you want to create or
update.
"""Specifies information about the gallery Image Definition that you want to
create or update.
Variables are only populated by the server, and will be ignored when
sending a request.
Expand All @@ -31,25 +31,28 @@ class GalleryImage(Resource):
:type location: str
:param tags: Resource tags
:type tags: dict[str, str]
:param description: The description of this gallery image resource.
:param description: The description of this gallery Image Definition
resource. This property is updateable.
:type description: str
:param eula: The Eula agreement for the gallery image.
:param eula: The Eula agreement for the gallery Image Definition.
:type eula: str
:param privacy_statement_uri: The privacy statement uri.
:type privacy_statement_uri: str
:param release_note_uri: The release note uri.
:type release_note_uri: str
:param os_type: Required. This property allows you to specify the type of
the OS that is included in the disk if creating a VM from user-image or a
specialized VHD. <br><br> Possible values are: <br><br> **Windows**
<br><br> **Linux**. Possible values include: 'Windows', 'Linux'
the OS that is included in the disk when creating a VM from a managed
image. <br><br> Possible values are: <br><br> **Windows** <br><br>
**Linux**. Possible values include: 'Windows', 'Linux'
:type os_type: str or
~azure.mgmt.compute.v2018_06_01.models.OperatingSystemTypes
:param os_state: Required. The OS State. Possible values include:
'Generalized', 'Specialized'
:param os_state: Required. The allowed values for OS State are
'Generalized'. Possible values include: 'Generalized', 'Specialized'
:type os_state: str or
~azure.mgmt.compute.v2018_06_01.models.OperatingSystemStateTypes
:param end_of_life_date: The end of life of this gallery image.
:param end_of_life_date: The end of life date of the gallery Image
Definition. This property can be used for decommissioning purposes. This
property is updateable.
:type end_of_life_date: datetime
:param identifier: Required.
:type identifier:
Expand All @@ -62,10 +65,10 @@ class GalleryImage(Resource):
:param purchase_plan:
:type purchase_plan:
~azure.mgmt.compute.v2018_06_01.models.ImagePurchasePlan
:ivar provisioning_state: The current state of the gallery image. The
provisioning state, which only appears in the response. Possible values
include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting',
'Migrating'
:ivar provisioning_state: The current state of the gallery Image
Definition. The provisioning state, which only appears in the response.
Possible values include: 'Creating', 'Updating', 'Failed', 'Succeeded',
'Deleting', 'Migrating'
:vartype provisioning_state: str or
~azure.mgmt.compute.v2018_06_01.models.enum
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


class GalleryImageVersion(Resource):
"""Specifies information about the gallery image version that you want to
"""Specifies information about the gallery Image Version that you want to
create or update.
Variables are only populated by the server, and will be ignored when
Expand All @@ -34,7 +34,7 @@ class GalleryImageVersion(Resource):
:param publishing_profile: Required.
:type publishing_profile:
~azure.mgmt.compute.v2018_06_01.models.GalleryImageVersionPublishingProfile
:ivar provisioning_state: The current state of the gallery image version.
:ivar provisioning_state: The current state of the gallery Image Version.
The provisioning state, which only appears in the response. Possible
values include: 'Creating', 'Updating', 'Failed', 'Succeeded', 'Deleting',
'Migrating'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,30 +13,32 @@


class GalleryImageVersionPublishingProfile(GalleryArtifactPublishingProfileBase):
"""The publishing profile of a gallery image version.
"""The publishing profile of a gallery Image Version.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:param target_regions: The target regions where the artifact is going to
be published.
:param target_regions: The target regions where the Image Version is going
to be replicated to. This property is updateable.
:type target_regions:
list[~azure.mgmt.compute.v2018_06_01.models.TargetRegion]
:param source: Required.
:type source: ~azure.mgmt.compute.v2018_06_01.models.GalleryArtifactSource
:param replica_count: This is the number of source blob copies in a
region.
:param replica_count: The number of replicas of the Image Version to be
created per region. This property would take effect for a region when
regionalReplicaCount is not specified. This property is updateable.
:type replica_count: int
:param exclude_from_latest: The flag means that if it is set to true,
people deploying VMs with 'latest' as version will not use this version.
:param exclude_from_latest: If set to true, Virtual Machines deployed from
the latest version of the Image Definition won't use this Image Version.
:type exclude_from_latest: bool
:ivar published_date: The time when the gallery image version is
:ivar published_date: The timestamp for when the gallery Image Version is
published.
:vartype published_date: datetime
:param end_of_life_date: The end of life date of the gallery image
version.
:param end_of_life_date: The end of life date of the gallery Image
Version. This property can be used for decommissioning purposes. This
property is updateable.
:type end_of_life_date: datetime
"""

Expand Down
Loading

0 comments on commit 2c0bef6

Please sign in to comment.