gallery_in_vm_access_control_profiles

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

Overview

Name	gallery_in_vm_access_control_profiles
Type	Resource
Id	azure.compute.gallery_in_vm_access_control_profiles

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.
applicableHostEndpoint	string	This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS'. Required. Known values are: "WireServer" and "IMDS". (WireServer, IMDS)
description	string	The description of this gallery inVMAccessControlProfile resources. This property is updatable.
location	string	The geo-location where the resource lives. Required.
osType	string	This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux'. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
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)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_gallery

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.
applicableHostEndpoint	string	This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS'. Required. Known values are: "WireServer" and "IMDS". (WireServer, IMDS)
description	string	The description of this gallery inVMAccessControlProfile resources. This property is updatable.
location	string	The geo-location where the resource lives. Required.
osType	string	This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux'. Required. Known values are: "Windows" and "Linux". (Windows, Linux)
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)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, subscription_id		Retrieves information about a gallery inVMAccessControlProfile.
list_by_gallery	select	resource_group_name, gallery_name, subscription_id		List gallery inVMAccessControlProfiles in a gallery.
create_or_update	insert	resource_group_name, gallery_name, in_vm_access_control_profile_name, subscription_id, location		Create or update a gallery inVMAccessControlProfile.
update	update	resource_group_name, gallery_name, in_vm_access_control_profile_name, subscription_id		Update a gallery inVMAccessControlProfile.
create_or_update	replace	resource_group_name, gallery_name, in_vm_access_control_profile_name, subscription_id, location		Create or update a gallery inVMAccessControlProfile.
delete	delete	resource_group_name, gallery_name, in_vm_access_control_profile_name, subscription_id		Delete a gallery inVMAccessControlProfile.

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.
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.

SELECT
id,
name,
applicableHostEndpoint,
description,
location,
osType,
provisioningState,
systemData,
tags,
type
FROM azure.compute.gallery_in_vm_access_control_profiles
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
;

list_by_gallery

List gallery inVMAccessControlProfiles in a gallery.

SELECT
id,
name,
applicableHostEndpoint,
description,
location,
osType,
provisioningState,
systemData,
tags,
type
FROM azure.compute.gallery_in_vm_access_control_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a gallery inVMAccessControlProfile.

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

Manifest

# Description fields are for documentation purposes
- name: gallery_in_vm_access_control_profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the gallery_in_vm_access_control_profiles resource.
  - name: gallery_name
    value: "{{ gallery_name }}"
    description: Required parameter for the gallery_in_vm_access_control_profiles 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_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the gallery_in_vm_access_control_profiles 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 a gallery inVMAccessControlProfile.
    value:
      provisioningState: "{{ provisioningState }}"
      description: "{{ description }}"
      osType: "{{ osType }}"
      applicableHostEndpoint: "{{ applicableHostEndpoint }}"

UPDATE examples

update

Update a gallery inVMAccessControlProfile.

UPDATE azure.compute.gallery_in_vm_access_control_profiles
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a gallery inVMAccessControlProfile.

REPLACE azure.compute.gallery_in_vm_access_control_profiles
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 subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a gallery inVMAccessControlProfile.

DELETE FROM azure.compute.gallery_in_vm_access_control_profiles
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
;