Dela via

Named Value - Create Or Update

  • Referens
Tjänst:
API Management
API-version:
2024-05-01

Skapar eller uppdaterar namngivet värde.

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

URI-parametrar

Name I Obligatorisk Typ Description
namedValueId
 path True

string

maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identifierare för NamedValue.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Namnet på API Management-tjänsten.
subscriptionId
 path True

string (uuid)

ID för målprenumerationen. Värdet måste vara ett UUID.
api-version
 query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet.

Begärandetext

Name Obligatorisk Typ Description
properties.displayName True

string

minLength: 1
maxLength: 256
pattern: ^[A-Za-z0-9-._]+$

Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck.
properties.keyVault

KeyVaultContractCreateProperties

KeyVault-platsinformation för namedValue.
properties.secret

boolean

Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt.
properties.tags

string[]

Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue.
properties.value

string

maxLength: 4096

Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.

Svar

Name Typ Description
200 OK

NamedValueContract

Det namngivna värdet har uppdaterats.

Sidhuvuden

  • ETag: string
  • location: string
  • Azure-AsyncOperation: string
201 Created

NamedValueContract

Det namngivna värdet har skapats.

Sidhuvuden

  • ETag: string
  • location: string
  • Azure-AsyncOperation: string
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementCreateNamedValue
ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

Exempelbegäran

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01

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

Exempelsvar

Statuskod:
201 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
    "provisioningState": "InProgress"
  }
}
Statuskod:
200 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
    "provisioningState": "InProgress"
  }
}

ApiManagementCreateNamedValueWithKeyVault

Exempelbegäran

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-05-01

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

Exempelsvar

Statuskod:
201 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
    "provisioningState": "InProgress"
  }
}
Statuskod:
200 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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,
    "provisioningState": "InProgress"
  }
}

Definitioner

Name Description
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
KeyVaultContractCreateProperties

Skapa keyVault-kontraktsinformation.
KeyVaultContractProperties

KeyVault-kontraktsinformation.
KeyVaultLastAccessStatusContractProperties

Utfärda kontraktuppdateringsegenskaper.
NamedValueContract

NamedValue-information.
NamedValueCreateContract

NamedValue-information.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

KeyVaultContractCreateProperties

Objekt

Skapa keyVault-kontraktsinformation.

Name Typ Description
identityClientId

string

Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet.
secretIdentifier

string

Nyckelvalvshemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi

KeyVaultContractProperties

Objekt

KeyVault-kontraktsinformation.

Name Typ Description
identityClientId

string

Null för SystemAssignedIdentity eller klient-ID för UserAssignedIdentity , som kommer att användas för att komma åt nyckelvalvshemlighet.
lastStatus

KeyVaultLastAccessStatusContractProperties

Senaste tidssynkronisering och uppdateringsstatus för hemligheten från nyckelvalvet.
secretIdentifier

string

Nyckelvalvshemlighetsidentifierare för hämtning av hemlighet. Om du anger en versionshemlighet förhindrar du automatisk uppdatering. Detta kräver att API Management-tjänsten konfigureras med aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Objekt

Utfärda kontraktuppdateringsegenskaper.

Name Typ Description
code

string

Senaste statuskod för synkronisering och uppdatering av hemlighet från nyckelvalv.
message

string

Information om felet är tomt.
timeStampUtc

string (date-time)

Senaste gången hemligheten användes. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt ISO 8601-standarden.

NamedValueContract

Objekt

NamedValue-information.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Namnet på resursen
properties.displayName

string

minLength: 1
maxLength: 256
pattern: ^[A-Za-z0-9-._]+$

Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck.
properties.keyVault

KeyVaultContractProperties

KeyVault-platsinformation för namedValue.
properties.provisioningState

string

Etableringstillståndet
properties.secret

boolean

Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt.
properties.tags

string[]

Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue.
properties.value

string

maxLength: 4096

Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

NamedValueCreateContract

Objekt

NamedValue-information.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Namnet på resursen
properties.displayName

string

minLength: 1
maxLength: 256
pattern: ^[A-Za-z0-9-._]+$

Unikt namn på NamedValue. Den får endast innehålla bokstäver, siffror, punkttecken, bindestreck och understreck.
properties.keyVault

KeyVaultContractCreateProperties

KeyVault-platsinformation för namedValue.
properties.secret

boolean

Avgör om värdet är en hemlighet och ska krypteras eller inte. Standardvärdet är falskt.
properties.tags

string[]

Valfria taggar som när de tillhandahålls kan användas för att filtrera listan NamedValue.
properties.value

string

maxLength: 4096

Värdet för NamedValue. Kan innehålla principuttryck. Den kanske inte är tom eller bara består av blanksteg. Den här egenskapen fylls inte i för GET-åtgärder! Använd POST-begäran för "/listSecrets" för att hämta värdet.
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"