Group interface
Interface que representa um Grupo.
Métodos
| create |
Cria ou Atualizações um grupo. |
| delete(string, string, string, string, Group |
Elimina um grupo específico da instância do serviço Gestão de API. |
| get(string, string, string, Group |
Obtém os detalhes do grupo especificados pelo identificador. |
| get |
Obtém a versão de estado da entidade (Etag) do grupo especificada pelo identificador. |
| list |
Lista uma coleção de grupos definidos numa instância de serviço. |
| update(string, string, string, string, Group |
Atualizações os detalhes do grupo especificados pelo identificador. |
Detalhes de Método
createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)
Cria ou Atualizações um grupo.
function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- parameters
- GroupCreateParameters
Criar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<GroupCreateOrUpdateResponse>
delete(string, string, string, string, GroupDeleteOptionalParams)
Elimina um grupo específico da instância do serviço Gestão de API.
function delete(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, options?: GroupDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- options
- GroupDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, GroupGetOptionalParams)
Obtém os detalhes do grupo especificados pelo identificador.
function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- options
- GroupGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GroupGetResponse>
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)
Obtém a versão de estado da entidade (Etag) do grupo especificada pelo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- options
- GroupGetEntityTagOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GroupGetEntityTagHeaders>
listByService(string, string, GroupListByServiceOptionalParams)
Lista uma coleção de grupos definidos numa instância de serviço.
function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- options
- GroupListByServiceOptionalParams
Os parâmetros de opções.
Devoluções
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)
Atualizações os detalhes do grupo especificados pelo identificador.
function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- groupId
-
string
Identificador de grupo. Tem de ser exclusivo na instância de serviço de Gestão de API atual.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- GroupUpdateParameters
Atualizar parâmetros.
- options
- GroupUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GroupUpdateResponse>