Partilhar via


ApiSchema interface

Interface que representa um ApiSchema.

Métodos

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração do esquema para a API.

beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração do esquema para a API.

delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)

Exclui a configuração do esquema na Api.

get(string, string, string, string, ApiSchemaGetOptionalParams)

Obtenha a configuração do esquema no nível da API.

getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)

Obtém a versão do estado da entidade (Etag) do esquema especificado por seu identificador.

listByApi(string, string, string, ApiSchemaListByApiOptionalParams)

Obtenha a configuração do esquema no nível da API.

Detalhes de Método

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração do esquema para a API.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

schemaId

string

Identificador de id do esquema. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

parameters
SchemaContract

O conteúdo do esquema a ser aplicado.

options
ApiSchemaCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)

Cria ou atualiza a configuração do esquema para a API.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: ApiSchemaCreateOrUpdateOptionalParams): Promise<ApiSchemaCreateOrUpdateResponse>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

schemaId

string

Identificador de id do esquema. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

parameters
SchemaContract

O conteúdo do esquema a ser aplicado.

options
ApiSchemaCreateOrUpdateOptionalParams

Os parâmetros de opções.

Devoluções

delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)

Exclui a configuração do esquema na Api.

function delete(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, ifMatch: string, options?: ApiSchemaDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

schemaId

string

Identificador de id do esquema. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

ifMatch

string

ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

options
ApiSchemaDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

get(string, string, string, string, ApiSchemaGetOptionalParams)

Obtenha a configuração do esquema no nível da API.

function get(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetOptionalParams): Promise<ApiSchemaGetResponse>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

schemaId

string

Identificador de id do esquema. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
ApiSchemaGetOptionalParams

Os parâmetros de opções.

Devoluções

getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)

Obtém a versão do estado da entidade (Etag) do esquema especificado por seu identificador.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, schemaId: string, options?: ApiSchemaGetEntityTagOptionalParams): Promise<ApiSchemaGetEntityTagHeaders>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

schemaId

string

Identificador de id do esquema. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.

options
ApiSchemaGetEntityTagOptionalParams

Os parâmetros de opções.

Devoluções

listByApi(string, string, string, ApiSchemaListByApiOptionalParams)

Obtenha a configuração do esquema no nível da API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>

Parâmetros

resourceGroupName

string

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

serviceName

string

O nome do serviço de Gerenciamento de API.

apiId

string

Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.

options
ApiSchemaListByApiOptionalParams

Os parâmetros de opções.

Devoluções