Named Value - Create Or Update

Referentie

Service:: API Management

API-versie:: 2024-05-01

Hiermee maakt of werkt u de benoemde waarde bij.

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

URI-parameters

Name	In	Vereist	Type	Description
namedValueId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Id van de NamedValue.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

Aanvraagbody

Name	Vereist	Type	Description
properties.displayName	True	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Unieke naam van NamedValue. Het mag alleen letters, cijfers, punten, streepjes en onderstrepingstekens bevatten.
properties.keyVault		KeyVaultContractCreateProperties	KeyVault-locatiedetails van de namedValue.
properties.secret		boolean	Bepaalt of de waarde een geheim is en of niet moet worden versleuteld. De standaardwaarde is onwaar.
properties.tags		string[]	Optionele tags die kunnen worden gebruikt om de lijst NamedValue te filteren.
properties.value		string maxLength: 4096	Waarde van de NamedValue. Kan beleidsexpressies bevatten. Deze mag niet leeg zijn of bestaan alleen uit witruimte. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.

Antwoorden

Name	Type	Description
200 OK	NamedValueContract	De benoemde waarde is bijgewerkt. Kopteksten ETag: string location: string Azure-AsyncOperation: string
201 Created	NamedValueContract	De benoemde waarde is gemaakt. Kopteksten ETag: string location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

NamedValueContract

De benoemde waarde is bijgewerkt.

Kopteksten

ETag: string
location: string
Azure-AsyncOperation: string

201 Created

NamedValueContract

De benoemde waarde is gemaakt.

Kopteksten

ETag: string
location: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateNamedValue

ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Statuscode:: 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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

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

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
KeyVaultContractCreateProperties	Maak keyVault-contractgegevens.
KeyVaultContractProperties	KeyVault-contractgegevens.
KeyVaultLastAccessStatusContractProperties	Probleem met update-eigenschappen van contract.
NamedValueContract	Details van NamedValue.
NamedValueCreateContract	Details van NamedValue.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

KeyVaultContractCreateProperties

Object

Maak keyVault-contractgegevens.

Name	Type	Description
identityClientId	string	Null voor SystemAssignedIdentity of client-id voor UserAssignedIdentity, die wordt gebruikt voor toegang tot sleutelkluisgeheim.
secretIdentifier	string	Sleutelkluisgeheim-id voor het ophalen van een geheim. Als u een versiegeheim oplevert, wordt automatisch vernieuwen voorkomen. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi

KeyVaultContractProperties

Object

KeyVault-contractgegevens.

Name	Type	Description
identityClientId	string	Null voor SystemAssignedIdentity of client-id voor UserAssignedIdentity, die wordt gebruikt voor toegang tot sleutelkluisgeheim.
lastStatus	KeyVaultLastAccessStatusContractProperties	Laatste keer synchroniseren en de status van geheim vernieuwen vanuit de sleutelkluis.
secretIdentifier	string	Sleutelkluisgeheim-id voor het ophalen van een geheim. Als u een versiegeheim oplevert, wordt automatisch vernieuwen voorkomen. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Object

Probleem met update-eigenschappen van contract.

Name	Type	Description
code	string	Laatste statuscode voor synchronisatie en vernieuwing van geheim uit sleutelkluis.
message	string	Details van de fout leeg.
timeStampUtc	string (date-time)	Laatste keer dat het geheim werd geopend. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.

NamedValueContract

Object

Details van NamedValue.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Unieke naam van NamedValue. Het mag alleen letters, cijfers, punten, streepjes en onderstrepingstekens bevatten.
properties.keyVault	KeyVaultContractProperties	KeyVault-locatiedetails van de namedValue.
properties.provisioningState	string	De inrichtingsstatus
properties.secret	boolean	Bepaalt of de waarde een geheim is en of niet moet worden versleuteld. De standaardwaarde is onwaar.
properties.tags	string[]	Optionele tags die kunnen worden gebruikt om de lijst NamedValue te filteren.
properties.value	string maxLength: 4096	Waarde van de NamedValue. Kan beleidsexpressies bevatten. Deze mag niet leeg zijn of bestaan alleen uit witruimte. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

NamedValueCreateContract

Object

Details van NamedValue.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Unieke naam van NamedValue. Het mag alleen letters, cijfers, punten, streepjes en onderstrepingstekens bevatten.
properties.keyVault	KeyVaultContractCreateProperties	KeyVault-locatiedetails van de namedValue.
properties.secret	boolean	Bepaalt of de waarde een geheim is en of niet moet worden versleuteld. De standaardwaarde is onwaar.
properties.tags	string[]	Optionele tags die kunnen worden gebruikt om de lijst NamedValue te filteren.
properties.value	string maxLength: 4096	Waarde van de NamedValue. Kan beleidsexpressies bevatten. Deze mag niet leeg zijn of bestaan alleen uit witruimte. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

Delen via

Named Value - Create Or Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementCreateNamedValue

Voorbeeldaanvraag

Voorbeeldrespons

ApiManagementCreateNamedValueWithKeyVault

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractCreateProperties

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

NamedValueContract

NamedValueCreateContract

Aanvullende resources