Named Value - List By Service

Referência

Serviço:: API Management

Versão da API:: 2024-05-01

Lista uma coleção de valores nomeados definidos em uma instância de serviço.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues?$filter={$filter}&$top={$top}&$skip={$skip}&isKeyVaultRefreshFailed={isKeyVaultRefreshFailed}&api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$filter	query		string	\| Campo \| Uso \| Operadores com suporte \| Funções com suporte \| \|-------------\|-------------\|-------------\|-------------\| \| marcas \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith, any, all \| \| displayName \| filtro \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer (int32) minimum: 0	Número de registros a serem ignoradas.
$top	query		integer (int32) minimum: 1	Número de registros a serem retornados.
isKeyVaultRefreshFailed	query		boolean	Quando definida como true, a resposta contém apenas entidades de valor nomeadas que falharam na atualização.

Respostas

Nome	Tipo	Description
200 OK	NamedValueCollection	Uma coleção das entidades de valor nomeadas para a instância de serviço de Gerenciamento de API especificada.
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.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementListNamedValues

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/592f1174cc83890dc4f32686",
      "type": "Microsoft.ApiManagement/service/namedValues",
      "name": "592f1174cc83890dc4f32686",
      "properties": {
        "displayName": "Logger-Credentials-592f1174cc83890dc4f32687",
        "value": "propValue",
        "secret": false
      }
    },
    {
      "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": "2d2df842-44d8-4885-8dec-77cc1a984a31",
          "lastStatus": {
            "code": "Success",
            "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
          }
        },
        "tags": [
          "foo",
          "bar"
        ],
        "secret": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
KeyVaultContractProperties	Detalhes do contrato KeyVault.
KeyVaultLastAccessStatusContractProperties	Emitir propriedades de atualização do contrato.
NamedValueCollection	Representação de lista de NamedValue paginada.
NamedValueContract	Detalhes de NamedValue.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

KeyVaultContractProperties

Objeto

Detalhes do contrato KeyVault.

Nome	Tipo	Description
identityClientId	string	Nulo 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 o status do 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 o serviço de Gerenciamento de API seja configurado com aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Objeto

Emitir propriedades de atualização do contrato.

Nome	Tipo	Description
code	string	Último código de status para sincronização e atualização do segredo do cofre de chaves.
message	string	Detalhes do erro vazio.
timeStampUtc	string (date-time)	Ú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.

NamedValueCollection

Objeto

Representação de lista de NamedValue paginada.

Nome	Tipo	Description
count	integer (int64)	Número total de contagem de registros em todas as páginas.
nextLink	string	Link da próxima página, se houver.
value	NamedValueContract[]	Valores de página.

NamedValueContract

Objeto

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 minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	Nome exclusivo de NamedValue. Ele pode conter apenas letras, dígitos, ponto final, traço e caracteres de sublinhado.
properties.keyVault	KeyVaultContractProperties	Detalhes da localização de KeyVault do chamadoValue.
properties.provisioningState	string	O estado de provisionamento
properties.secret	boolean	Determina se o valor é um segredo e deve ser criptografado ou não. O valor padrão é falso.
properties.tags	string[]	Marcas opcionais que, quando fornecidas, podem ser usadas para filtrar a lista NamedValue.
properties.value	string maxLength: 4096	Valor do NamedValue. Pode conter expressões de política. Ele pode não estar vazio ou consistir apenas em espaço em branco. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Compartilhar via

Named Value - List By Service

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementListNamedValues

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

NamedValueCollection

NamedValueContract

Recursos adicionais