net_app_resource

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

Overview

Name	net_app_resource
Type	Resource
Id	azure.netapp.net_app_resource

Fields

The following fields are returned by SELECT queries:

check_name_availability

Name	Datatype	Description
isAvailable	boolean	true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.
message	string	If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.
reason	string	Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. Known values are: "Invalid" and "AlreadyExists". (Invalid, AlreadyExists)

check_file_path_availability

Name	Datatype	Description
isAvailable	boolean	true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.
message	string	If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.
reason	string	Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. Known values are: "Invalid" and "AlreadyExists". (Invalid, AlreadyExists)

query_network_sibling_set

Name	Datatype	Description
networkFeatures	string	Network features available to the volume, or current state of update. Known values are: "Basic", "Standard", "Basic_Standard", and "Standard_Basic". (Basic, Standard, Basic_Standard, Standard_Basic)
networkSiblingSetId	string	Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.
networkSiblingSetStateId	string	Network sibling set state Id identifying the current state of the sibling set.
nicInfoList	array	List of NIC information.
provisioningState	string	Gets the status of the NetworkSiblingSet at the time the operation was called. Known values are: "Succeeded", "Failed", "Canceled", and "Updating". (Succeeded, Failed, Canceled, Updating)
subnetId	string	The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_name_availability	select	location, subscription_id		Check resource name availability. Check if a resource name is available.
check_file_path_availability	select	location, subscription_id		Check file path availability. Check if a file path is available.
query_network_sibling_set	select	location, subscription_id		Describe a network sibling set. Get details of the specified network sibling set.
check_quota_availability	exec	location, subscription_id, name, type, resourceGroup		Check quota availability. Check if a quota is available.
query_region_info	exec	location, subscription_id		Describes region specific information. Provides storage to network proximity and logical zone mapping information.
update_network_sibling_set	exec	location, subscription_id, networkSiblingSetId, subnetId, networkSiblingSetStateId, networkFeatures		Update the network features of a network sibling set. Update the network features of the specified network sibling set.

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
location	string	The name of the Azure region. Required.
subscription_id	string

SELECT examples

check_name_availability

Check resource name availability. Check if a resource name is available.

SELECT
isAvailable,
message,
reason
FROM azure.netapp.net_app_resource
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_file_path_availability

Check file path availability. Check if a file path is available.

SELECT
isAvailable,
message,
reason
FROM azure.netapp.net_app_resource
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

query_network_sibling_set

Describe a network sibling set. Get details of the specified network sibling set.

SELECT
networkFeatures,
networkSiblingSetId,
networkSiblingSetStateId,
nicInfoList,
provisioningState,
subnetId
FROM azure.netapp.net_app_resource
WHERE location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

check_quota_availability

Check quota availability. Check if a quota is available.

EXEC azure.netapp.net_app_resource.check_quota_availability 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}", 
"resourceGroup": "{{ resourceGroup }}"
}'
;

query_region_info

Describes region specific information. Provides storage to network proximity and logical zone mapping information.

EXEC azure.netapp.net_app_resource.query_region_info 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_network_sibling_set

Update the network features of a network sibling set. Update the network features of the specified network sibling set.

EXEC azure.netapp.net_app_resource.update_network_sibling_set 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"networkSiblingSetId": "{{ networkSiblingSetId }}", 
"subnetId": "{{ subnetId }}", 
"networkSiblingSetStateId": "{{ networkSiblingSetStateId }}", 
"networkFeatures": "{{ networkFeatures }}"
}'
;