ApiSchema interface
Interface que representa um ApiSchema.
Métodos
| begin |
Cria ou atualiza a configuração do esquema para a API. |
| begin |
Cria ou atualiza a configuração do esquema para a API. |
| delete(string, string, string, string, string, Api |
Elimina a configuração do esquema na API. |
| get(string, string, string, string, Api |
Obtenha a configuração do esquema ao nível da API. |
| get |
Obtém a versão do estado da entidade (Etag) do esquema especificado pelo respetivo identificador. |
| list |
Obtenha a configuração do esquema ao 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- schemaId
-
string
Identificador de ID de esquema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- parameters
- SchemaContract
O conteúdo do esquema a aplicar.
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>
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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- schemaId
-
string
Identificador de ID de esquema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- parameters
- SchemaContract
O conteúdo do esquema a aplicar.
Os parâmetros de opções.
Devoluções
Promise<ApiSchemaCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)
Elimina 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- schemaId
-
string
Identificador de ID de esquema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido 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 ao 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- schemaId
-
string
Identificador de ID de esquema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- ApiSchemaGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<ApiSchemaGetResponse>
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do esquema especificado pelo respetivo 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- schemaId
-
string
Identificador de ID de esquema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
Promise<ApiSchemaGetEntityTagHeaders>
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)
Obtenha a configuração do esquema ao 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 é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- apiId
-
string
Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ;rev=n como um sufixo em que n é o número de revisão.
- options
- ApiSchemaListByApiOptionalParams
Os parâmetros de opções.