WorkspaceGroup interface
Interface que representa um WorkspaceGroup.
Métodos
| create |
Cria ou atualiza um grupo. |
| delete(string, string, string, string, string, Workspace |
Exclui um grupo específico do espaço de trabalho em uma instância de serviço de Gerenciamento de API. |
| get(string, string, string, string, Workspace |
Obtém os detalhes do grupo especificado por seu identificador. |
| get |
Obtém a versão do estado da entidade (Etag) do grupo especificado por seu identificador. |
| list |
Lista uma coleção de grupos definidos dentro de um espaço de trabalho em uma instância de serviço. |
| update(string, string, string, string, string, Group |
Atualiza os detalhes do grupo especificado por seu identificador. |
Detalhes de Método
createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)
Cria ou atualiza um grupo.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, parameters: GroupCreateParameters, options?: WorkspaceGroupCreateOrUpdateOptionalParams): Promise<WorkspaceGroupCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- groupId
-
string
Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- parameters
- GroupCreateParameters
Crie parâmetros.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceGroupCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)
Exclui um grupo específico do espaço de trabalho em uma instância de serviço de Gerenciamento de API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, options?: WorkspaceGroupDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- groupId
-
string
Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, WorkspaceGroupGetOptionalParams)
Obtém os detalhes do grupo especificado por seu identificador.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetOptionalParams): Promise<WorkspaceGroupGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- groupId
-
string
Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- options
- WorkspaceGroupGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<WorkspaceGroupGetResponse>
getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do grupo especificado por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetEntityTagOptionalParams): Promise<WorkspaceGroupGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- groupId
-
string
Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceGroupGetEntityTagHeaders>
listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)
Lista uma coleção de grupos definidos dentro de um espaço de trabalho em uma instância de serviço.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
update(string, string, string, string, string, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)
Atualiza os detalhes do grupo especificado por seu identificador.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: WorkspaceGroupUpdateOptionalParams): Promise<WorkspaceGroupUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- groupId
-
string
Identificador de grupo. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- GroupUpdateParameters
Atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceGroupUpdateResponse>