Named Value - Create Or Update
Vytvoří nebo aktualizuje pojmenovanou hodnotu.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}?api-version=2022-08-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
named
|
path | True |
string |
Identifikátor NamedValue. Vzor regulárního výrazu: |
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
service
|
path | True |
string |
Název služby API Management. Vzor regulárního výrazu: |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
If-Match |
string |
Značka ETag entity. Nevyžaduje se při vytváření entity, ale vyžaduje se při aktualizaci entity. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
properties.displayName | True |
string |
Jedinečný název NamedValue. Může obsahovat pouze písmena, číslice, tečky, pomlčky a podtržítka. |
properties.keyVault |
Podrobnosti o umístění pojmenované hodnoty služby KeyVault |
||
properties.secret |
boolean |
Určuje, jestli je hodnota tajný kód a měla by být zašifrovaná, nebo ne. Výchozí hodnota je false. |
|
properties.tags |
string[] |
Volitelné značky, které po zadání lze použít k filtrování seznamu NamedValue. |
|
properties.value |
string |
Hodnota NamedValue. Může obsahovat výrazy zásad. Nesmí být prázdný ani nesmí obsahovat pouze prázdné znaky. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Pojmenovaná hodnota byla úspěšně aktualizována. Hlavičky ETag: string |
|
201 Created |
Pojmenovaná hodnota byla úspěšně vytvořena. Hlavičky ETag: string |
|
202 Accepted |
Žádost o vytvoření nebo aktualizaci pojmenované hodnoty byla přijata. |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2.
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
Api |
Api |
ApiManagementCreateNamedValue
Ukázkový požadavek
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
}
}
Ukázková odpověď
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
Ukázkový požadavek
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
}
}
Ukázková odpověď
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
}
}
Definice
Name | Description |
---|---|
Error |
Chybový kontrakt pole. |
Error |
Odpověď na chybu. |
Key |
Vytvoření podrobností o smlouvě keyVault |
Key |
Podrobnosti o kontraktu služby KeyVault |
Key |
Aktualizace vlastností smlouvy o vydání. |
Named |
Podrobnosti o pojmenované hodnotě |
Named |
Podrobnosti o pojmenované hodnotě |
ErrorFieldContract
Chybový kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Pro člověka čitelná reprezentace chyby na úrovni vlastností. |
target |
string |
Název vlastnosti. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error.code |
string |
Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi. |
error.details |
Seznam neplatných polí se odešle v požadavku v případě chyby ověření. |
|
error.message |
string |
Pro člověka čitelná reprezentace chyby. |
KeyVaultContractCreateProperties
Vytvoření podrobností o smlouvě keyVault
Name | Typ | Description |
---|---|---|
identityClientId |
string |
Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. |
secretIdentifier |
string |
Identifikátor tajného kódu trezoru klíčů pro načtení tajného kódu. Poskytnutí tajného kódu s verzí zabrání automatické aktualizaci. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi |
KeyVaultContractProperties
Podrobnosti o kontraktu služby KeyVault
Name | Typ | Description |
---|---|---|
identityClientId |
string |
Hodnota Null pro SystemAssignedIdentity nebo ID klienta pro UserAssignedIdentity , která se použije pro přístup k tajnému kódu trezoru klíčů. |
lastStatus |
Čas poslední synchronizace a stav aktualizace tajného kódu z trezoru klíčů |
|
secretIdentifier |
string |
Identifikátor tajného kódu trezoru klíčů pro načtení tajného kódu. Poskytnutí tajného kódu s verzí zabrání automatické aktualizaci. To vyžaduje, aby služba API Management byla nakonfigurovaná s aka.ms/apimmsi |
KeyVaultLastAccessStatusContractProperties
Aktualizace vlastností smlouvy o vydání.
Name | Typ | Description |
---|---|---|
code |
string |
Poslední stavový kód pro synchronizaci a aktualizaci tajného kódu z trezoru klíčů. |
message |
string |
Podrobnosti o chybě jsou prázdné. |
timeStampUtc |
string |
Čas posledního přístupu k tajnému kódu Datum odpovídá následujícímu formátu: |
NamedValueContract
Podrobnosti o pojmenované hodnotě
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku} |
name |
string |
Název prostředku |
properties.displayName |
string |
Jedinečný název NamedValue. Může obsahovat pouze písmena, číslice, tečky, pomlčky a podtržítka. |
properties.keyVault |
Podrobnosti o umístění pojmenované hodnoty služby KeyVault |
|
properties.secret |
boolean |
Určuje, jestli je hodnota tajný kód a měla by být zašifrovaná, nebo ne. Výchozí hodnota je false. |
properties.tags |
string[] |
Volitelné značky, které po zadání lze použít k filtrování seznamu NamedValue. |
properties.value |
string |
Hodnota NamedValue. Může obsahovat výrazy zásad. Nesmí být prázdný ani nesmí obsahovat pouze prázdné znaky. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets. |
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
NamedValueCreateContract
Podrobnosti o pojmenované hodnotě
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku} |
name |
string |
Název prostředku |
properties.displayName |
string |
Jedinečný název NamedValue. Může obsahovat pouze písmena, číslice, tečky, pomlčky a podtržítka. |
properties.keyVault |
Podrobnosti o umístění pojmenované hodnoty služby KeyVault |
|
properties.secret |
boolean |
Určuje, jestli je hodnota tajný kód a měla by být zašifrovaná, nebo ne. Výchozí hodnota je false. |
properties.tags |
string[] |
Volitelné značky, které po zadání lze použít k filtrování seznamu NamedValue. |
properties.value |
string |
Hodnota NamedValue. Může obsahovat výrazy zásad. Nesmí být prázdný ani nesmí obsahovat pouze prázdné znaky. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets. |
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |