Compartilhar via


Metadata Schemas - List

Retorna uma coleção de esquemas de metadados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas?api-version=2024-03-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiCenter/services/{serviceName}/metadataSchemas?api-version=2024-03-01&$filter={$filter}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
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 do Centro de API do Azure.

Padrão Regex: ^[a-zA-Z0-9-]{3,90}$

subscriptionId
path True

string

uuid

A ID da assinatura de destino. O valor deve ser um UUID.

api-version
query True

string

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

$filter
query

string

Parâmetro de filtro OData.

Respostas

Nome Tipo Description
200 OK

MetadataSchemaListResult

Operação do Azure concluída com êxito.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

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

MetadataSchemas_ListByService

Solicitação de exemplo

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas?api-version=2024-03-01

Resposta de exemplo

{
  "value": [
    {
      "type": "Microsoft.ApiCenter/services/metadataSchemas",
      "id": "/subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/contoso-resources/providers/Microsoft.ApiCenter/services/contoso/metadataSchemas/author",
      "name": "author",
      "systemData": {
        "createdAt": "2023-07-03T18:27:09.128871Z",
        "lastModifiedAt": "2023-07-03T18:27:09.1288716Z"
      },
      "properties": {
        "assignedTo": [
          {
            "entity": "api",
            "deprecated": true
          }
        ],
        "schema": "{\"type\":\"string\", \"title\":\"Author\", pattern: \"^[a-zA-Z]+$\"}"
      }
    }
  ]
}

Definições

Nome Description
createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

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

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

MetadataAssignment

Metadados de atribuição

MetadataAssignmentEntity

Entidade de atribuição para metadados

MetadataSchema

Entidade de esquema de metadados. Usado para definir metadados para as entidades no catálogo de API.

MetadataSchemaListResult

A resposta de uma operação de lista MetadataSchema.

systemData

Metadados relativos à criação e à última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

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

Os detalhes 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

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

MetadataAssignment

Metadados de atribuição

Nome Tipo Description
deprecated

boolean

Atribuição preterida

entity

MetadataAssignmentEntity

As entidades às qual esse componente de esquema de metadados é aplicado.

required

boolean

Atribuição necessária

MetadataAssignmentEntity

Entidade de atribuição para metadados

Nome Tipo Description
api

string

Atribuído à API

deployment

string

Atribuído à Implantação

environment

string

Atribuído ao Ambiente

MetadataSchema

Entidade de esquema de metadados. Usado para definir metadados para as entidades no catálogo de API.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

O nome do recurso

properties.assignedTo

MetadataAssignment[]

Os destinatários

properties.schema

string

O esquema que define o tipo.

systemData

systemData

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.

type

string

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

MetadataSchemaListResult

A resposta de uma operação de lista MetadataSchema.

Nome Tipo Description
nextLink

string

O link para a próxima página de itens

value

MetadataSchema[]

Os itens metadataSchema nesta página

systemData

Metadados relativos à criação e à última modificação do recurso.

Nome Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.