Accounts - Get Account Properties

Referencia

Servicio:: Purview

Versión de la API:: 2019-11-01-preview

Obtención de una cuenta

GET {endpoint}/?api-version=2019-11-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Punto de conexión de la cuenta de Purview. Ejemplo: https://{accountName}.purview.azure.com/account/
api-version	query	True	string	Versión de api que se va a usar.

Respuestas

Nombre	Tipo	Description
200 OK	Account	Éxito
Other Status Codes	ErrorResponseModel	Respuesta de error recibida del proveedor.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Accounts_GetAccountProperties

Solicitud de ejemplo

HTTP

GET {endpoint}/?api-version=2019-11-01-preview

Respuesta de muestra

status code:: 200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

{
  "location": "West US 2",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.ProjectBabylon/accounts/account1",
  "name": "account1",
  "type": "Microsoft.ProjectBabylon/accounts",
  "sku": {
    "name": "Standard",
    "capacity": 4
  },
  "systemData": {
    "createdBy": "client-name",
    "createdByType": "User",
    "createdAt": "2019-11-22T18:39:58.6929344Z",
    "lastModifiedBy": "client-name",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-03-16T23:24:34.3430059Z"
  },
  "properties": {
    "friendlyName": "friendly-account1",
    "createdBy": "client-name",
    "createdByObjectId": "client-objectId",
    "createdAt": "2019-11-22T18:39:58.6929344Z",
    "provisioningState": "Succeeded",
    "endpoints": {
      "catalog": "https://account1.catalog.babylon.azure-test.com",
      "scan": "https://account1.scan.babylon.azure-test.com",
      "guardian": "https://account1.guardian.babylon.azure-test.com"
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/baca8a88-4527-4c35-a13e-b2775ce0d7fc/resourceGroups/nrpResourceGroupName/providers/Microsoft.Network/privateEndpoints/peName"
          },
          "privateLinkServiceConnectionState": {
            "status": "Pending",
            "description": "Please approve my connection, thanks.",
            "actionsRequired": "None"
          }
        },
        "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.ProjectBabylon/accounts/account1/privateEndpointConnections/peName-8536c337-7b36-4d67-a7ce-081655baf59e",
        "name": "peName-8536c337-7b36-4d67-a7ce-081655baf59e",
        "type": "Microsoft.ProjectBabylon/accounts/privateEndpointConnections"
      }
    ],
    "managedResources": {
      "resourceGroup": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl",
      "storageAccount": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.Storage/storageAccounts/scanwestustzaagzr",
      "eventHubNamespace": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/managed-rg-mwjotkl/providers/Microsoft.EventHub/namespaces/atlas-westusdddnbtp"
    }
  }
}

Definiciones

Nombre	Description
Account	Recurso de cuenta
AccountProperties	Propiedades de la cuenta
AccountSku	The Sku
CloudConnectors
createdByType	Tipo de identidad que creó el recurso.
Endpoints	Los URI que son los puntos de conexión públicos de la cuenta.
Error	Obtiene o establece el error.
ErrorModel	Modelo de error predeterminado
ErrorResponseModel	Modelo de respuesta de error predeterminado
Identity	Identidad administrada del recurso
lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.
ManagedResources	Los recursos administrados de la suscripción del cliente.
name	Obtiene o establece el nombre de la SKU.
PrivateEndpoint	Una clase de punto de conexión privado.
PrivateEndpointConnection	Una clase de conexión de punto de conexión privado.
PrivateEndpointConnectionProperties	Una clase de propiedades de conexión de punto de conexión privado.
PrivateLinkServiceConnectionState	Estado de conexión del servicio private link.
provisioningState	Obtiene o establece el estado del aprovisionamiento.
publicNetworkAccess	Obtiene o establece el acceso a la red pública.
status	Estado.
SystemData	Metadatos relativos a la creación y última modificación del recurso.
type	Tipo de identidad

Account

Object

Recurso de cuenta

Nombre	Tipo	Description
id	string	Obtiene o establece el identificador.
identity	Identity	Información de identidad en el recurso con seguimiento
location	string	Obtiene o establece la ubicación.
name	string	Obtiene o establece el nombre.
properties	AccountProperties	Obtiene o establece las propiedades.
sku	AccountSku	Obtiene o establece la SKU.
systemData	SystemData	Metadatos relativos a la creación y última modificación del recurso.
tags	object	Etiquetas en el recurso de Azure.
type	string	Obtiene o establece el tipo.

AccountProperties

Object

Propiedades de la cuenta

Nombre	Tipo	Valor predeterminado	Description
cloudConnectors	CloudConnectors		Conectores en la nube. Identificador de nube externo que se usa como parte de la configuración de examen.
createdAt	string (date-time)		Obtiene la hora en la que se creó la entidad.
createdBy	string		Obtiene el creador de la entidad.
createdByObjectId	string		Obtiene los creadores del identificador de objeto de la entidad.
endpoints	Endpoints		Los URI que son los puntos de conexión públicos de la cuenta.
friendlyName	string		Obtiene o establece el nombre descriptivo.
managedResourceGroupName	string		Obtiene o establece el nombre del grupo de recursos administrado.
managedResources	ManagedResources		Obtiene los identificadores de recursos de los recursos administrados.
privateEndpointConnections	PrivateEndpointConnection[]		Obtiene la información de las conexiones de punto de conexión privado.
provisioningState	provisioningState		Obtiene o establece el estado del aprovisionamiento.
publicNetworkAccess	publicNetworkAccess	Enabled	Obtiene o establece el acceso a la red pública.

AccountSku

Object

The Sku

Nombre	Tipo	Description
capacity	integer (int32)	Obtiene o establece la capacidad de SKU. Entre los valores posibles se incluyen: 4, 16
name	name	Obtiene o establece el nombre de la SKU.

CloudConnectors

Object

Nombre	Tipo	Description
awsExternalId	string	Identificador externo de AWS. Configurado en AWS para permitir el uso del arn de rol usado para el examen

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

Endpoints

Object

Los URI que son los puntos de conexión públicos de la cuenta.

Nombre	Tipo	Description
catalog	string	Obtiene el punto de conexión del catálogo.
guardian	string	Obtiene el punto de conexión de protección.
scan	string	Obtiene el punto de conexión de examen.

Error

Object

Obtiene o establece el error.

Nombre	Tipo	Description
code	string	Obtiene o establece el código.
details	ErrorModel[]	Obtiene o establece los detalles.
message	string	Obtiene o establece los mensajes.
target	string	Obtiene o establece el destino.

ErrorModel

Object

Modelo de error predeterminado

Nombre	Tipo	Description
code	string	Obtiene o establece el código.
details	ErrorModel[]	Obtiene o establece los detalles.
message	string	Obtiene o establece los mensajes.
target	string	Obtiene o establece el destino.

ErrorResponseModel

Object

Modelo de respuesta de error predeterminado

Nombre	Tipo	Description
error	Error	Obtiene o establece el error.

Identity

Object

Identidad administrada del recurso

Nombre	Tipo	Description
principalId	string	Identificador de objeto de entidad de servicio
tenantId	string	Id. de inquilino
type	type	Tipo de identidad

lastModifiedByType

Enumeración

Tipo de identidad que modificó por última vez el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ManagedResources

Object

Los recursos administrados de la suscripción del cliente.

Nombre	Tipo	Description
eventHubNamespace	string	Obtiene el identificador de recurso del espacio de nombres del centro de eventos administrado.
resourceGroup	string	Obtiene el identificador de recursos del grupo de recursos administrado. Este grupo de recursos hospedará las dependencias de recursos de la cuenta.
storageAccount	string	Obtiene el identificador de recursos de la cuenta de almacenamiento administrada.

name

Enumeración

Obtiene o establece el nombre de la SKU.

Valor	Description
Standard

PrivateEndpoint

Object

Una clase de punto de conexión privado.

Nombre	Tipo	Description
id	string	Identificador del punto de conexión privado.

PrivateEndpointConnection

Object

Una clase de conexión de punto de conexión privado.

Nombre	Tipo	Description
id	string	Obtiene o establece el identificador.
name	string	Obtiene o establece el nombre.
properties	PrivateEndpointConnectionProperties	Identificador de conexión.
type	string	Obtiene o establece el tipo.

PrivateEndpointConnectionProperties

Object

Una clase de propiedades de conexión de punto de conexión privado.

Nombre	Tipo	Description
privateEndpoint	PrivateEndpoint	Información del punto de conexión privado.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Estado de conexión del servicio private link.
provisioningState	string	Estado de aprovisionamiento.

PrivateLinkServiceConnectionState

Object

Estado de conexión del servicio private link.

Nombre	Tipo	Description
actionsRequired	string	Las acciones necesarias.
description	string	Descripción.
status	status	Estado.

provisioningState

Enumeración

Obtiene o establece el estado del aprovisionamiento.

Valor	Description
Canceled
Creating
Deleting
Failed
Moving
SoftDeleted
SoftDeleting
Succeeded
Unknown

publicNetworkAccess

Enumeración

Obtiene o establece el acceso a la red pública.

Valor	Description
Disabled
Enabled
NotSpecified

status

Enumeración

Estado.

Valor	Description
Approved
Disconnected
Pending
Rejected
Unknown

SystemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC).
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.

type

Enumeración

Tipo de identidad

Valor	Description
SystemAssigned

Compartir a través de

Accounts - Get Account Properties

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Accounts_GetAccountProperties

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Account

AccountProperties

AccountSku

CloudConnectors

createdByType

Endpoints

Error

ErrorModel

ErrorResponseModel

Identity

lastModifiedByType

ManagedResources

name

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

provisioningState

publicNetworkAccess

status

SystemData

type