ApiTagDescription interface
Interfaccia che rappresenta un Oggetto ApiTagDescription.
Metodi
| create |
Creare/aggiornare la descrizione del tag nell'ambito dell'API. |
| delete(string, string, string, string, string, Api |
Eliminare la descrizione del tag per l'API. |
| get(string, string, string, string, Api |
Ottenere la descrizione del tag nell'ambito dell'API |
| get |
Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore. |
| list |
Elenca tutte le descrizioni dei tag nell'ambito dell'API. Modello simile a swagger: tagDescription viene definito a livello di API, ma il tag può essere assegnato alle operazioni |
Dettagli metodo
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
Creare/aggiornare la descrizione del tag nell'ambito dell'API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa 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 ha ; rev=n come suffisso dove n è il numero di revisione.
- tagDescriptionId
-
string
Identificatore della descrizione del tag. Usato durante la creazione di tagDescription per l'associazione API/Tag. In base all'API e ai nomi dei tag.
- parameters
- TagDescriptionCreateParameters
Creare parametri.
Parametri delle opzioni.
Restituisce
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
Eliminare la descrizione del tag per l'API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa 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 ha ; rev=n come suffisso dove n è il numero di revisione.
- tagDescriptionId
-
string
Identificatore della descrizione del tag. Usato durante la creazione di tagDescription per l'associazione API/Tag. In base all'API e ai nomi dei tag.
- 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, ApiTagDescriptionGetOptionalParams)
Ottenere la descrizione del tag nell'ambito dell'API
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa 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 ha ; rev=n come suffisso dove n è il numero di revisione.
- tagDescriptionId
-
string
Identificatore della descrizione del tag. Usato durante la creazione di tagDescription per l'associazione API/Tag. In base all'API e ai nomi dei tag.
Parametri delle opzioni.
Restituisce
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa 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 ha ; rev=n come suffisso dove n è il numero di revisione.
- tagDescriptionId
-
string
Identificatore della descrizione del tag. Usato durante la creazione di tagDescription per l'associazione API/Tag. In base all'API e ai nomi dei tag.
Parametri delle opzioni.
Restituisce
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
Elenca tutte le descrizioni dei tag nell'ambito dell'API. Modello simile a swagger: tagDescription viene definito a livello di API, ma il tag può essere assegnato alle operazioni
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome non fa 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 ha ; rev=n come suffisso dove n è il numero di revisione.
Parametri delle opzioni.