Named Value - List By Service

サービス:

API Management

API バージョン:

2021-08-01

サービス インスタンス内で定義されている名前付きの値のコレクションを一覧表示します。

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

省略可能なパラメーターを含む:

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 パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。
serviceName	path	True	string	API Management サービスの名前。 正規表現パターン: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント要求で使用される API のバージョン。
$filter	query		string	|フィールド |使用法 |サポートされている演算子 |サポートされている関数 | |-------------|-------------|-------------|-------------| |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	スキップするレコードの数。
$top	query		integer int32	返されるレコードの数。
isKeyVaultRefreshFailed	query		boolean	true に設定すると、応答には、更新に失敗した名前付き値エンティティのみが含まれます。

応答

名前	型	説明
200 OK	NamedValueCollection	指定したAPI Management サービス インスタンスの名前付き値エンティティのコレクション。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

ApiManagementListNamedValues

要求のサンプル

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

dotnet

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

応答のサンプル

状態コード:

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": ""
}

定義

名前	説明
ErrorFieldContract	エラー フィールド コントラクト。
ErrorResponse	エラー応答。
KeyVaultContractProperties	KeyVault コントラクトの詳細。
KeyVaultLastAccessStatusContractProperties	コントラクトの更新プロパティを発行します。
NamedValueCollection	Paged NamedValue リスト表現。
NamedValueContract	NamedValue の詳細。

ErrorFieldContract

エラー フィールド コントラクト。

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

KeyVaultContractProperties

KeyVault コントラクトの詳細。

名前	型	説明
identityClientId	string	SystemAssignedIdentity の場合は Null、UserAssignedIdentity の場合はクライアント ID で、キー コンテナーシークレットへのアクセスに使用されます。
lastStatus	KeyVaultLastAccessStatusContractProperties	キー コンテナーからのシークレットの前回の同期と更新の状態。
secretIdentifier	string	シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新が防止されます。 これには、API Management サービスを aka.ms/apimmsi で構成する必要があります

KeyVaultLastAccessStatusContractProperties

コントラクトの更新プロパティを発行します。

名前	型	説明
code	string	キー コンテナーからのシークレットの同期と更新の最後の状態コード。
message	string	エラーの詳細は空です。
timeStampUtc	string	前回シークレットにアクセスしました。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。

NamedValueCollection

Paged NamedValue リスト表現。

名前	型	説明
count	integer	すべてのページの合計レコード数。
nextLink	string	次のページリンク (存在する場合)。
value	NamedValueContract[]	ページ値。

NamedValueContract

NamedValue の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.displayName	string	NamedValue の一意の名前。 文字、数字、ピリオド、ダッシュ、下線のみを使用できます。
properties.keyVault	KeyVaultContractProperties	namedValue の KeyVault の場所の詳細。
properties.secret	boolean	値がシークレットかどうかと暗号化する必要があるかどうかを決定します。 既定値は false です。
properties.tags	string[]	指定した場合に NamedValue リストをフィルター処理するために使用できる省略可能なタグ。
properties.value	string	NamedValue の値。 ポリシー式を含めることができます。 空にすることはできません。スペースのみで構成することはできません。 このプロパティは、'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"