Partilhar via


Named Value - Create Or Update

Cria ou atualiza o valor com nome.

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

Parâmetros do URI

Name Em Necessário Tipo Description
namedValueId
path True

string

Identificador do NamedValue.

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

resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

serviceName
path True

string

O nome do serviço Gestão de API.

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

subscriptionId
path True

string

O ID da subscrição de destino.

api-version
query True

string

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

Cabeçalho do Pedido

Name Necessá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 do Pedido

Name Necessário Tipo Description
properties.displayName True

string

Nome exclusivo de NamedValue. Pode conter apenas letras, dígitos, ponto final, travessão e carateres de sublinhado.

properties.keyVault

KeyVaultContractCreateProperties

Detalhes da localização do KeyVault com o nomeValue.

properties.secret

boolean

Determina se o valor é um segredo e deve ser encriptado ou não. O valor predefinido é falso.

properties.tags

string[]

Etiquetas opcionais que, quando fornecidas, podem ser utilizadas para filtrar a lista NamedValue.

properties.value

string

Valor de NamedValue. Pode conter expressões de política. Pode não estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.

Respostas

Name Tipo Description
200 OK

NamedValueContract

O valor com nome foi atualizado com êxito.

Headers

ETag: string

201 Created

NamedValueContract

O valor com nome foi criado com êxito.

Headers

ETag: string

202 Accepted

O pedido para criar ou atualizar o valor com nome foi aceite.

Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual 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

Name Description
user_impersonation representar a sua conta de utilizador

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

Name Description
ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta do Erro.

KeyVaultContractCreateProperties

Crie detalhes do contrato keyVault.

KeyVaultContractProperties

Detalhes do contrato do KeyVault.

KeyVaultLastAccessStatusContractProperties

Emitir Propriedades de Atualização do contrato.

NamedValueContract

Detalhes de NamedValue.

NamedValueCreateContract

Detalhes de NamedValue.

ErrorFieldContract

Contrato de Campo de Erro.

Name Tipo Description
code

string

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

message

string

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

target

string

Nome da propriedade.

ErrorResponse

Resposta do Erro.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

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

error.message

string

Representação legível por humanos do erro.

KeyVaultContractCreateProperties

Crie detalhes do contrato keyVault.

Name Tipo Description
identityClientId

string

Null para SystemAssignedIdentity ou ID de Cliente para UserAssignedIdentity , que será utilizado para aceder ao segredo do cofre de chaves.

secretIdentifier

string

Identificador do segredo do cofre de chaves para obter o segredo. Fornecer um segredo com versões impedirá a atualização automática. Isto requer que Gestão de API serviço seja configurado com aka.ms/apimmsi

KeyVaultContractProperties

Detalhes do contrato do KeyVault.

Name Tipo Description
identityClientId

string

Null para SystemAssignedIdentity ou ID de Cliente para UserAssignedIdentity , que será utilizado para aceder ao segredo do cofre de chaves.

lastStatus

KeyVaultLastAccessStatusContractProperties

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

secretIdentifier

string

Identificador do segredo do cofre de chaves para obter o segredo. Fornecer um segredo com versões impedirá a atualização automática. Isto requer que Gestão de API serviço seja configurado com aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Emitir Propriedades de Atualização do contrato.

Name Tipo Description
code

string

Último código de estado para sincronização e atualização do segredo do cofre de chaves.

message

string

Os detalhes do erro estão vazios.

timeStampUtc

string

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

NamedValueContract

Detalhes de NamedValue.

Name Tipo Description
id

string

ID de recurso completamente qualificado 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. Pode conter apenas letras, dígitos, ponto final, travessão e carateres de sublinhado.

properties.keyVault

KeyVaultContractProperties

Detalhes da localização do KeyVault com o nomeValue.

properties.secret

boolean

Determina se o valor é um segredo e deve ser encriptado ou não. O valor predefinido é falso.

properties.tags

string[]

Etiquetas opcionais que, quando fornecidas, podem ser utilizadas para filtrar a lista NamedValue.

properties.value

string

Valor de NamedValue. Pode conter expressões de política. Pode não estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.

type

string

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

NamedValueCreateContract

Detalhes de NamedValue.

Name Tipo Description
id

string

ID de recurso completamente qualificado 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. Pode conter apenas letras, dígitos, ponto final, travessão e carateres de sublinhado.

properties.keyVault

KeyVaultContractCreateProperties

Detalhes da localização do KeyVault com o nomeValue.

properties.secret

boolean

Determina se o valor é um segredo e deve ser encriptado ou não. O valor predefinido é falso.

properties.tags

string[]

Etiquetas opcionais que, quando fornecidas, podem ser utilizadas para filtrar a lista NamedValue.

properties.value

string

Valor de NamedValue. Pode conter expressões de política. Pode não estar vazio ou consistir apenas em espaço em branco. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.

type

string

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