Gets all of the available subnet delegations for this subscription in this region.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableDelegations?api-version=2024-01-01
URI Parameters
Name |
In |
Required |
Type |
Description |
location
|
path |
True
|
string
|
The location of the subnet.
|
subscriptionId
|
path |
True
|
string
|
The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
|
api-version
|
query |
True
|
string
|
Client API version.
|
Responses
Name |
Type |
Description |
200 OK
|
AvailableDelegationsResult
|
Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.
|
Other Status Codes
|
CloudError
|
Error response describing why the operation failed.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
impersonate your user account
|
Examples
Get available delegations
Sample request
GET https://management.azure.com/subscriptions/subId/providers/Microsoft.Network/locations/westcentralus/availableDelegations?api-version=2024-01-01
/**
* Samples for AvailableDelegations List.
*/
public final class Main {
/*
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/
* AvailableDelegationsSubscriptionGet.json
*/
/**
* Sample code: Get available delegations.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getAvailableDelegations(com.azure.resourcemanager.AzureResourceManager azure) {
azure.networks().manager().serviceClient().getAvailableDelegations().list("westcentralus",
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-network
# USAGE
python available_delegations_subscription_get.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = NetworkManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subId",
)
response = client.available_delegations.list(
location="westcentralus",
)
for item in response:
print(item)
# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsSubscriptionGet.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armnetwork_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v6"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/81a4ee5a83ae38620c0e1404793caffe005d26e4/specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsSubscriptionGet.json
func ExampleAvailableDelegationsClient_NewListPager() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armnetwork.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewAvailableDelegationsClient().NewListPager("westcentralus", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.AvailableDelegationsResult = armnetwork.AvailableDelegationsResult{
// Value: []*armnetwork.AvailableDelegation{
// {
// Name: to.Ptr("Microsoft.Provider.resourceType"),
// Type: to.Ptr("Microsoft.Network/availableDelegations"),
// Actions: []*string{
// to.Ptr("Microsoft.Network/resource/action")},
// ID: to.Ptr("/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType"),
// ServiceName: to.Ptr("Microsoft.Provider/resourceType"),
// }},
// }
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { NetworkManagementClient } = require("@azure/arm-network");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets all of the available subnet delegations for this subscription in this region.
*
* @summary Gets all of the available subnet delegations for this subscription in this region.
* x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2024-01-01/examples/AvailableDelegationsSubscriptionGet.json
*/
async function getAvailableDelegations() {
const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subId";
const location = "westcentralus";
const credential = new DefaultAzureCredential();
const client = new NetworkManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.availableDelegations.list(location)) {
resArray.push(item);
}
console.log(resArray);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"value": [
{
"name": "Microsoft.Provider.resourceType",
"id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType",
"type": "Microsoft.Network/availableDelegations",
"serviceName": "Microsoft.Provider/resourceType",
"actions": [
"Microsoft.Network/resource/action"
]
}
]
}
Definitions
AvailableDelegation
The serviceName of an AvailableDelegation indicates a possible delegation for a subnet.
Name |
Type |
Description |
actions
|
string[]
|
The actions permitted to the service upon delegation.
|
id
|
string
|
A unique identifier of the AvailableDelegation resource.
|
name
|
string
|
The name of the AvailableDelegation resource.
|
serviceName
|
string
|
The name of the service and resource.
|
type
|
string
|
Resource type.
|
AvailableDelegationsResult
An array of available delegations.
Name |
Type |
Description |
nextLink
|
string
|
The URL to get the next set of results.
|
value
|
AvailableDelegation[]
|
An array of available delegations.
|
CloudError
An error response from the service.
CloudErrorBody
An error response from the service.
Name |
Type |
Description |
code
|
string
|
An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
|
details
|
CloudErrorBody[]
|
A list of additional details about the error.
|
message
|
string
|
A message describing the error, intended to be suitable for display in a user interface.
|
target
|
string
|
The target of the particular error. For example, the name of the property in error.
|