WorkspaceApiSchema interface
Interfaccia che rappresenta un oggetto WorkspaceApiSchema.
Metodi
Dettagli metodo
beginCreateOrUpdate(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)
Crea o aggiorna la configurazione dello schema per l'API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: WorkspaceApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiSchemaCreateOrUpdateResponse>, WorkspaceApiSchemaCreateOrUpdateResponse>>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove 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.
Parametri delle opzioni.
Restituisce
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiSchemaCreateOrUpdateResponse>, WorkspaceApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)
Crea o aggiorna la configurazione dello schema per l'API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: WorkspaceApiSchemaCreateOrUpdateOptionalParams): Promise<WorkspaceApiSchemaCreateOrUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove 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.
Parametri delle opzioni.
Restituisce
delete(string, string, string, string, string, string, WorkspaceApiSchemaDeleteOptionalParams)
Elimina la configurazione dello schema nell'API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, ifMatch: string, options?: WorkspaceApiSchemaDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove 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 corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
Parametri delle opzioni.
Restituisce
Promise<void>
get(string, string, string, string, string, WorkspaceApiSchemaGetOptionalParams)
Ottenere la configurazione dello schema a livello di API.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, options?: WorkspaceApiSchemaGetOptionalParams): Promise<WorkspaceApiSchemaGetResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
- schemaId
-
string
Identificatore id schema. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceApiSchemaGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiSchemaGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità (Etag) dello schema specificato dal relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, options?: WorkspaceApiSchemaGetEntityTagOptionalParams): Promise<WorkspaceApiSchemaGetEntityTagHeaders>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
- schemaId
-
string
Identificatore id schema. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
listByApi(string, string, string, string, WorkspaceApiSchemaListByApiOptionalParams)
Ottenere la configurazione dello schema a livello di API.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
Parametri delle opzioni.