cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Format azure_rm_gallery* relate document (#64541)

Browse source
This commit is contained in:
Fred-sun 2019-11-09 05:08:10 +08:00 • committed by Sandra McCann
parent 0573e51482
commit 1e4230c0e7
6 changed files with 459 additions and 500 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
lib/ansible/modules/cloud/azure/azure_rm_gallery.py
View file

@ -17,9 +17,9 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_gallery module: azure_rm_gallery
version_added: '2.9' version_added: '2.9'
short_description: Manage Azure Shared Image Gallery instance. short_description: Manage Azure Shared Image Gallery instance
description: description:
- 'Create, update and delete instance of Azure Shared Image Gallery (SIG).' - Create, update and delete instance of Azure Shared Image Gallery (SIG).
options: options:
resource_group: resource_group:
description: description:
@ -28,27 +28,22 @@ options:
type: str type: str
name: name:
description: description:
- >- - The name of the Shared Image Gallery.
The name of the Shared Image Gallery. - Valid names consist of less than 80 alphanumeric characters, underscores and periods.
Valid names consist of less than 80 alphanumeric characters, underscores and periods.
required: true required: true
type: str type: str
location: location:
description: description:
- Resource location - Resource location.
type: str type: str
description: description:
description: description:
- >- - The description of this Shared Image Gallery resource. This property is updatable.
The description of this Shared Image Gallery resource. This property is
updatable.
type: str type: str
state: state:
description: description:
- Assert the state of the Gallery. - Assert the state of the Gallery.
- >- - Use C(present) to create or update an Gallery and C(absent) to delete it.
Use C(present) to create or update an Gallery and C(absent) to delete
it.
default: present default: present
type: str type: str
choices: choices:
@ -74,7 +69,7 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
id: id:
description: description:
- Resource Id - Resource ID.
returned: always returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery1283" sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery1283"

20
lib/ansible/modules/cloud/azure/azure_rm_gallery_info.py
View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_gallery_info module: azure_rm_gallery_info
version_added: '2.9' version_added: '2.9'
short_description: Get Azure Shared Image Gallery info. short_description: Get Azure Shared Image Gallery info
description: description:
- Get info of Azure Shared Image Gallery. - Get info of Azure Shared Image Gallery.
options: options:
@ -51,45 +51,45 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
galleries: galleries:
description: >- description:
A list of dict results where the key is the name of the gallery and the - A list of dict results where the key is the name of the gallery and the values are the info for that gallery.
values are the info for that gallery.
returned: always returned: always
type: complex type: complex
contains: contains:
id: id:
description: description:
- Resource Id - Resource ID.
returned: always returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery"
/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery"
name: name:
description: description:
- Resource name - Resource name.
returned: always returned: always
type: str type: str
sample: "myGallery" sample: "myGallery"
location: location:
description: description:
- Resource location - Resource location.
returned: always returned: always
type: str type: str
sample: "eastus" sample: "eastus"
tags: tags:
description: description:
- Resource tags - Resource tags.
returned: always returned: always
type: dict type: dict
sample: { "tag": "value" } sample: { "tag": "value" }
description: description:
description: description:
- This is the gallery description. - This is the gallery description.
returned: always
type: str type: str
sample: "This is the gallery description." sample: "This is the gallery description."
provisioning_state: provisioning_state:
description: description:
- The current state of the gallery. - The current state of the gallery.
returned: always
type: str type: str
sample: "Succeeded" sample: "Succeeded"

41
lib/ansible/modules/cloud/azure/azure_rm_galleryimage.py
View file

@ -17,9 +17,9 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_galleryimage module: azure_rm_galleryimage
version_added: '2.9' version_added: '2.9'
short_description: Manage Azure SIG Image instance. short_description: Manage Azure SIG Image instance
description: description:
- 'Create, update and delete instance of Azure SIG Image.' - Create, update and delete instance of Azure SIG Image.
options: options:
resource_group: resource_group:
description: description:
@ -28,28 +28,23 @@ options:
type: str type: str
gallery_name: gallery_name:
description: description:
- >- - The name of the Shared Image Gallery in which the Image Definition is to be created.
The name of the Shared Image Gallery in which the Image Definition is to
be created.
required: true required: true
type: str type: str
name: name:
description: description:
- >- - The name of the gallery Image Definition to be created or updated.
The name of the gallery Image Definition to be created or updated. The - The allowed characters are alphabets and numbers with dots, dashes, and periods allowed in the middle.
allowed characters are alphabets and numbers with dots, dashes, and - The maximum length is 80 characters.
periods allowed in the middle. The maximum length is 80 characters.
required: true required: true
type: str type: str
location: location:
description: description:
- Resource location - Resource location.
type: str type: str
description: description:
description: description:
- >- - The description of this gallery Image Definition resource. This property is updatable.
The description of this gallery Image Definition resource. This property
is updatable.
type: str type: str
eula: eula:
description: description:
@ -65,9 +60,7 @@ options:
type: str type: str
os_type: os_type:
description: 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.
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.
choices: choices:
- windows - windows
- linux - linux
@ -75,7 +68,7 @@ options:
type: str type: str
os_state: os_state:
description: description:
- The allowed values for OS State are 'Generalized'. - The allowed values for OS State are C(generalized).
choices: choices:
- generalized - generalized
- specialized - specialized
@ -83,10 +76,10 @@ options:
type: str type: str
end_of_life_date: end_of_life_date:
description: description:
- >- - The end of life date of the gallery Image Definition.
The end of life date of the gallery Image Definition. This property can - This property can be used for decommissioning purposes.
be used for decommissioning purposes. This property is updatable. - This property is updatable.
Format should be according to ISO-8601, for instance "2019-06-26". - Format should be according to ISO-8601, for instance "2019-06-26".
type: str type: str
identifier: identifier:
description: description:
@ -169,9 +162,7 @@ options:
state: state:
description: description:
- Assert the state of the GalleryImage. - Assert the state of the GalleryImage.
- >- - Use C(present) to create or update an GalleryImage and C(absent) to delete it.
Use C(present) to create or update an GalleryImage and C(absent) to
delete it.
default: present default: present
choices: choices:
- absent - absent
@ -203,7 +194,7 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
id: id:
description: description:
- Resource Id - Resource ID.
returned: always returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle

28
lib/ansible/modules/cloud/azure/azure_rm_galleryimage_info.py
View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_galleryimage_info module: azure_rm_galleryimage_info
version_added: '2.9' version_added: '2.9'
short_description: Get Azure SIG Image info. short_description: Get Azure SIG Image info
description: description:
- Get info of Azure SIG Image. - Get info of Azure SIG Image.
options: options:
@ -28,14 +28,12 @@ options:
required: true required: true
gallery_name: gallery_name:
description: description:
- >- - The name of the shared image gallery from which the image definitions are to be retrieved.
The name of the shared image gallery from which the image definitions
are to be retrieved.
type: str type: str
required: true required: true
name: name:
description: description:
- Resource name - Resource name.
type: str type: str
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
@ -59,46 +57,44 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
images: images:
description: >- description:
A list of dict results where the key is the name of the image and the - A list of dict results where the key is the name of the image and the values are the info for that image.
values are the info for that image.
returned: always returned: always
type: complex type: complex
contains: contains:
id: id:
description: description:
- Resource Id - Resource ID.
returned: always returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup
/providers/Microsoft.Compute/galleries/myGallery/images/myImage" /providers/Microsoft.Compute/galleries/myGallery/images/myImage"
name: name:
description: description:
- Resource name - Resource name.
returned: always returned: always
type: str type: str
sample: myImage sample: myImage
location: location:
description: description:
- Resource location - Resource location.
returned: always returned: always
type: str type: str
sample: "eastus" sample: "eastus"
tags: tags:
description: description:
- Resource tags - Resource tags.
returned: always returned: always
type: dict type: dict
sample: { "tag": "value" } sample: { "tag": "value" }
os_state: os_state:
description: description:
- The allowed values for OS State are 'Generalized'. - The allowed values for OS State are C(generalized).
type: OperatingSystemStateTypes type: OperatingSystemStateTypes
sample: "Generalized" sample: "Generalized"
os_type: os_type:
description: >- description:
This property allows you to specify the type of the OS that is included in the disk - 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.
when creating a VM from a managed image.
type: OperatingSystemTypes type: OperatingSystemTypes
sample: "linux/windows" sample: "linux/windows"
identifier: identifier:

69
lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion.py
View file

@ -17,9 +17,9 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_galleryimageversion module: azure_rm_galleryimageversion
version_added: '2.9' version_added: '2.9'
short_description: Manage Azure SIG Image Version instance. short_description: Manage Azure SIG Image Version instance
description: description:
- 'Create, update and delete instance of Azure SIG Image Version.' - Create, update and delete instance of Azure SIG Image Version.
options: options:
resource_group: resource_group:
description: description:
@ -28,30 +28,24 @@ options:
type: str type: str
gallery_name: gallery_name:
description: description:
- >- - The name of the Shared Image Gallery in which the Image Definition resides.
The name of the Shared Image Gallery in which the Image Definition
resides.
required: true required: true
type: str type: str
gallery_image_name: gallery_image_name:
description: description:
- >- - The name of the gallery Image Definition in which the Image Version is to be created.
The name of the gallery Image Definition in which the Image Version is
to be created.
required: true required: true
type: str type: str
name: name:
description: description:
- >- - The name of the gallery Image Version to be created.
The name of the gallery Image Version to be created. Needs to follow - Needs to follow semantic version name pattern, The allowed characters are digit and period.
semantic version name pattern: The allowed characters are digit and - Digits must be within the range of a 32-bit integer. For example <MajorVersion>.<MinorVersion>.<Patch>.
period. Digits must be within the range of a 32-bit integer. Format:
<MajorVersion>.<MinorVersion>.<Patch>
required: true required: true
type: str type: str
location: location:
description: description:
- Resource location - Resource location.
type: str type: str
publishing_profile: publishing_profile:
description: description:
@ -61,9 +55,8 @@ options:
suboptions: suboptions:
target_regions: target_regions:
description: description:
- >- - The target regions where the Image Version is going to be replicated to.
The target regions where the Image Version is going to be replicated - This property is updatable.
to. This property is updatable.
type: list type: list
suboptions: suboptions:
name: name:
@ -72,10 +65,9 @@ options:
type: str type: str
regional_replica_count: regional_replica_count:
description: description:
- >- - The number of replicas of the Image Version to be created per region.
The number of replicas of the Image Version to be created per - This property would take effect for a region when regionalReplicaCount is not specified.
region. This property would take effect for a region when - This property is updatable.
regionalReplicaCount is not specified. This property is updatable.
type: str type: str
storage_account_type: storage_account_type:
description: description:
@ -83,44 +75,35 @@ options:
type: str type: str
managed_image: managed_image:
description: description:
- Managed image reference, could be resource id, or dictionary containing C(resource_group) and C(name) - Managed image reference, could be resource ID, or dictionary containing I(resource_group) and I(name).
type: raw
snapshot: snapshot:
description: description:
- Source snapshot to be used. - Source snapshot to be used.
type: raw
replica_count: replica_count:
description: description:
- >- - The number of replicas of the Image Version to be created per region.
The number of replicas of the Image Version to be created per - This property would take effect for a region when regionalReplicaCount is not specified.
region. This property would take effect for a region when - This property is updatable.
regionalReplicaCount is not specified. This property is updatable. type: int
type: number
exclude_from_latest: exclude_from_latest:
description: description:
- >- If I(exclude_from_latest=true), Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.
If set to true, Virtual Machines deployed from the latest version of
the Image Definition won't use this Image Version.
type: bool type: bool
end_of_life_date: end_of_life_date:
description: description:
- >- - The end of life date of the gallery Image Version.
The end of life date of the gallery Image Version. This property can - This property can be used for decommissioning purposes.
be used for decommissioning purposes. This property is updatable. - This property is updatable. Format should be according to ISO-8601, for instance "2019-06-26".
Format should be according to ISO-8601, for instance "2019-06-26".
type: str type: str
storage_account_type: storage_account_type:
description: description:
- >- - Specifies the storage account type to be used to store the image.
Specifies the storage account type to be used to store the image. - This property is not updatable.
This property is not updatable.
type: str type: str
state: state:
description: description:
- Assert the state of the GalleryImageVersion. - Assert the state of the GalleryImageVersion.
- >- - Use C(present) to create or update an GalleryImageVersion and C(absent) to delete it.
Use C(present) to create or update an GalleryImageVersion and C(absent)
to delete it.
default: present default: present
choices: choices:
- absent - absent
@ -161,7 +144,7 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
id: id:
description: description:
- Resource Id - Resource ID.
returned: always returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle

28
lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion_info.py
View file

@ -17,7 +17,7 @@ DOCUMENTATION = '''
--- ---
module: azure_rm_galleryimageversion_info module: azure_rm_galleryimageversion_info
version_added: '2.9' version_added: '2.9'
short_description: Get Azure SIG Image Version info. short_description: Get Azure SIG Image Version info
description: description:
- Get info of Azure SIG Image Version. - Get info of Azure SIG Image Version.
options: options:
@ -28,21 +28,17 @@ options:
required: true required: true
gallery_name: gallery_name:
description: description:
- >- - The name of the Shared Image Gallery in which the Image Definition resides.
The name of the Shared Image Gallery in which the Image Definition
resides.
type: str type: str
required: true required: true
gallery_image_name: gallery_image_name:
description: description:
- >- - The name of the gallery Image Definition in which the Image Version resides.
The name of the gallery Image Definition in which the Image Version
resides.
type: str type: str
required: true required: true
name: name:
description: description:
- Resource name - Resource name.
type: str type: str
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
@ -68,35 +64,33 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
versions: versions:
description: >- description:
A list of dict results where the key is the name of the version A list of dict results where the key is the name of the version and the values are the info for that version.
and the values are the info for that version.
returned: always returned: always
type: complex type: complex
contains: contains:
id: id:
description: description:
- Resource Id - Resource ID.
returned: always returned: always
type: str type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups
/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/ /myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/images/myImage/versions/myVersion"
images/myImage/versions/myVersion"
name: name:
description: description:
- Resource name - Resource name.
returned: always returned: always
type: str type: str
sample: "myVersion" sample: "myVersion"
location: location:
description: description:
- Resource location - Resource location.
returned: always returned: always
type: str type: str
sample: "eastus" sample: "eastus"
tags: tags:
description: description:
- Resource tags - Resource tags.
returned: always returned: always
type: dict type: dict
sample: { "tag": "value" } sample: { "tag": "value" }