WorkspaceGroup interface
Interfaccia che rappresenta un WorkspaceGroup.
Metodi
Dettagli metodo
createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)
Crea o aggiorna un gruppo
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, parameters: GroupCreateParameters, options?: WorkspaceGroupCreateOrUpdateOptionalParams): Promise<WorkspaceGroupCreateOrUpdateResponse>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.
- groupId
-
string
Identificatore di gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- parameters
- GroupCreateParameters
Creare parametri.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceGroupCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)
Elimina un gruppo specifico dell'area di lavoro in un'istanza del servizio Gestione API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, options?: WorkspaceGroupDeleteOptionalParams): 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.
- groupId
-
string
Identificatore di gruppo. 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, WorkspaceGroupGetOptionalParams)
Ottiene i dettagli del gruppo specificato dal relativo identificatore.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetOptionalParams): Promise<WorkspaceGroupGetResponse>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.
- groupId
-
string
Identificatore di gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- options
- WorkspaceGroupGetOptionalParams
Parametri delle opzioni.
Restituisce
Promise<WorkspaceGroupGetResponse>
getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità (Etag) del gruppo specificato dal relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetEntityTagOptionalParams): Promise<WorkspaceGroupGetEntityTagHeaders>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.
- groupId
-
string
Identificatore di gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceGroupGetEntityTagHeaders>
listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)
Elenca una raccolta di gruppi definiti all'interno di un'area di lavoro in un'istanza del servizio.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], 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.
Parametri delle opzioni.
Restituisce
update(string, string, string, string, string, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)
Aggiorna i dettagli del gruppo specificato dal relativo identificatore.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: WorkspaceGroupUpdateOptionalParams): Promise<WorkspaceGroupUpdateResponse>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.
- groupId
-
string
Identificatore di gruppo. 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.
- parameters
- GroupUpdateParameters
Aggiornare i parametri.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceGroupUpdateResponse>