network_security_perimeter

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

Overview

Name	network_security_perimeter
Type	Resource
Id	azure.batch.network_security_perimeter

Fields

The following fields are returned by SELECT queries:

get_configuration

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.
networkSecurityPerimeter	object	Information about a network security perimeter (NSP).
profile	object	:vartype profile: ~azure.mgmt.batch.models.NetworkSecurityProfile
provisioningIssues	array	List of provisioning issues, if any.
provisioningState	string	Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "Canceled". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, Canceled)
resourceAssociation	object	:vartype resource_association: ~azure.mgmt.batch.models.ResourceAssociation
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".

list_configurations

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.
networkSecurityPerimeter	object	Information about a network security perimeter (NSP).
profile	object	:vartype profile: ~azure.mgmt.batch.models.NetworkSecurityProfile
provisioningIssues	array	List of provisioning issues, if any.
provisioningState	string	Known values are: "Succeeded", "Creating", "Updating", "Deleting", "Accepted", "Failed", and "Canceled". (Succeeded, Creating, Updating, Deleting, Accepted, Failed, Canceled)
resourceAssociation	object	:vartype resource_association: ~azure.mgmt.batch.models.ResourceAssociation
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration	select	resource_group_name, account_name, network_security_perimeter_configuration_name, subscription_id		Gets information about the specified NSP configuration.
list_configurations	select	resource_group_name, account_name, subscription_id		Lists all of the NSP configurations in the specified account.
reconcile_configuration	exec	resource_group_name, account_name, network_security_perimeter_configuration_name, subscription_id		Reconciles the specified NSP 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
account_name	string	A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/ _. Required.
network_security_perimeter_configuration_name	string	The name for a network security perimeter configuration. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_configuration

Gets information about the specified NSP configuration.

SELECT
id,
name,
networkSecurityPerimeter,
profile,
provisioningIssues,
provisioningState,
resourceAssociation,
systemData,
type
FROM azure.batch.network_security_perimeter
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND network_security_perimeter_configuration_name = '{{ network_security_perimeter_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_configurations

Lists all of the NSP configurations in the specified account.

SELECT
id,
name,
networkSecurityPerimeter,
profile,
provisioningIssues,
provisioningState,
resourceAssociation,
systemData,
type
FROM azure.batch.network_security_perimeter
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

reconcile_configuration

Reconciles the specified NSP configuration.

EXEC azure.batch.network_security_perimeter.reconcile_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@network_security_perimeter_configuration_name='{{ network_security_perimeter_configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;