diff --git a/lib/ansible/modules/cloud/azure/azure_rm_gallery.py b/lib/ansible/modules/cloud/azure/azure_rm_gallery.py index 9c30f3723a0..3fee6dfdb9e 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_gallery.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_gallery.py @@ -17,48 +17,43 @@ DOCUMENTATION = ''' --- module: azure_rm_gallery version_added: '2.9' -short_description: Manage Azure Shared Image Gallery instance. +short_description: Manage Azure Shared Image Gallery instance description: - - 'Create, update and delete instance of Azure Shared Image Gallery (SIG).' + - Create, update and delete instance of Azure Shared Image Gallery (SIG). 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: - - 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 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 + 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: - - azure - - azure_tags + - azure + - azure_tags author: - - Zim Kalinowski (@zikalino) + - Zim Kalinowski (@zikalino) ''' @@ -73,11 +68,11 @@ EXAMPLES = ''' RETURN = ''' id: - description: - - Resource Id - returned: always - type: str - sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery1283" + description: + - Resource ID. + returned: always + type: str + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGallery1283" ''' import time diff --git a/lib/ansible/modules/cloud/azure/azure_rm_gallery_info.py b/lib/ansible/modules/cloud/azure/azure_rm_gallery_info.py index 745e3b2efd8..98e44674f26 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_gallery_info.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_gallery_info.py @@ -17,22 +17,22 @@ DOCUMENTATION = ''' --- module: azure_rm_gallery_info version_added: '2.9' -short_description: Get Azure Shared Image Gallery info. +short_description: Get Azure Shared Image Gallery info description: - - Get info of Azure Shared Image Gallery. + - Get info of Azure Shared Image Gallery. options: - resource_group: - description: - - The name of the resource group. - type: str - name: - description: - - Resource name - type: str + resource_group: + description: + - The name of the resource group. + type: str + name: + description: + - Resource name + type: str extends_documentation_fragment: - - azure + - azure author: - - Liu Qingyi (@smile37773) + - Liu Qingyi (@smile37773) ''' @@ -51,47 +51,47 @@ EXAMPLES = ''' RETURN = ''' 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: - - This is the gallery description. - type: str - sample: "This is the gallery description." - provisioning_state: + - 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: - - The current state of the gallery. - type: str - sample: "Succeeded" + description: + - This is the gallery description. + 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" ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_galleryimage.py b/lib/ansible/modules/cloud/azure/azure_rm_galleryimage.py index c5a76d94ec3..6ef017c5ee9 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_galleryimage.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_galleryimage.py @@ -17,169 +17,160 @@ DOCUMENTATION = ''' --- module: azure_rm_galleryimage version_added: '2.9' -short_description: Manage Azure SIG Image instance. +short_description: Manage Azure SIG Image instance description: - - 'Create, update and delete instance of Azure SIG Image.' + - Create, update and delete instance of Azure SIG Image. options: - 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: + resource_group: description: - - The name of the gallery Image Definition publisher. + - The name of the resource group. required: true type: str - offer: + gallery_name: 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 type: str - sku: + name: 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 type: str - recommended: + location: + description: + - Resource location. + type: str description: - - Recommended parameter values. - type: dict - suboptions: - v_cpus: 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 suboptions: - min: - description: - - The minimum number of the resource. - type: int - max: - description: - - The maximum number of the resource. - type: int - memory: + publisher: + description: + - The name of the gallery Image Definition publisher. + required: true + type: str + offer: + description: + - The name of the gallery Image Definition offer. + required: true + type: str + sku: + description: + - The name of the gallery Image Definition SKU. + required: true + type: str + recommended: description: - - Memory. + - Recommended parameter values. 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: - - Disallowed parameter values. - type: dict - suboptions: - disk_types: + v_cpus: + description: + - Number of virtual CPUs. + type: dict + suboptions: + min: + description: + - The minimum number of the resource. + type: int + max: + description: + - The maximum number of the resource. + type: int + 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: - - A list of disallowed disk types. - type: list - purchase_plan: - description: - - Purchase plan. - type: dict - suboptions: - name: + - Disallowed parameter values. + type: dict + suboptions: + disk_types: + description: + - A list of disallowed disk types. + type: list + purchase_plan: 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 - 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: - - azure - - azure_tags + - azure + - azure_tags author: - Zim Kalinowski (@zikalino) @@ -202,11 +193,11 @@ EXAMPLES = ''' RETURN = ''' id: - description: - - Resource Id - returned: always - type: str - sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle + description: + - Resource ID. + returned: always + type: str + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage" ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_galleryimage_info.py b/lib/ansible/modules/cloud/azure/azure_rm_galleryimage_info.py index e58a1f4e027..e1f23c38f98 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_galleryimage_info.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_galleryimage_info.py @@ -17,30 +17,28 @@ DOCUMENTATION = ''' --- module: azure_rm_galleryimage_info version_added: '2.9' -short_description: Get Azure SIG Image info. +short_description: Get Azure SIG Image info description: - - Get info of Azure SIG Image. + - Get info of Azure SIG Image. options: - resource_group: - description: - - The name of the resource group. - type: str - required: true - gallery_name: - description: - - >- - The name of the shared image gallery from which the image definitions - are to be retrieved. - type: str - required: true - name: - description: - - Resource name - type: str + resource_group: + description: + - The name of the resource group. + type: str + required: true + gallery_name: + description: + - The name of the shared image gallery from which the image definitions are to be retrieved. + type: str + required: true + name: + description: + - Resource name. + type: str extends_documentation_fragment: - - azure + - azure author: - - Liu Qingyi (@smile37773) + - Liu Qingyi (@smile37773) ''' @@ -59,68 +57,66 @@ EXAMPLES = ''' RETURN = ''' images: - description: >- - A list of dict results where the key is the name of the image and the - values are the info for that image. - 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/images/myImage" - name: - description: - - Resource name - returned: always - type: str - sample: myImage - location: - description: - - Resource location - returned: always - type: str - sample: "eastus" - tags: - description: - - Resource tags - returned: always - type: dict - sample: { "tag": "value" } - os_state: - description: - - The allowed values for OS State are 'Generalized'. - type: OperatingSystemStateTypes - sample: "Generalized" - 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. - type: OperatingSystemTypes - sample: "linux/windows" - identifier: - description: - - This is the gallery image definition identifier. - type: dict - contains: - offer: - description: - - The name of the gallery image definition offer. - type: str - sample: "myOfferName" - publisher: - description: - - The name of the gallery image definition publisher. - type: str - sample: "myPublisherName" - sku: - description: - - The name of the gallery image definition sku. - type: str - sample: "mySkuName" + description: + - A list of dict results where the key is the name of the image and the values are the info for that image. + 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/images/myImage" + name: + description: + - Resource name. + returned: always + type: str + sample: myImage + location: + description: + - Resource location. + returned: always + type: str + sample: "eastus" + tags: + description: + - Resource tags. + returned: always + type: dict + sample: { "tag": "value" } + os_state: + description: + - The allowed values for OS State are C(generalized). + type: OperatingSystemStateTypes + sample: "Generalized" + 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. + type: OperatingSystemTypes + sample: "linux/windows" + identifier: + description: + - This is the gallery image definition identifier. + type: dict + contains: + offer: + description: + - The name of the gallery image definition offer. + type: str + sample: "myOfferName" + publisher: + description: + - The name of the gallery image definition publisher. + type: str + sample: "myPublisherName" + sku: + description: + - The name of the gallery image definition sku. + type: str + sample: "mySkuName" ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion.py b/lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion.py index b21593a9456..76f77f5c4c4 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion.py @@ -17,120 +17,103 @@ DOCUMENTATION = ''' --- module: azure_rm_galleryimageversion version_added: '2.9' -short_description: Manage Azure SIG Image Version instance. +short_description: Manage Azure SIG Image Version instance description: - - 'Create, update and delete instance of Azure SIG Image Version.' + - Create, update and delete instance of Azure SIG Image Version. options: - 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: - .. - required: true - type: str - location: - description: - - Resource location - type: str - publishing_profile: - description: - - Publishing profile. - required: true - type: dict - suboptions: - target_regions: + resource_group: description: - - >- - The target regions where the Image Version is going to be replicated - to. This property is updatable. - type: list + - 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. For example ... + required: true + type: str + location: + description: + - Resource location. + type: str + publishing_profile: + description: + - Publishing profile. + required: true + type: dict suboptions: - name: - description: - - Region name. - type: str - regional_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: str - storage_account_type: - description: - - Storage account type. - type: str - managed_image: + target_regions: + description: + - The target regions where the Image Version is going to be replicated to. + - This property is updatable. + type: list + suboptions: + name: + description: + - Region name. + type: str + regional_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: 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: - - Managed image reference, could be resource id, or dictionary containing C(resource_group) and C(name) - type: raw - snapshot: - description: - - Source snapshot to be used. - type: raw - 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". + - 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 - 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: - - azure - - azure_tags + - azure + - azure_tags author: - - Zim Kalinowski (@zikalino) + - Zim Kalinowski (@zikalino) ''' @@ -160,11 +143,11 @@ EXAMPLES = ''' RETURN = ''' id: - description: - - Resource Id - returned: always - type: str - sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle + description: + - Resource ID. + returned: always + type: str + sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage/versions/10.1.3" ''' diff --git a/lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion_info.py b/lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion_info.py index 3e61b48ca18..a5d5339f2f6 100644 --- a/lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion_info.py +++ b/lib/ansible/modules/cloud/azure/azure_rm_galleryimageversion_info.py @@ -17,37 +17,33 @@ DOCUMENTATION = ''' --- module: azure_rm_galleryimageversion_info version_added: '2.9' -short_description: Get Azure SIG Image Version info. +short_description: Get Azure SIG Image Version info description: - - Get info of Azure SIG Image Version. + - Get info of Azure SIG Image Version. options: - resource_group: - description: - - The name of the resource group. - type: str - required: true - gallery_name: - description: - - >- - The name of the Shared Image Gallery in which the Image Definition - resides. - type: str - required: true - gallery_image_name: - description: - - >- - The name of the gallery Image Definition in which the Image Version - resides. - type: str - required: true - name: - description: - - Resource name - type: str + resource_group: + description: + - The name of the resource group. + type: str + required: true + gallery_name: + description: + - The name of the Shared Image Gallery in which the Image Definition resides. + type: str + required: true + gallery_image_name: + description: + - The name of the gallery Image Definition in which the Image Version resides. + type: str + required: true + name: + description: + - Resource name. + type: str extends_documentation_fragment: - - azure + - azure author: - - Liu Qingyi (@smile37773) + - Liu Qingyi (@smile37773) ''' @@ -68,47 +64,45 @@ EXAMPLES = ''' RETURN = ''' versions: - description: >- - A list of dict results where the key is the name of the version - and the values are the info for that version. - 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/ - images/myImage/versions/myVersion" - name: - description: - - Resource name - returned: always - type: str - sample: "myVersion" - location: - description: - - Resource location - returned: always - type: str - sample: "eastus" - tags: - description: - - Resource tags - returned: always - type: dict - sample: { "tag": "value" } - publishing_profile: - description: - - The publishing profile of a gallery image version. - type: dict - provisioning_state: - description: - - The current state of the gallery. - type: str - sample: "Succeeded" + description: + A list of dict results where the key is the name of the version and the values are the info for that version. + 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/images/myImage/versions/myVersion" + name: + description: + - Resource name. + returned: always + type: str + sample: "myVersion" + location: + description: + - Resource location. + returned: always + type: str + sample: "eastus" + tags: + description: + - Resource tags. + returned: always + type: dict + sample: { "tag": "value" } + publishing_profile: + description: + - The publishing profile of a gallery image version. + type: dict + provisioning_state: + description: + - The current state of the gallery. + type: str + sample: "Succeeded" '''