Named Value - Create Or Update
Adlı değeri oluşturur veya güncelleştirir.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}?api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
named
|
path | True |
string |
NamedValue tanımlayıcısı. Normal ifade deseni: |
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Normal ifade deseni: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
If-Match |
string |
Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
properties.displayName | True |
string |
NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. |
properties.keyVault |
AdlıDeğer'in KeyVault konum ayrıntıları. |
||
properties.secret |
boolean |
Değerin gizli dizi olup olmadığını ve şifrelenip şifrelenmemesi gerektiğini belirler. Varsayılan değer false'tur. |
|
properties.tags |
string[] |
Sağlandığında NamedValue listesini filtrelemek için kullanılabilen isteğe bağlı etiketler. |
|
properties.value |
string |
NamedValue değeri. İlke ifadeleri içerebilir. Boş olmayabilir veya yalnızca boşluklardan oluşamayabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Adlandırılmış değer başarıyla güncelleştirildi. Üst Bilgiler ETag: string |
|
201 Created |
Adlandırılmış değer başarıyla oluşturuldu. Üst Bilgiler ETag: string |
|
202 Accepted |
Adlandırılmış değer oluşturma veya güncelleştirme isteği kabul edildi. |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
Api |
Api |
ApiManagementCreateNamedValue
Örnek isteği
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2022-08-01
{
"properties": {
"displayName": "prop3name",
"value": "propValue",
"tags": [
"foo",
"bar"
],
"secret": false
}
}
Örnek yanıt
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=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
}
}
{
"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
Örnek isteği
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2022-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
}
}
Örnek yanıt
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=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
}
}
{
"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
}
}
Tanımlar
Name | Description |
---|---|
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Key |
keyVault sözleşme ayrıntılarını oluşturun. |
Key |
KeyVault sözleşme ayrıntıları. |
Key |
Sözleşme Güncelleştirme Özellikleri'ni yayımlar. |
Named |
NamedValue ayrıntıları. |
Named |
NamedValue ayrıntıları. |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilir gösterimi. |
KeyVaultContractCreateProperties
keyVault sözleşme ayrıntılarını oluşturun.
Name | Tür | Description |
---|---|---|
identityClientId |
string |
Anahtar kasası gizli dizisine erişmek için kullanılacak Olan SystemAssignedIdentity için Null veya UserAssignedIdentity İstemci Kimliği. |
secretIdentifier |
string |
Gizli diziyi getirmek için anahtar kasası gizli dizi tanımlayıcısı. Sürümlü gizli dizi sağlamak otomatik yenilemeyi engeller. Bunun için API Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir |
KeyVaultContractProperties
KeyVault sözleşme ayrıntıları.
Name | Tür | Description |
---|---|---|
identityClientId |
string |
Anahtar kasası gizli dizisine erişmek için kullanılacak Olan SystemAssignedIdentity için Null veya UserAssignedIdentity İstemci Kimliği. |
lastStatus |
Anahtar kasasından gizli diziyi son kez eşitleme ve yenileme durumu. |
|
secretIdentifier |
string |
Gizli diziyi getirmek için anahtar kasası gizli dizi tanımlayıcısı. Sürümlü gizli dizi sağlamak otomatik yenilemeyi engeller. Bunun için API Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir |
KeyVaultLastAccessStatusContractProperties
Sözleşme Güncelleştirme Özellikleri'ni yayımlar.
Name | Tür | Description |
---|---|---|
code |
string |
Anahtar kasasından gizli dizi eşitleme ve yenileme için son durum kodu. |
message |
string |
Hatanın ayrıntıları yoksa boş. |
timeStampUtc |
string |
Gizli diziye son erişildiğinde. Tarih şu biçime uygundur: |
NamedValueContract
NamedValue ayrıntıları.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Kaynağın adı |
properties.displayName |
string |
NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. |
properties.keyVault |
AdlıDeğer'in KeyVault konum ayrıntıları. |
|
properties.secret |
boolean |
Değerin gizli dizi olup olmadığını ve şifrelenip şifrelenmemesi gerektiğini belirler. Varsayılan değer false'tur. |
properties.tags |
string[] |
Sağlandığında NamedValue listesini filtrelemek için kullanılabilen isteğe bağlı etiketler. |
properties.value |
string |
NamedValue değeri. İlke ifadeleri içerebilir. Boş olmayabilir veya yalnızca boşluklardan oluşamayabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. |
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
NamedValueCreateContract
NamedValue ayrıntıları.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Kaynağın adı |
properties.displayName |
string |
NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. |
properties.keyVault |
AdlıDeğer'in KeyVault konum ayrıntıları. |
|
properties.secret |
boolean |
Değerin gizli dizi olup olmadığını ve şifrelenip şifrelenmemesi gerektiğini belirler. Varsayılan değer false'tur. |
properties.tags |
string[] |
Sağlandığında NamedValue listesini filtrelemek için kullanılabilen isteğe bağlı etiketler. |
properties.value |
string |
NamedValue değeri. İlke ifadeleri içerebilir. Boş olmayabilir veya yalnızca boşluklardan oluşamayabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. |
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |