Named Value - List By Service

Reference

Service:: API Management

API Version:: 2021-08-01

Lists a collection of named values defined within a service instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues?api-version=2021-08-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues?$filter={$filter}&$top={$top}&$skip={$skip}&isKeyVaultRefreshFailed={isKeyVaultRefreshFailed}&api-version=2021-08-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Version of the API to be used with the client request.
$filter	query		string	\| Field \| Usage \| Supported operators \| Supported functions \| \|-------------\|-------------\|-------------\|-------------\| \| tags \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith, any, all \| \| displayName \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.
isKeyVaultRefreshFailed	query		boolean	When set to true, the response contains only named value entities which failed refresh.

Responses

Name	Type	Description
200 OK	NamedValueCollection	A Collection of the named value entities for the specified API Management service instance.
Other Status Codes	ErrorResponse	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

ApiManagementListNamedValues

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues?api-version=2021-08-01

import com.azure.core.util.Context;

/** Samples for NamedValue ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNamedValues.json
     */
    /**
     * Sample code: ApiManagementListNamedValues.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListNamedValues(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.namedValues().listByService("rg1", "apimService1", null, null, null, null, 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.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_named_values.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 = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.named_value.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNamedValues.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 armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNamedValues.json
func ExampleNamedValueClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewNamedValueClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.NamedValueClientListByServiceOptions{Filter: nil,
		Top:                     nil,
		Skip:                    nil,
		IsKeyVaultRefreshFailed: 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.NamedValueCollection = armapimanagement.NamedValueCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.NamedValueContract{
		// 		{
		// 			Name: to.Ptr("592f1174cc83890dc4f32686"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/namedValues"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686"),
		// 			Properties: &armapimanagement.NamedValueContractProperties{
		// 				Secret: to.Ptr(false),
		// 				DisplayName: to.Ptr("Logger-Credentials-592f1174cc83890dc4f32687"),
		// 				Value: to.Ptr("propValue"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("testprop6"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/namedValues"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6"),
		// 			Properties: &armapimanagement.NamedValueContractProperties{
		// 				Secret: to.Ptr(true),
		// 				Tags: []*string{
		// 					to.Ptr("foo"),
		// 					to.Ptr("bar")},
		// 					DisplayName: to.Ptr("prop6namekv"),
		// 					KeyVault: &armapimanagement.KeyVaultContractProperties{
		// 						IdentityClientID: to.Ptr("2d2df842-44d8-4885-8dec-77cc1a984a31"),
		// 						SecretIdentifier: to.Ptr("https://contoso.vault.azure.net/secrets/aadSecret"),
		// 						LastStatus: &armapimanagement.KeyVaultLastAccessStatusContractProperties{
		// 							Code: to.Ptr("Success"),
		// 							TimeStampUTC: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-11T00:54:31.8024882Z"); return t}()),
		// 						},
		// 					},
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists a collection of named values defined within a service instance.
 *
 * @summary Lists a collection of named values defined within a service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNamedValues.json
 */
async function apiManagementListNamedValues() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.namedValue.listByService(resourceGroupName, serviceName)) {
    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.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListNamedValues.json
// this example is just showing the usage of "NamedValue_ListByService" 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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementNamedValueResource
ApiManagementNamedValueCollection collection = apiManagementService.GetApiManagementNamedValues();

// invoke the operation and iterate over the result
await foreach (ApiManagementNamedValueResource 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
    ApiManagementNamedValueData 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": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686",
      "type": "Microsoft.ApiManagement/service/namedValues",
      "name": "592f1174cc83890dc4f32686",
      "properties": {
        "displayName": "Logger-Credentials-592f1174cc83890dc4f32687",
        "value": "propValue",
        "secret": false
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6",
      "type": "Microsoft.ApiManagement/service/namedValues",
      "name": "testprop6",
      "properties": {
        "displayName": "prop6namekv",
        "keyVault": {
          "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret",
          "identityClientId": "2d2df842-44d8-4885-8dec-77cc1a984a31",
          "lastStatus": {
            "code": "Success",
            "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
          }
        },
        "tags": [
          "foo",
          "bar"
        ],
        "secret": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitions

Name	Description
ErrorFieldContract	Error Field contract.
ErrorResponse	Error Response.
KeyVaultContractProperties	KeyVault contract details.
KeyVaultLastAccessStatusContractProperties	Issue contract Update Properties.
NamedValueCollection	Paged NamedValue list representation.
NamedValueContract	NamedValue details.

ErrorFieldContract

Error Field contract.

Name	Type	Description
code	string	Property level error code.
message	string	Human-readable representation of property-level error.
target	string	Property name.

ErrorResponse

Error Response.

Name	Type	Description
error.code	string	Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
error.details	ErrorFieldContract[]	The list of invalid fields send in request, in case of validation error.
error.message	string	Human-readable representation of the error.

KeyVaultContractProperties

KeyVault contract details.

Name	Type	Description
identityClientId	string	Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
lastStatus	KeyVaultLastAccessStatusContractProperties	Last time sync and refresh status of secret from key vault.
secretIdentifier	string	Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Issue contract Update Properties.

Name	Type	Description
code	string	Last status code for sync and refresh of secret from key vault.
message	string	Details of the error else empty.
timeStampUtc	string	Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.

NamedValueCollection

Paged NamedValue list representation.

Name	Type	Description
count	integer	Total record count number across all pages.
nextLink	string	Next page link if any.
value	NamedValueContract[]	Page values.

NamedValueContract

NamedValue details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.displayName	string	Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
properties.keyVault	KeyVaultContractProperties	KeyVault location details of the namedValue.
properties.secret	boolean	Determines whether the value is a secret and should be encrypted or not. Default value is false.
properties.tags	string[]	Optional tags that when provided can be used to filter the NamedValue list.
properties.value	string	Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"