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

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

@ -17,48 +17,43 @@ 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:
- The name of the resource group.
required: true
type: str
name:
description:
- The name of the Shared Image Gallery.
- Valid names consist of less than 80 alphanumeric characters, underscores and periods.
required: true
type: str
location:
description:
- Resource location.
type: str
description: description:
- The name of the resource group. description:
required: true - The description of this Shared Image Gallery resource. This property is updatable.
type: str type: str
name: state:
description: description:
- >- - Assert the state of the Gallery.
The name of the Shared Image Gallery. - Use C(present) to create or update an Gallery and C(absent) to delete it.
Valid names consist of less than 80 alphanumeric characters, underscores and periods. default: present
required: true type: str
type: str choices:
location: - absent
description: - present
- Resource location
type: str
description:
description:
- >-
The description of this Shared Image Gallery resource. This property is
updatable.
type: str
state:
description:
- Assert the state of the Gallery.
- >-
Use C(present) to create or update an Gallery and C(absent) to delete
it.
default: present
type: str
choices:
- absent
- present
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: author:
- Zim Kalinowski (@zikalino) - Zim Kalinowski (@zikalino)
''' '''
@ -73,11 +68,11 @@ 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"
''' '''
import time import time

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

@ -17,22 +17,22 @@ 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:
resource_group: resource_group:
description: description:
- The name of the resource group. - The name of the resource group.
type: str type: str
name: name:
description: description:
- Resource name - Resource name
type: str type: str
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
author: author:
- Liu Qingyi (@smile37773) - Liu Qingyi (@smile37773)
''' '''
@ -51,47 +51,47 @@ EXAMPLES = '''
RETURN = ''' RETURN = '''
galleries: galleries:
description: >-
A list of dict results where the key is the name of the gallery and the
values are the info for that gallery.
returned: always
type: complex
contains:
id:
description:
- Resource Id
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery"
name:
description:
- Resource name
returned: always
type: str
sample: "myGallery"
location:
description:
- Resource location
returned: always
type: str
sample: "eastus"
tags:
description:
- Resource tags
returned: always
type: dict
sample: { "tag": "value" }
description: description:
description: - A list of dict results where the key is the name of the gallery and the values are the info for that gallery.
- This is the gallery description. returned: always
type: str type: complex
sample: "This is the gallery description." contains:
provisioning_state: id:
description:
- Resource ID.
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery"
name:
description:
- Resource name.
returned: always
type: str
sample: "myGallery"
location:
description:
- Resource location.
returned: always
type: str
sample: "eastus"
tags:
description:
- Resource tags.
returned: always
type: dict
sample: { "tag": "value" }
description: description:
- The current state of the gallery. description:
type: str - This is the gallery description.
sample: "Succeeded" returned: always
type: str
sample: "This is the gallery description."
provisioning_state:
description:
- The current state of the gallery.
returned: always
type: str
sample: "Succeeded"
''' '''

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

@ -17,169 +17,160 @@ 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:
- The name of the resource group.
required: true
type: str
gallery_name:
description:
- >-
The name of the Shared Image Gallery in which the Image Definition is to
be created.
required: true
type: str
name:
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
type: str
location:
description:
- Resource location
type: str
description:
description:
- >-
The description of this gallery Image Definition resource. This property
is updatable.
type: str
eula:
description:
- The Eula agreement for the gallery Image Definition.
type: str
privacy_statement_uri:
description:
- The privacy statement uri.
type: str
release_note_uri:
description:
- The release note uri.
type: str
os_type:
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.
choices:
- windows
- linux
required: true
type: str
os_state:
description:
- The allowed values for OS State are 'Generalized'.
choices:
- generalized
- specialized
required: true
type: str
end_of_life_date:
description:
- >-
The end of life date of the gallery Image Definition. This property can
be used for decommissioning purposes. This property is updatable.
Format should be according to ISO-8601, for instance "2019-06-26".
type: str
identifier:
description:
- Image identifier.
required: true
type: dict
suboptions:
publisher:
description: description:
- The name of the gallery Image Definition publisher. - The name of the resource group.
required: true required: true
type: str type: str
offer: gallery_name:
description: description:
- The name of the gallery Image Definition offer. - The name of the Shared Image Gallery in which the Image Definition is to be created.
required: true required: true
type: str type: str
sku: name:
description: description:
- The name of the gallery Image Definition SKU. - 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 required: true
type: str type: str
recommended: location:
description:
- Resource location.
type: str
description: description:
- Recommended parameter values.
type: dict
suboptions:
v_cpus:
description: description:
- Number of virtual CPUs. - The description of this gallery Image Definition resource. This property is updatable.
type: str
eula:
description:
- The Eula agreement for the gallery Image Definition.
type: str
privacy_statement_uri:
description:
- The privacy statement uri.
type: str
release_note_uri:
description:
- The release note uri.
type: str
os_type:
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.
choices:
- windows
- linux
required: true
type: str
os_state:
description:
- The allowed values for OS State are C(generalized).
choices:
- generalized
- specialized
required: true
type: str
end_of_life_date:
description:
- The end of life date of the gallery Image Definition.
- This property can be used for decommissioning purposes.
- This property is updatable.
- Format should be according to ISO-8601, for instance "2019-06-26".
type: str
identifier:
description:
- Image identifier.
required: true
type: dict type: dict
suboptions: suboptions:
min: publisher:
description: description:
- The minimum number of the resource. - The name of the gallery Image Definition publisher.
type: int required: true
max: type: str
description: offer:
- The maximum number of the resource. description:
type: int - The name of the gallery Image Definition offer.
memory: required: true
type: str
sku:
description:
- The name of the gallery Image Definition SKU.
required: true
type: str
recommended:
description: description:
- Memory. - Recommended parameter values.
type: dict type: dict
suboptions: suboptions:
min: v_cpus:
description: description:
- The minimum number of the resource. - Number of virtual CPUs.
type: int type: dict
max: suboptions:
description: min:
- The maximum number of the resource. description:
type: int - The minimum number of the resource.
disallowed: type: int
description: max:
- Disallowed parameter values. description:
type: dict - The maximum number of the resource.
suboptions: type: int
disk_types: memory:
description:
- Memory.
type: dict
suboptions:
min:
description:
- The minimum number of the resource.
type: int
max:
description:
- The maximum number of the resource.
type: int
disallowed:
description: description:
- A list of disallowed disk types. - Disallowed parameter values.
type: list type: dict
purchase_plan: suboptions:
description: disk_types:
- Purchase plan. description:
type: dict - A list of disallowed disk types.
suboptions: type: list
name: purchase_plan:
description: description:
- The plan ID. - Purchase plan.
type: dict
suboptions:
name:
description:
- The plan ID.
type: str
publisher:
description:
- The publisher ID.
type: str
product:
description:
- The product ID.
type: str
state:
description:
- Assert the state of the GalleryImage.
- Use C(present) to create or update an GalleryImage and C(absent) to delete it.
default: present
choices:
- absent
- present
type: str type: str
publisher:
description:
- The publisher ID.
type: str
product:
description:
- The product ID.
type: str
state:
description:
- Assert the state of the GalleryImage.
- >-
Use C(present) to create or update an GalleryImage and C(absent) to
delete it.
default: present
choices:
- absent
- present
type: str
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: author:
- Zim Kalinowski (@zikalino) - Zim Kalinowski (@zikalino)
@ -202,11 +193,11 @@ 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
ry1283/images/myImage" ry1283/images/myImage"
''' '''

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

@ -17,30 +17,28 @@ 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:
resource_group: resource_group:
description: description:
- The name of the resource group. - The name of the resource group.
type: str type: str
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 type: str
are to be retrieved. required: true
type: str name:
required: true description:
name: - Resource name.
description: type: str
- Resource name
type: str
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
author: author:
- Liu Qingyi (@smile37773) - Liu Qingyi (@smile37773)
''' '''
@ -59,68 +57,66 @@ 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 C(generalized).
- The allowed values for OS State are '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 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 type: OperatingSystemTypes
when creating a VM from a managed image. sample: "linux/windows"
type: OperatingSystemTypes identifier:
sample: "linux/windows" description:
identifier: - This is the gallery image definition identifier.
description: type: dict
- This is the gallery image definition identifier. contains:
type: dict offer:
contains: description:
offer: - The name of the gallery image definition offer.
description: type: str
- The name of the gallery image definition offer. sample: "myOfferName"
type: str publisher:
sample: "myOfferName" description:
publisher: - The name of the gallery image definition publisher.
description: type: str
- The name of the gallery image definition publisher. sample: "myPublisherName"
type: str sku:
sample: "myPublisherName" description:
sku: - The name of the gallery image definition sku.
description: type: str
- The name of the gallery image definition sku. sample: "mySkuName"
type: str
sample: "mySkuName"
''' '''

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

@ -17,120 +17,103 @@ 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:
- The name of the resource group.
required: true
type: str
gallery_name:
description:
- >-
The name of the Shared Image Gallery in which the Image Definition
resides.
required: true
type: str
gallery_image_name:
description:
- >-
The name of the gallery Image Definition in which the Image Version is
to be created.
required: true
type: str
name:
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:
<MajorVersion>.<MinorVersion>.<Patch>
required: true
type: str
location:
description:
- Resource location
type: str
publishing_profile:
description:
- Publishing profile.
required: true
type: dict
suboptions:
target_regions:
description: description:
- >- - The name of the resource group.
The target regions where the Image Version is going to be replicated required: true
to. This property is updatable. type: str
type: list gallery_name:
description:
- The name of the Shared Image Gallery in which the Image Definition resides.
required: true
type: str
gallery_image_name:
description:
- The name of the gallery Image Definition in which the Image Version is to be created.
required: true
type: str
name:
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. For example <MajorVersion>.<MinorVersion>.<Patch>.
required: true
type: str
location:
description:
- Resource location.
type: str
publishing_profile:
description:
- Publishing profile.
required: true
type: dict
suboptions: suboptions:
name: target_regions:
description: description:
- Region name. - The target regions where the Image Version is going to be replicated to.
type: str - This property is updatable.
regional_replica_count: type: list
description: suboptions:
- >- name:
The number of replicas of the Image Version to be created per description:
region. This property would take effect for a region when - Region name.
regionalReplicaCount is not specified. This property is updatable. type: str
type: str regional_replica_count:
storage_account_type: description:
description: - The number of replicas of the Image Version to be created per region.
- Storage account type. - This property would take effect for a region when regionalReplicaCount is not specified.
type: str - This property is updatable.
managed_image: type: str
storage_account_type:
description:
- Storage account type.
type: str
managed_image:
description:
- Managed image reference, could be resource ID, or dictionary containing I(resource_group) and I(name).
snapshot:
description:
- Source snapshot to be used.
replica_count:
description:
- 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 updatable.
type: int
exclude_from_latest:
description:
If I(exclude_from_latest=true), Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version.
type: bool
end_of_life_date:
description:
- The end of life date of the gallery Image Version.
- This property can be used for decommissioning purposes.
- This property is updatable. Format should be according to ISO-8601, for instance "2019-06-26".
type: str
storage_account_type:
description:
- Specifies the storage account type to be used to store the image.
- This property is not updatable.
type: str
state:
description: description:
- Managed image reference, could be resource id, or dictionary containing C(resource_group) and C(name) - Assert the state of the GalleryImageVersion.
type: raw - Use C(present) to create or update an GalleryImageVersion and C(absent) to delete it.
snapshot: default: present
description: choices:
- Source snapshot to be used. - absent
type: raw - present
replica_count:
description:
- >-
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 updatable.
type: number
exclude_from_latest:
description:
- >-
If set to true, Virtual Machines deployed from the latest version of
the Image Definition won't use this Image Version.
type: bool
end_of_life_date:
description:
- >-
The end of life date of the gallery Image Version. This property can
be used for decommissioning purposes. This property is updatable.
Format should be according to ISO-8601, for instance "2019-06-26".
type: str type: str
storage_account_type:
description:
- >-
Specifies the storage account type to be used to store the image.
This property is not updatable.
type: str
state:
description:
- Assert the state of the GalleryImageVersion.
- >-
Use C(present) to create or update an GalleryImageVersion and C(absent)
to delete it.
default: present
choices:
- absent
- present
type: str
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
- azure_tags - azure_tags
author: author:
- Zim Kalinowski (@zikalino) - Zim Kalinowski (@zikalino)
''' '''
@ -160,11 +143,11 @@ 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
ry1283/images/myImage/versions/10.1.3" ry1283/images/myImage/versions/10.1.3"
''' '''

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

@ -17,37 +17,33 @@ 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:
resource_group: resource_group:
description: description:
- The name of the resource group. - The name of the resource group.
type: str type: str
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 type: str
resides. required: true
type: str gallery_image_name:
required: true description:
gallery_image_name: - The name of the gallery Image Definition in which the Image Version resides.
description: type: str
- >- required: true
The name of the gallery Image Definition in which the Image Version name:
resides. description:
type: str - Resource name.
required: true type: str
name:
description:
- Resource name
type: str
extends_documentation_fragment: extends_documentation_fragment:
- azure - azure
author: author:
- Liu Qingyi (@smile37773) - Liu Qingyi (@smile37773)
''' '''
@ -68,47 +64,45 @@ 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/images/myImage/versions/myVersion"
/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/ name:
images/myImage/versions/myVersion" description:
name: - Resource name.
description: returned: always
- Resource name type: str
returned: always sample: "myVersion"
type: str location:
sample: "myVersion" description:
location: - Resource location.
description: returned: always
- Resource location type: str
returned: always sample: "eastus"
type: str tags:
sample: "eastus" description:
tags: - Resource tags.
description: returned: always
- Resource tags type: dict
returned: always sample: { "tag": "value" }
type: dict publishing_profile:
sample: { "tag": "value" } description:
publishing_profile: - The publishing profile of a gallery image version.
description: type: dict
- The publishing profile of a gallery image version. provisioning_state:
type: dict description:
provisioning_state: - The current state of the gallery.
description: type: str
- The current state of the gallery. sample: "Succeeded"
type: str
sample: "Succeeded"
''' '''