org_network_settings

Creates, updates, deletes, gets or lists an org_network_settings resource.

Overview

Name	org_network_settings
Type	Resource
Id	github.hosted_compute.org_network_settings

Fields

The following fields are returned by SELECT queries:

get_network_settings_for_org

Response

Name	Datatype	Description
id	string	The unique identifier of the network settings resource. (example: 220F78DACB92BBFBC5E6F22DE1CCF52309D)
name	string	The name of the network settings resource. (example: my-network-settings)
network_configuration_id	string	The identifier of the network configuration that is using this settings resource. (example: 934E208B3EE0BD60CF5F752C426BFB53562)
subnet_id	string	The subnet this network settings resource is configured for. (example: /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet)
region	string	The location of the subnet this network settings resource is configured for. (example: eastus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network_settings_for_org	select	org, network_settings_id		Gets a hosted compute network settings resource configured for an organization. OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

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
network_settings_id	string	Unique identifier of the hosted compute network settings.
org	string	The organization name. The name is not case sensitive.

SELECT examples

get_network_settings_for_org

Gets a hosted compute network settings resource configured for an organization.

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

SELECT
id,
name,
network_configuration_id,
subnet_id,
region
FROM github.hosted_compute.org_network_settings
WHERE org = '{{ org }}' -- required
AND network_settings_id = '{{ network_settings_id }}' -- required
;