ApiSchema interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un'ApiSchema.

Metodi

beginCreateOrUpdate(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)	Crea o aggiorna la configurazione dello schema per l'API.
beginCreateOrUpdateAndWait(string, string, string, string, SchemaContract, ApiSchemaCreateOrUpdateOptionalParams)	Crea o aggiorna la configurazione dello schema per l'API.
delete(string, string, string, string, string, ApiSchemaDeleteOptionalParams)	Elimina la configurazione dello schema nell'API.
get(string, string, string, string, ApiSchemaGetOptionalParams)	Ottenere la configurazione dello schema a livello di API.
getEntityTag(string, string, string, string, ApiSchemaGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) dello schema specificato dall'identificatore.
listByApi(string, string, string, ApiSchemaListByApiOptionalParams)	Ottenere la configurazione dello schema a livello di API.

Dettagli metodo

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

Crea o aggiorna la configurazione dello schema per l'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente include ;rev=n come suffisso in cui n è il numero di revisione.

schemaId

string

Identificatore id schema. Deve essere univoco nell'istanza corrente del servizio Gestione API.

parameters

SchemaContract

Contenuto dello schema da applicare.

options

ApiSchemaCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiSchemaCreateOrUpdateResponse>, ApiSchemaCreateOrUpdateResponse>>

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

Crea o aggiorna la configurazione dello schema per l'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente include ;rev=n come suffisso in cui n è il numero di revisione.

schemaId

string

Identificatore id schema. Deve essere univoco nell'istanza corrente del servizio Gestione API.

parameters

SchemaContract

Contenuto dello schema da applicare.

options

ApiSchemaCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiSchemaCreateOrUpdateResponse>

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

Elimina la configurazione dello schema nell'API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente include ;rev=n come suffisso in cui n è il numero di revisione.

schemaId

string

Identificatore id schema. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

options

ApiSchemaDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

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

Ottenere la configurazione dello schema a livello di API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente include ;rev=n come suffisso in cui n è il numero di revisione.

schemaId

string

Identificatore id schema. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

ApiSchemaGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiSchemaGetResponse>

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

Ottiene la versione dello stato dell'entità (Etag) dello schema specificato dall'identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente include ;rev=n come suffisso in cui n è il numero di revisione.

schemaId

string

Identificatore id schema. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

ApiSchemaGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiSchemaGetEntityTagHeaders>

listByApi(string, string, string, ApiSchemaListByApiOptionalParams)

Ottenere la configurazione dello schema a livello di API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente include ;rev=n come suffisso in cui n è il numero di revisione.

options

ApiSchemaListByApiOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>