gallery_in_vm_access_control_profile_versions

Creates, updates, deletes, gets or lists a gallery_in_vm_access_control_profile_versions resource.

Overview

Name	gallery_in_vm_access_control_profile_versions
Type	Resource
Id	azure.compute.gallery_in_vm_access_control_profile_versions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
defaultAccess	string	This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. Required. Known values are: "Allow" and "Deny". (Allow, Deny)
excludeFromLatest	boolean	If set to true, Virtual Machines deployed from the latest version of the Resource Profile won't use this Profile version.
location	string	The geo-location where the resource lives. Required.
mode	string	This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. Required. Known values are: "Audit", "Enforce", and "Disabled". (Audit, Enforce, Disabled)
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Deleting, Migrating)
publishedDate	string (date-time)	The timestamp for when the Resource Profile Version is published.
replicationStatus	object	This is the replication status of the gallery image version.
rules	object	This is the Access Control Rules specification for an inVMAccessControlProfile version.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetLocations	array	The target regions where the Resource Profile version is going to be replicated to. This property is updatable.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_gallery_in_vm_access_control_profile

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
defaultAccess	string	This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'. Required. Known values are: "Allow" and "Deny". (Allow, Deny)
excludeFromLatest	boolean	If set to true, Virtual Machines deployed from the latest version of the Resource Profile won't use this Profile version.
location	string	The geo-location where the resource lives. Required.
mode	string	This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'. Required. Known values are: "Audit", "Enforce", and "Disabled". (Audit, Enforce, Disabled)
provisioningState	string	The provisioning state, which only appears in the response. Known values are: "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Creating, Updating, Failed, Succeeded, Deleting, Migrating)
publishedDate	string (date-time)	The timestamp for when the Resource Profile Version is published.
replicationStatus	object	This is the replication status of the gallery image version.
rules	object	This is the Access Control Rules specification for an inVMAccessControlProfile version.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetLocations	array	The target regions where the Resource Profile version is going to be replicated to. This property is updatable.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, gallery_name, in_vm_access_control_profile_name, in_vm_access_control_profile_version_name, subscription_id		Retrieves information about a gallery inVMAccessControlProfile version.
list_by_gallery_in_vm_access_control_profile	select	resource_group_name, gallery_name, in_vm_access_control_profile_name, subscription_id		List gallery inVMAccessControlProfile versions in a gallery inVMAccessControlProfile.
create_or_update	insert	resource_group_name, gallery_name, in_vm_access_control_profile_name, in_vm_access_control_profile_version_name, subscription_id, location		Create or update a gallery inVMAccessControlProfile version.
update	update	resource_group_name, gallery_name, in_vm_access_control_profile_name, in_vm_access_control_profile_version_name, subscription_id		Update a gallery inVMAccessControlProfile version.
create_or_update	replace	resource_group_name, gallery_name, in_vm_access_control_profile_name, in_vm_access_control_profile_version_name, subscription_id, location		Create or update a gallery inVMAccessControlProfile version.
delete	delete	resource_group_name, gallery_name, in_vm_access_control_profile_name, in_vm_access_control_profile_version_name, subscription_id		Delete a gallery inVMAccessControlProfile version.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
gallery_name	string	The name of the Shared Image Gallery. Required.
in_vm_access_control_profile_name	string	The name of the gallery inVMAccessControlProfile to be retrieved. Required.
in_vm_access_control_profile_version_name	string	The name of the gallery inVMAccessControlProfile version to be retrieved. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves information about a gallery inVMAccessControlProfile version.

SELECT
id,
name,
defaultAccess,
excludeFromLatest,
location,
mode,
provisioningState,
publishedDate,
replicationStatus,
rules,
systemData,
tags,
targetLocations,
type
FROM azure.compute.gallery_in_vm_access_control_profile_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND in_vm_access_control_profile_name = '{{ in_vm_access_control_profile_name }}' -- required
AND in_vm_access_control_profile_version_name = '{{ in_vm_access_control_profile_version_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_gallery_in_vm_access_control_profile

List gallery inVMAccessControlProfile versions in a gallery inVMAccessControlProfile.

SELECT
id,
name,
defaultAccess,
excludeFromLatest,
location,
mode,
provisioningState,
publishedDate,
replicationStatus,
rules,
systemData,
tags,
targetLocations,
type
FROM azure.compute.gallery_in_vm_access_control_profile_versions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND in_vm_access_control_profile_name = '{{ in_vm_access_control_profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a gallery inVMAccessControlProfile version.

INSERT INTO azure.compute.gallery_in_vm_access_control_profile_versions (
tags,
location,
properties,
resource_group_name,
gallery_name,
in_vm_access_control_profile_name,
in_vm_access_control_profile_version_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ gallery_name }}',
'{{ in_vm_access_control_profile_name }}',
'{{ in_vm_access_control_profile_version_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: gallery_in_vm_access_control_profile_versions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gallery_in_vm_access_control_profile_versions resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the gallery_in_vm_access_control_profile_versions resource.
  - name: in_vm_access_control_profile_name
    value: "{{ in_vm_access_control_profile_name }}"
    description: Required parameter for the gallery_in_vm_access_control_profile_versions resource.
  - name: in_vm_access_control_profile_version_name
    value: "{{ in_vm_access_control_profile_version_name }}"
    description: Required parameter for the gallery_in_vm_access_control_profile_versions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gallery_in_vm_access_control_profile_versions resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Describes the properties of an inVMAccessControlProfile version.
    value:
      targetLocations:
        - name: "{{ name }}"
          regionalReplicaCount: {{ regionalReplicaCount }}
          storageAccountType: "{{ storageAccountType }}"
          encryption:
            osDiskImage:
              diskEncryptionSetId: "{{ diskEncryptionSetId }}"
              securityProfile:
                confidentialVMEncryptionType: "{{ confidentialVMEncryptionType }}"
                secureVMDiskEncryptionSetId: "{{ secureVMDiskEncryptionSetId }}"
            dataDiskImages:
              - diskEncryptionSetId: "{{ diskEncryptionSetId }}"
                lun: {{ lun }}
          excludeFromLatest: {{ excludeFromLatest }}
          additionalReplicaSets: "{{ additionalReplicaSets }}"
      excludeFromLatest: {{ excludeFromLatest }}
      publishedDate: "{{ publishedDate }}"
      provisioningState: "{{ provisioningState }}"
      replicationStatus:
        aggregatedState: "{{ aggregatedState }}"
        summary:
          - region: "{{ region }}"
            state: "{{ state }}"
            details: "{{ details }}"
            progress: {{ progress }}
      mode: "{{ mode }}"
      defaultAccess: "{{ defaultAccess }}"
      rules:
        privileges:
          - name: "{{ name }}"
            path: "{{ path }}"
            queryParameters: "{{ queryParameters }}"
        roles:
          - name: "{{ name }}"
            privileges: "{{ privileges }}"
        identities:
          - name: "{{ name }}"
            userName: "{{ userName }}"
            groupName: "{{ groupName }}"
            exePath: "{{ exePath }}"
            processName: "{{ processName }}"
        roleAssignments:
          - role: "{{ role }}"
            identities: "{{ identities }}"

UPDATE examples

update

Update a gallery inVMAccessControlProfile version.

UPDATE azure.compute.gallery_in_vm_access_control_profile_versions
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND in_vm_access_control_profile_name = '{{ in_vm_access_control_profile_name }}' --required
AND in_vm_access_control_profile_version_name = '{{ in_vm_access_control_profile_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a gallery inVMAccessControlProfile version.

REPLACE azure.compute.gallery_in_vm_access_control_profile_versions
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND in_vm_access_control_profile_name = '{{ in_vm_access_control_profile_name }}' --required
AND in_vm_access_control_profile_version_name = '{{ in_vm_access_control_profile_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a gallery inVMAccessControlProfile version.

DELETE FROM azure.compute.gallery_in_vm_access_control_profile_versions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND gallery_name = '{{ gallery_name }}' --required
AND in_vm_access_control_profile_name = '{{ in_vm_access_control_profile_name }}' --required
AND in_vm_access_control_profile_version_name = '{{ in_vm_access_control_profile_version_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;