Service Endpoint Policy Definitions - List By Resource Group

Referensi

Service:: ExpressRoute

API Version:: 2023-09-01

Mendapatkan semua definisi kebijakan titik akhir layanan dalam kebijakan titik akhir layanan.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions?api-version=2023-09-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya.
serviceEndpointPolicyName	path	True	string	Nama kebijakan titik akhir layanan.
subscriptionId	path	True	string	Info masuk langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API klien.

Respons

Nama	Jenis	Deskripsi
200 OK	ServiceEndpointPolicyDefinitionListResult	Permintaan berhasil. Operasi mengembalikan daftar sumber daya ServiceEndpointPolicyDefinition.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

List service endpoint definitions in service end point policy

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions?api-version=2023-09-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.network import NetworkManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-network
# USAGE
    python service_endpoint_policy_definition_list.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.service_endpoint_policy_definitions.list_by_resource_group(
        resource_group_name="rg1",
        service_endpoint_policy_name="testPolicy",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ServiceEndpointPolicyDefinitionList.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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d4205894880b989ede35d62d97c8e901ed14fb5a/specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ServiceEndpointPolicyDefinitionList.json
func ExampleServiceEndpointPolicyDefinitionsClient_NewListByResourceGroupPager() {
	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.NewServiceEndpointPolicyDefinitionsClient().NewListByResourceGroupPager("rg1", "testPolicy", 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.ServiceEndpointPolicyDefinitionListResult = armnetwork.ServiceEndpointPolicyDefinitionListResult{
		// 	Value: []*armnetwork.ServiceEndpointPolicyDefinition{
		// 		{
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDef"),
		// 			Name: to.Ptr("testDef"),
		// 			Properties: &armnetwork.ServiceEndpointPolicyDefinitionPropertiesFormat{
		// 				Description: to.Ptr("Storage Service EndpointPolicy Definition"),
		// 				Service: to.Ptr("Microsoft.Storage"),
		// 				ServiceResources: []*string{
		// 					to.Ptr("/subscriptions/subid1"),
		// 					to.Ptr("/subscriptions/subid1/resourceGroups/storageRg"),
		// 					to.Ptr("/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount")},
		// 				},
		// 		}},
		// 	}
	}
}

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 service endpoint policy definitions in a service end point policy.
 *
 * @summary Gets all service endpoint policy definitions in a service end point policy.
 * x-ms-original-file: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ServiceEndpointPolicyDefinitionList.json
 */
async function listServiceEndpointDefinitionsInServiceEndPointPolicy() {
  const subscriptionId = process.env["NETWORK_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["NETWORK_RESOURCE_GROUP"] || "rg1";
  const serviceEndpointPolicyName = "testPolicy";
  const credential = new DefaultAzureCredential();
  const client = new NetworkManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.serviceEndpointPolicyDefinitions.listByResourceGroup(
    resourceGroupName,
    serviceEndpointPolicyName,
  )) {
    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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Network;

// Generated from example definition: specification/network/resource-manager/Microsoft.Network/stable/2023-09-01/examples/ServiceEndpointPolicyDefinitionList.json
// this example is just showing the usage of "ServiceEndpointPolicyDefinitions_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceEndpointPolicyResource created on azure
// for more information of creating ServiceEndpointPolicyResource, please refer to the document of ServiceEndpointPolicyResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceEndpointPolicyName = "testPolicy";
ResourceIdentifier serviceEndpointPolicyResourceId = ServiceEndpointPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceEndpointPolicyName);
ServiceEndpointPolicyResource serviceEndpointPolicy = client.GetServiceEndpointPolicyResource(serviceEndpointPolicyResourceId);

// get the collection of this ServiceEndpointPolicyDefinitionResource
ServiceEndpointPolicyDefinitionCollection collection = serviceEndpointPolicy.GetServiceEndpointPolicyDefinitions();

// invoke the operation and iterate over the result
await foreach (ServiceEndpointPolicyDefinitionResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ServiceEndpointPolicyDefinitionData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

Status code:: 200

{
  "value": [
    {
      "name": "testDef",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDef",
      "properties": {
        "description": "Storage Service EndpointPolicy Definition",
        "service": "Microsoft.Storage",
        "serviceResources": [
          "/subscriptions/subid1",
          "/subscriptions/subid1/resourceGroups/storageRg",
          "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount"
        ]
      }
    }
  ]
}

Definisi

Nama	Deskripsi
CloudError	Respons kesalahan dari layanan.
CloudErrorBody	Respons kesalahan dari layanan.
ProvisioningState	Status penyediaan saat ini.
ServiceEndpointPolicyDefinition	Definisi kebijakan Titik Akhir Layanan.
ServiceEndpointPolicyDefinitionListResult	Respons untuk panggilan layanan LISTServiceEndpointPolicyDefinition API. Mengambil semua definisi kebijakan titik akhir layanan yang termasuk dalam kebijakan titik akhir layanan.

CloudError

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Isi kesalahan cloud.

CloudErrorBody

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode tidak berubah dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

ProvisioningState

Status penyediaan saat ini.

Nama	Jenis	Deskripsi
Deleting	string
Failed	string
Succeeded	string
Updating	string