jit_network_access_policies

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

Overview

Name	jit_network_access_policies
Type	Resource
Id	azure.security.jit_network_access_policies

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.
kind	string	Kind of the resource.
location	string	Location where the resource is stored. Required.
provisioningState	string	Gets the provisioning state of the Just-in-Time policy.
requests	array	:vartype requests: list[~azure.mgmt.security.models.JitNetworkAccessRequest]
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachines	array	Configurations for Microsoft.Compute/virtualMachines resource type. Required.

list_by_resource_group_and_region

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.
kind	string	Kind of the resource.
location	string	Location where the resource is stored. Required.
provisioningState	string	Gets the provisioning state of the Just-in-Time policy.
requests	array	:vartype requests: list[~azure.mgmt.security.models.JitNetworkAccessRequest]
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachines	array	Configurations for Microsoft.Compute/virtualMachines resource type. Required.

list_by_region

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.
kind	string	Kind of the resource.
location	string	Location where the resource is stored. Required.
provisioningState	string	Gets the provisioning state of the Just-in-Time policy.
requests	array	:vartype requests: list[~azure.mgmt.security.models.JitNetworkAccessRequest]
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachines	array	Configurations for Microsoft.Compute/virtualMachines resource type. Required.

list_by_resource_group

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.
kind	string	Kind of the resource.
location	string	Location where the resource is stored. Required.
provisioningState	string	Gets the provisioning state of the Just-in-Time policy.
requests	array	:vartype requests: list[~azure.mgmt.security.models.JitNetworkAccessRequest]
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachines	array	Configurations for Microsoft.Compute/virtualMachines resource type. Required.

list

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.
kind	string	Kind of the resource.
location	string	Location where the resource is stored. Required.
provisioningState	string	Gets the provisioning state of the Just-in-Time policy.
requests	array	:vartype requests: list[~azure.mgmt.security.models.JitNetworkAccessRequest]
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualMachines	array	Configurations for Microsoft.Compute/virtualMachines resource type. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, asc_location, jit_network_access_policy_name, subscription_id		Policies for protecting resources using Just-in-Time access control for the subscription, location.
list_by_resource_group_and_region	select	resource_group_name, asc_location, subscription_id		Policies for protecting resources using Just-in-Time access control for the subscription, location.
list_by_region	select	asc_location, subscription_id		Policies for protecting resources using Just-in-Time access control for the subscription, location.
list_by_resource_group	select	resource_group_name, subscription_id		Policies for protecting resources using Just-in-Time access control for the subscription, location.
list	select	subscription_id		Policies for protecting resources using Just-in-Time access control.
create_or_update	insert	resource_group_name, asc_location, jit_network_access_policy_name, subscription_id, properties		Create a policy for protecting resources using Just-in-Time access control.
create_or_update	replace	resource_group_name, asc_location, jit_network_access_policy_name, subscription_id, properties		Create a policy for protecting resources using Just-in-Time access control.
delete	delete	resource_group_name, asc_location, jit_network_access_policy_name, subscription_id		Delete a Just-in-Time access control policy.
initiate	exec	resource_group_name, asc_location, jit_network_access_policy_name, subscription_id, virtualMachines		Initiate a JIT access from a specific Just-in-Time policy configuration.

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
asc_location	string	The location where ASC stores the data of the subscription. can be retrieved from Get locations. Required.
jit_network_access_policy_name	string	Name of a Just-in-Time access configuration policy. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Policies for protecting resources using Just-in-Time access control for the subscription, location.

SELECT
id,
name,
kind,
location,
provisioningState,
requests,
systemData,
type,
virtualMachines
FROM azure.security.jit_network_access_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND asc_location = '{{ asc_location }}' -- required
AND jit_network_access_policy_name = '{{ jit_network_access_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group_and_region

Policies for protecting resources using Just-in-Time access control for the subscription, location.

SELECT
id,
name,
kind,
location,
provisioningState,
requests,
systemData,
type,
virtualMachines
FROM azure.security.jit_network_access_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND asc_location = '{{ asc_location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_region

Policies for protecting resources using Just-in-Time access control for the subscription, location.

SELECT
id,
name,
kind,
location,
provisioningState,
requests,
systemData,
type,
virtualMachines
FROM azure.security.jit_network_access_policies
WHERE asc_location = '{{ asc_location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Policies for protecting resources using Just-in-Time access control for the subscription, location.

SELECT
id,
name,
kind,
location,
provisioningState,
requests,
systemData,
type,
virtualMachines
FROM azure.security.jit_network_access_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Policies for protecting resources using Just-in-Time access control.

SELECT
id,
name,
kind,
location,
provisioningState,
requests,
systemData,
type,
virtualMachines
FROM azure.security.jit_network_access_policies
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a policy for protecting resources using Just-in-Time access control.

INSERT INTO azure.security.jit_network_access_policies (
properties,
kind,
resource_group_name,
asc_location,
jit_network_access_policy_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ kind }}',
'{{ resource_group_name }}',
'{{ asc_location }}',
'{{ jit_network_access_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: jit_network_access_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the jit_network_access_policies resource.
  - name: asc_location
    value: "{{ asc_location }}"
    description: Required parameter for the jit_network_access_policies resource.
  - name: jit_network_access_policy_name
    value: "{{ jit_network_access_policy_name }}"
    description: Required parameter for the jit_network_access_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the jit_network_access_policies resource.
  - name: properties
    description: |
      Required.
    value:
      virtualMachines:
        - id: "{{ id }}"
          ports: "{{ ports }}"
          publicIpAddress: "{{ publicIpAddress }}"
      requests:
        - virtualMachines: "{{ virtualMachines }}"
          startTimeUtc: "{{ startTimeUtc }}"
          requestor: "{{ requestor }}"
          justification: "{{ justification }}"
      provisioningState: "{{ provisioningState }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of the resource.

REPLACE examples

create_or_update

Create a policy for protecting resources using Just-in-Time access control.

REPLACE azure.security.jit_network_access_policies
SET 
properties = '{{ properties }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND asc_location = '{{ asc_location }}' --required
AND jit_network_access_policy_name = '{{ jit_network_access_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
kind,
location,
properties,
systemData,
type;

DELETE examples

delete

Delete a Just-in-Time access control policy.

DELETE FROM azure.security.jit_network_access_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND asc_location = '{{ asc_location }}' --required
AND jit_network_access_policy_name = '{{ jit_network_access_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

initiate

Initiate a JIT access from a specific Just-in-Time policy configuration.

EXEC azure.security.jit_network_access_policies.initiate 
@resource_group_name='{{ resource_group_name }}' --required, 
@asc_location='{{ asc_location }}' --required, 
@jit_network_access_policy_name='{{ jit_network_access_policy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"virtualMachines": "{{ virtualMachines }}", 
"justification": "{{ justification }}"
}'
;