Get a hosted compute network settings resource for an organization

GET

/orgs/{org}/settings/network-settings/{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.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

network_settings_id

required

string

Unique identifier of the hosted compute network settings.

Responses

200

Response

Media type application/json

Hosted compute network settings resource

A hosted compute network settings resource.

object

id

required

The unique identifier of the network settings resource.

string

network_configuration_id

The identifier of the network configuration that is using this settings resource.

string

name

required

The name of the network settings resource.

string

subnet_id

required

The subnet this network settings resource is configured for.

string

region

required

The location of the subnet this network settings resource is configured for.

string

Examples

Example default

{
  "id": "220F78DACB92BBFBC5E6F22DE1CCF52309D",
  "network_configuration_id": "934E208B3EE0BD60CF5F752C426BFB53562",
  "name": "my_network_settings",
  "subnet_id": "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet",
  "region": "eastus"
}

Headers

Link

string

Example

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"