GlobalSchema interface
Interface que representa um GlobalSchema.
Métodos
| begin |
Cria um esquema novo ou atualiza o Esquema especificado existente da instância do serviço Gestão de API. |
| begin |
Cria um esquema novo ou atualiza o Esquema especificado existente da instância do serviço Gestão de API. |
| delete(string, string, string, string, Global |
Elimina o Esquema específico. |
| get(string, string, string, Global |
Obtém os detalhes do Esquema especificado pelo respetivo identificador. |
| get |
Obtém a versão do estado da entidade (Etag) do Esquema especificado pelo respetivo identificador. |
| list |
Lista uma coleção de esquemas registados na instância de serviço. |
Detalhes de Método
beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)
Cria um esquema novo ou atualiza o Esquema especificado existente da instância do serviço Gestão de API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>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.
- schemaId
-
string
Identificador de ID de esquema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- parameters
- GlobalSchemaContract
Criar ou atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<@azure/core-lro.SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)
Cria um esquema novo ou atualiza o Esquema especificado existente da instância do serviço Gestão de API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<GlobalSchemaCreateOrUpdateResponse>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.
- schemaId
-
string
Identificador de ID de esquema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- parameters
- GlobalSchemaContract
Criar ou atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<GlobalSchemaCreateOrUpdateResponse>
delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)
Elimina o Esquema específico.
function delete(resourceGroupName: string, serviceName: string, schemaId: string, ifMatch: string, options?: GlobalSchemaDeleteOptionalParams): 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.
- 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
- GlobalSchemaDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, GlobalSchemaGetOptionalParams)
Obtém os detalhes do Esquema especificado pelo respetivo identificador.
function get(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetOptionalParams): Promise<GlobalSchemaGetResponse>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.
- schemaId
-
string
Identificador de ID de esquema. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- GlobalSchemaGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GlobalSchemaGetResponse>
getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do Esquema especificado pelo respetivo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetEntityTagOptionalParams): Promise<GlobalSchemaGetEntityTagHeaders>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.
- 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<GlobalSchemaGetEntityTagHeaders>
listByService(string, string, GlobalSchemaListByServiceOptionalParams)
Lista uma coleção de esquemas registados na instância de serviço.
function listByService(resourceGroupName: string, serviceName: string, options?: GlobalSchemaListByServiceOptionalParams): PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], 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.
Os parâmetros de opções.