User - List By Service

Lista uma coleção de usuários registrados na instância de serviço especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?$filter={$filter}&$top={$top}&$skip={$skip}&expandGroups={expandGroups}&api-version=2021-08-01

Parâmetros de URI

Name In Required Type Description
resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço Gerenciamento de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

$filter
query
  • string

| Campo | | de uso Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| nome | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| email | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| | de estado filtrar | eq | |
| registrationDate | filtrar | ge, le, eq, ne, gt, lt | |
| observação | filtrar | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| grupos | expandir | | |

$skip
query
  • integer
int32

Número de registros a serem ignorados.

$top
query
  • integer
int32

Número de registros a serem retornados.

expandGroups
query
  • boolean

Grupo detalhado em resposta.

Respostas

Name Type Description
200 OK

Lista uma coleção de entidades de usuário.

Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementListUsers

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users?api-version=2021-08-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "1",
      "properties": {
        "firstName": "Administrator",
        "lastName": "",
        "email": "admin@live.com",
        "state": "active",
        "registrationDate": "2015-09-22T01:57:39.677Z",
        "identities": [
          {
            "provider": "Azure",
            "id": "admin@live.com"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "56eaec62baf08b06e46d27fd",
      "properties": {
        "firstName": "foo",
        "lastName": "bar",
        "email": "foo.bar.83@gmail.com",
        "state": "active",
        "registrationDate": "2016-03-17T17:41:56.327Z",
        "identities": [
          {
            "provider": "Basic",
            "id": "foo.bar.83@gmail.com"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "5931a75ae4bbd512a88c680b",
      "properties": {
        "firstName": "foo",
        "lastName": "bar",
        "email": "foobar@outlook.com",
        "state": "active",
        "registrationDate": "2017-06-02T17:58:50.357Z",
        "identities": [
          {
            "provider": "Microsoft",
            "id": "*************"
          }
        ]
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definições

ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta de erro.

GroupContractProperties

Propriedades do contrato de grupo.

GroupType

Tipo de grupo.

UserCollection

Representação da lista Usuários Paged.

UserContract

Detalhes do usuário.

UserIdentityContract

Detalhes da identidade do usuário.

UserState

Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

ErrorFieldContract

Contrato de Campo de Erro.

Name Type Description
code
  • string

Código de erro no nível da propriedade.

message
  • string

Representação legível de erro no nível da propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.

error.message
  • string

Representação legível ao olho humano do erro.

GroupContractProperties

Propriedades do contrato de grupo.

Name Type Description
builtIn
  • boolean

true se o grupo for um dos três grupos do sistema (Administradores, Desenvolvedores ou Convidados); caso contrário, false.

description
  • string

Descrição do grupo. Pode conter marcas de formatação HTML.

displayName
  • string

Nome do grupo.

externalId
  • string

Para grupos externos, essa propriedade contém a ID do grupo do provedor de identidade externo, por exemplo, para Azure Active Directoryaad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.

type

Tipo de grupo.

GroupType

Tipo de grupo.

Name Type Description
custom
  • string
external
  • string
system
  • string

UserCollection

Representação da lista Usuários Paged.

Name Type Description
count
  • integer

Número total de contagem de registros em todas as páginas.

nextLink
  • string

Próximo link da página, se houver.

value

Valores de página.

UserContract

Detalhes do usuário.

Name Type Default Value Description
id
  • string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

O nome do recurso

properties.email
  • string

Endereço de email.

properties.firstName
  • string

Nome.

properties.groups

A coleção de grupos do qual o usuário faz parte.

properties.identities

Coleção de identidades de usuário.

properties.lastName
  • string

Sobrenome.

properties.note
  • string

Observação opcional sobre um usuário definido pelo administrador.

properties.registrationDate
  • string

Data do registro do usuário. A data está em conformidade com o seguinte formato: yyyy-MM-ddTHH:mm:ssZ conforme especificado pelo padrão ISO 8601.

properties.state active

Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

type
  • string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft. Armazenamento/storageAccounts"

UserIdentityContract

Detalhes da identidade do usuário.

Name Type Description
id
  • string

Valor do identificador dentro do provedor.

provider
  • string

Nome do provedor de identidade.

UserState

Estado da conta. Especifica se o usuário está ativo ou não. Os usuários bloqueados não podem acessar o portal do desenvolvedor ou chamar quaisquer APIs dos produtos assinados. O estado padrão é Ativo.

Name Type Description
active
  • string

O estado do usuário está ativo.

blocked
  • string

O usuário está bloqueado. Os usuários bloqueados não podem autenticar no portal do desenvolvedor ou chamar a API.

deleted
  • string

A conta de usuário está fechada. Todas as identidades e entidades relacionadas são removidas.

pending
  • string

A conta de usuário está pendente. Requer a confirmação de identidade antes que ela possa ser ativada.