Named Value - Create Or Update

Cria ou atualiza o valor nomeado.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
namedValueId
path True

string

Identificador do NamedValue.

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

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName
path True

string

O nome do serviço Gerenciamento de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
If-Match

string

ETag da Entidade. Não é necessário ao criar uma entidade, mas necessário ao atualizar uma entidade.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.displayName True

string

Nome exclusivo de NamedValue. Ele pode conter apenas letras, dígitos, ponto, traço e caracteres de sublinhado.

properties.keyVault

KeyVaultContractCreateProperties

Detalhes de localização do KeyVault do chamadoValue.

properties.secret

boolean

Determina se o valor é um segredo e se deve ser criptografado ou não. O valor padrão é false.

properties.tags

string[]

Marcas opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue.

properties.value

string

Valor do NamedValue. Pode conter expressões de política. Ele não pode ficar vazio ou conter apenas espaços em branco. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.

Respostas

Nome Tipo Description
200 OK

NamedValueContract

O valor nomeado foi atualizado com êxito.

Headers

ETag: string

201 Created

NamedValueContract

O valor nomeado foi criado com êxito.

Headers

ETag: string

202 Accepted

A solicitação para criar ou atualizar o valor nomeado foi aceita.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementCreateNamedValue
ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

Sample Request

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

Sample Response

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

Sample Request

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

Sample Response

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

Definições

Nome Description
ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

KeyVaultContractCreateProperties

Crie detalhes do contrato keyVault.

KeyVaultContractProperties

Detalhes do contrato do KeyVault.

KeyVaultLastAccessStatusContractProperties

Emitir propriedades de atualização de contrato.

NamedValueContract

Detalhes de NamedValue.

NamedValueCreateContract

Detalhes de NamedValue.

ErrorFieldContract

Contrato de campo de erro.

Nome Tipo Description
code

string

Código de erro no nível da propriedade.

message

string

Representação legível por humanos do erro no nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error.code

string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.

error.message

string

Representação legível ao olho humano do erro.

KeyVaultContractCreateProperties

Crie detalhes do contrato keyVault.

Nome Tipo Description
identityClientId

string

Null para SystemAssignedIdentity ou ID do cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves.

secretIdentifier

string

Identificador de segredo do cofre de chaves para busca de segredo. Fornecer um segredo com versão impedirá a atualização automática. Isso requer que Gerenciamento de API serviço seja configurado com aka.ms/apimmsi

KeyVaultContractProperties

Detalhes do contrato do KeyVault.

Nome Tipo Description
identityClientId

string

Null para SystemAssignedIdentity ou ID do cliente para UserAssignedIdentity , que será usado para acessar o segredo do cofre de chaves.

lastStatus

KeyVaultLastAccessStatusContractProperties

Da última vez, sincronize e atualize status de segredo do cofre de chaves.

secretIdentifier

string

Identificador de segredo do cofre de chaves para busca de segredo. Fornecer um segredo com versão impedirá a atualização automática. Isso requer que Gerenciamento de API serviço seja configurado com aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Emitir propriedades de atualização de contrato.

Nome Tipo Description
code

string

O último status código para sincronização e atualização do segredo do cofre de chaves.

message

string

Detalhes do erro vazio.

timeStampUtc

string

A última vez que o segredo foi acessado. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

NamedValueContract

Detalhes de NamedValue.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.displayName

string

Nome exclusivo de NamedValue. Ele pode conter apenas letras, dígitos, ponto, traço e caracteres de sublinhado.

properties.keyVault

KeyVaultContractProperties

Detalhes de localização do KeyVault do chamadoValue.

properties.secret

boolean

Determina se o valor é um segredo e se deve ser criptografado ou não. O valor padrão é false.

properties.tags

string[]

Marcas opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue.

properties.value

string

Valor do NamedValue. Pode conter expressões de política. Ele não pode ficar vazio ou conter apenas espaços em branco. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

NamedValueCreateContract

Detalhes de NamedValue.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.displayName

string

Nome exclusivo de NamedValue. Ele pode conter apenas letras, dígitos, ponto, traço e caracteres de sublinhado.

properties.keyVault

KeyVaultContractCreateProperties

Detalhes de localização do KeyVault do chamadoValue.

properties.secret

boolean

Determina se o valor é um segredo e se deve ser criptografado ou não. O valor padrão é false.

properties.tags

string[]

Marcas opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue.

properties.value

string

Valor do NamedValue. Pode conter expressões de política. Ele não pode ficar vazio ou conter apenas espaços em branco. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"