Client Groups - Get

Serviço:
Service Map
Versão da API:
2015-11-01-preview

Recupera o grupo de clientes especificado

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}?api-version=2015-11-01-preview
Com parâmetros opcionais: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/features/serviceMap/clientGroups/{clientGroupName}?api-version=2015-11-01-preview&startTime={startTime}&endTime={endTime}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
clientGroupName
 path True

string

minLength: 3
maxLength: 256

Nome do recurso grupo de clientes.
resourceGroupName
 path True

string

minLength: 1
maxLength: 64
pattern: [a-zA-Z0-9_-]+

Nome do grupo de recursos na subscriptionId especificada.
subscriptionId
 path True

string

Identificador de assinatura do Azure.
workspaceName
 path True

string

minLength: 3
maxLength: 63
pattern: [a-zA-Z0-9_][a-zA-Z0-9_-]+[a-zA-Z0-9_]

Workspace do OMS que contém os recursos de interesse.
api-version
 query True

string

Versão da API.
endTime
 query

string (date-time)

Data e hora UTC especificando a hora de término de um intervalo. Quando não especificado, o serviço usa DateTime.UtcNow
startTime
 query

string (date-time)

Data e hora UTC especificando a hora de início de um intervalo. Quando não especificado, o serviço usa DateTime.UtcNow – 10m

Respostas

Nome Tipo Description
200 OK

ClientGroup

A operação foi concluída com êxito.
Other Status Codes

ErrorResponse

Erro ao processar a solicitação. Consulte o parâmetro error.code para identificar o erro específico.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

SMClientGroupsGetGet

Solicitação de exemplo

GET https://management.azure.com/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/features/serviceMap/clientGroups/m!m-A4AB1C69-03E9-42D2-B822-B42555569FB4!b!b-c0a8010a_10000?api-version=2015-11-01-preview&startTime=2018-01-08T21:26:53.7181136Z&endTime=2018-01-08T21:28:53.7181136Z

Resposta de exemplo

Código de status:
200 
{
  "kind": "clientGroup",
  "properties": {
    "clientsOf": {
      "kind": "ref:port",
      "properties": {
        "machine": {
          "kind": "ref:machine",
          "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-A4AB1C69-03E9-42D2-B822-B42555569FB4",
          "type": "Microsoft.OperationalInsights/workspaces/features/machines",
          "name": "m-A4AB1C69-03E9-42D2-B822-B42555569FB4"
        },
        "ipAddress": "192.168.1.10",
        "portNumber": 10000
      },
      "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/machines/m-A4AB1C69-03E9-42D2-B822-B42555569FB4/ports/b-c0a8010a_10000",
      "type": "Microsoft.OperationalInsights/workspaces/features/machines/ports",
      "name": "b-c0a8010a_10000"
    }
  },
  "id": "/subscriptions/63BE4E24-FDF0-4E9C-9342-6A5D5A359722/resourceGroups/rg-sm/providers/Microsoft.OperationalInsights/workspaces/D6F79F14-E563-469B-84B5-9286D2803B2F/clientGroups/m!m-A4AB1C69-03E9-42D2-B822-B42555569FB4!b!b-c0a8010a_10000",
  "type": "Microsoft.OperationalInsights/workspaces/features/clientGroups",
  "name": "m!m-A4AB1C69-03E9-42D2-B822-B42555569FB4!b!b-c0a8010a_10000"
}

Definições

Nome Description
ClientGroup

Representa uma coleção de clientes de um recurso. Um grupo de clientes pode representar os clientes de uma porta, processo ou um computador.
ClientGroupReference

Referência a um grupo de clientes.
Error

Detalhes do erro.
ErrorResponse

Uma resposta de erro da API.
MachineReference

Referência a um computador.
MachineReferenceWithHints

Uma referência de computador com uma dica do nome do computador e do sistema operacional.
OperatingSystemFamily

Especifica a família do sistema operacional, por exemplo, Linux, Windows etc.
PortReference

Referência a uma porta.
ProcessReference

Referência a um processo.

ClientGroup

Objeto

Representa uma coleção de clientes de um recurso. Um grupo de clientes pode representar os clientes de uma porta, processo ou um computador.

Nome Tipo Description
etag

string

ETAG de recurso.
id

string

Identificador de recurso.
kind string:

clientGroup

Qualificador de tipo de recurso adicional.
name

string

Nome do recurso.
properties.clientsOf ResourceReference:

Referência ao recurso cujos clientes são representados por esse grupo.
type

string

Tipo de recurso.

ClientGroupReference

Objeto

Referência a um grupo de clientes.

Nome Tipo Description
id

string

URI do recurso.
kind string:

ref:clientgroup

Especifica a sub-classe da referência.
name

string

Nome do recurso.
type

string

Qualificador de tipo de recurso.

Error

Objeto

Detalhes do erro.

Nome Tipo Description
code

string

Código de erro que identifica o erro específico.
message

string

Mensagem de erro na localidade do chamador.

ErrorResponse

Objeto

Uma resposta de erro da API.

Nome Tipo Description
error

Error

Informações de erro.

MachineReference

Objeto

Referência a um computador.

Nome Tipo Description
id

string

URI do recurso.
kind string:

ref:machine

Especifica a sub-classe da referência.
name

string

Nome do recurso.
type

string

Qualificador de tipo de recurso.

MachineReferenceWithHints

Objeto

Uma referência de computador com uma dica do nome do computador e do sistema operacional.

Nome Tipo Description
id

string

URI do recurso.
kind string:

ref:machinewithhints

Especifica a sub-classe da referência.
name

string

Nome do recurso.
properties.displayNameHint

string

Último nome de exibição conhecido.
properties.osFamilyHint

OperatingSystemFamily

Última família conhecida do sistema operacional.
type

string

Qualificador de tipo de recurso.

OperatingSystemFamily

Enumeração

Especifica a família do sistema operacional, por exemplo, Linux, Windows etc.

Valor Description
unknown
windows
linux
solaris
aix

PortReference

Objeto

Referência a uma porta.

Nome Tipo Description
id

string

URI do recurso.
kind string:

ref:port

Especifica a sub-classe da referência.
name

string

Nome do recurso.
properties.ipAddress

string

Endereço IP da porta.
properties.machine

MachineReference

Computador que hospeda a porta.
properties.portNumber

integer (int32)

Número da porta.
type

string

Qualificador de tipo de recurso.

ProcessReference

Objeto

Referência a um processo.

Nome Tipo Description
id

string

URI do recurso.
kind string:

ref:process

Especifica a sub-classe da referência.
name

string

Nome do recurso.
properties.machine

MachineReference

Computador que hospeda o processo.
type

string

Qualificador de tipo de recurso.