Named Value - Create Or Update

Referensi

Service:: API Management

API Version:: 2021-08-01

Membuat atau memperbarui nilai bernama.

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

Parameter URI

Name	In	Required	Type	Description
namedValueId	path	True	string	Pengidentifikasi NamedValue. Regex pattern: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	Nama grup sumber daya.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
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 yang akan digunakan dengan permintaan klien.

Header Permintaan

Name	Required	Type	Description
If-Match		string	ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Name	Required	Type	Description
properties.displayName	True	string	Nama unik NamedValue. Ini hanya boleh berisi huruf, digit, titik, tanda hubung, dan karakter garis bawah.
properties.keyVault		KeyVaultContractCreateProperties	Detail lokasi KeyVault dari namedValue.
properties.secret		boolean	Menentukan apakah nilainya adalah rahasia dan harus dienkripsi atau tidak. Nilai defaultnya adalah salah.
properties.tags		string[]	Tag opsional yang saat disediakan dapat digunakan untuk memfilter daftar NamedValue.
properties.value		string	Nilai NamedValue. Dapat berisi ekspresi kebijakan. Ini mungkin tidak kosong atau hanya terdiri dari spasi kosong. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.

Respons

Name	Type	Description
200 OK	NamedValueContract	Nilai bernama berhasil diperbarui. Headers ETag: string
201 Created	NamedValueContract	Nilai bernama berhasil dibuat. Headers ETag: string
202 Accepted		Permintaan untuk membuat atau memperbarui nilai bernama diterima.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementCreateNamedValue

ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

Sample Request

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

{
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false
  }
}

import java.util.Arrays;

/** Samples for NamedValue CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateNamedValue.json
     */
    /**
     * Sample code: ApiManagementCreateNamedValue.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateNamedValue(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .namedValues()
            .define("testprop2")
            .withExistingService("rg1", "apimService1")
            .withTags(Arrays.asList("foo", "bar"))
            .withDisplayName("prop3name")
            .withValue("propValue")
            .withSecret(false)
            .create();
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/tree/main/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateNamedValue.json
func ExampleNamedValueClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armapimanagement.NewNamedValueClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"apimService1",
		"testprop2",
		armapimanagement.NamedValueCreateContract{
			Properties: &armapimanagement.NamedValueCreateContractProperties{
				Secret: to.Ptr(false),
				Tags: []*string{
					to.Ptr("foo"),
					to.Ptr("bar")},
				DisplayName: to.Ptr("prop3name"),
				Value:       to.Ptr("propValue"),
			},
		},
		&armapimanagement.NamedValueClientBeginCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2021-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop2",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false
  }
}

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop2",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false
  }
}

ApiManagementCreateNamedValueWithKeyVault

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

{
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret"
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

import com.azure.resourcemanager.apimanagement.models.KeyVaultContractCreateProperties;
import java.util.Arrays;

/** Samples for NamedValue CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateNamedValueWithKeyVault.json
     */
    /**
     * Sample code: ApiManagementCreateNamedValueWithKeyVault.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateNamedValueWithKeyVault(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .namedValues()
            .define("testprop6")
            .withExistingService("rg1", "apimService1")
            .withTags(Arrays.asList("foo", "bar"))
            .withDisplayName("prop6namekv")
            .withKeyVault(
                new KeyVaultContractCreateProperties()
                    .withSecretIdentifier("https://contoso.vault.azure.net/secrets/aadSecret")
                    .withIdentityClientId("ceaa6b06-c00f-43ef-99ac-f53d1fe876a0"))
            .withSecret(true)
            .create();
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 202

location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2021-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201

Status code:: 201

{
  "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": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Status code:: 200

{
  "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": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

Definisi

ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
KeyVaultContractCreateProperties	Buat detail kontrak keyVault.
KeyVaultContractProperties	Detail kontrak KeyVault.
KeyVaultLastAccessStatusContractProperties	Menerbitkan Properti Pembaruan kontrak.
NamedValueContract	Detail NamedValue.
NamedValueCreateContract	Detail NamedValue.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name	Type	Description
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Name	Type	Description
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

KeyVaultContractCreateProperties

Buat detail kontrak keyVault.

Name	Type	Description
identityClientId	string	Null untuk SystemAssignedIdentity atau Id Klien untuk UserAssignedIdentity , yang akan digunakan untuk mengakses rahasia brankas kunci.
secretIdentifier	string	Pengidentifikasi rahasia brankas kunci untuk mengambil rahasia. Memberikan rahasia versi akan mencegah refresh otomatis. Ini mengharuskan layanan API Management dikonfigurasi dengan aka.ms/apimmsi

KeyVaultContractProperties

Detail kontrak KeyVault.

Name	Type	Description
identityClientId	string	Null untuk SystemAssignedIdentity atau Id Klien untuk UserAssignedIdentity , yang akan digunakan untuk mengakses rahasia brankas kunci.
lastStatus	KeyVaultLastAccessStatusContractProperties	Terakhir kali menyinkronkan dan menyegarkan status rahasia dari brankas kunci.
secretIdentifier	string	Pengidentifikasi rahasia brankas kunci untuk mengambil rahasia. Memberikan rahasia versi akan mencegah refresh otomatis. Ini mengharuskan layanan API Management dikonfigurasi dengan aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Menerbitkan Properti Pembaruan kontrak.

Name	Type	Description
code	string	Kode status terakhir untuk sinkronisasi dan refresh rahasia dari brankas kunci.
message	string	Detail kesalahan lainnya kosong.
timeStampUtc	string	Terakhir kali rahasia diakses. Tanggal sesuai dengan format berikut: `yyyy-MM-ddTHH:mm:ssZ` seperti yang ditentukan oleh standar ISO 8601.

NamedValueContract

Detail NamedValue.

Name	Type	Description
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.displayName	string	Nama unik NamedValue. Ini hanya boleh berisi huruf, digit, titik, tanda hubung, dan karakter garis bawah.
properties.keyVault	KeyVaultContractProperties	Detail lokasi KeyVault dari namedValue.
properties.secret	boolean	Menentukan apakah nilainya adalah rahasia dan harus dienkripsi atau tidak. Nilai defaultnya adalah salah.
properties.tags	string[]	Tag opsional yang saat disediakan dapat digunakan untuk memfilter daftar NamedValue.
properties.value	string	Nilai NamedValue. Dapat berisi ekspresi kebijakan. Ini mungkin tidak kosong atau hanya terdiri dari spasi kosong. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

NamedValueCreateContract

Detail NamedValue.

Name	Type	Description
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.displayName	string	Nama unik NamedValue. Ini hanya boleh berisi huruf, digit, titik, tanda hubung, dan karakter garis bawah.
properties.keyVault	KeyVaultContractCreateProperties	Detail lokasi KeyVault dari namedValue.
properties.secret	boolean	Menentukan apakah nilainya adalah rahasia dan harus dienkripsi atau tidak. Nilai defaultnya adalah salah.
properties.tags	string[]	Tag opsional yang saat disediakan dapat digunakan untuk memfilter daftar NamedValue.
properties.value	string	Nilai NamedValue. Dapat berisi ekspresi kebijakan. Ini mungkin tidak kosong atau hanya terdiri dari spasi kosong. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"