Accounts - Update

Referência

Service:: Purview

API Version:: 2021-12-01

Corrige o recurso da conta.
Atualizações uma conta

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{accountName}?api-version=2021-12-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da conta. Regex pattern: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	O nome do grupo de recursos.
subscriptionId	path	True	string	O identificador da subscrição
api-version	query	True	string	A versão da API a utilizar.

Corpo do Pedido

Name	Tipo	Description
identity	Identity	Informações relacionadas com a identidade para adicionar/remover userAssignedIdentities.
properties	AccountProperties	As propriedades da conta.
tags	object	Etiquetas no recurso do azure.

Respostas

Name	Tipo	Description
200 OK	Account	Com êxito
202 Accepted	Account	Aceite
Other Status Codes	ErrorResponseModel	Uma resposta de erro recebida do fornecedor.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Accounts_Update

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1?api-version=2021-12-01

{
  "tags": {
    "newTag": "New tag value."
  }
}

Sample Response

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

Response Body

{
  "location": "West US 2",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1",
  "name": "account1",
  "type": "Microsoft.Purview/accounts",
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "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",
    "provisioningState": "Succeeded",
    "accountStatus": {
      "accountProvisioningState": "Succeeded",
      "errorDetails": {}
    },
    "endpoints": {
      "catalog": "https://account2.catalog.purview.azure-test.com",
      "scan": "https://account2.scan.purview.azure-test.com",
      "guardian": "https://account1.guardian.purview.azure-test.com"
    },
    "publicNetworkAccess": "Enabled",
    "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"
    }
  },
  "tags": {
    "newTag": "New tag value."
  }
}

Status code:: 202

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
x-ms-long-running-operation: True
Azure-AsyncOperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2021-07-01

Response Body

{
  "location": "West US 2",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/SampleResourceGroup/providers/Microsoft.Purview/accounts/account1",
  "name": "account1",
  "type": "Microsoft.Purview/accounts",
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "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",
    "provisioningState": "Succeeded",
    "endpoints": {
      "catalog": "https://account2.catalog.purview.azure-test.com",
      "scan": "https://account2.scan.purview.azure-test.com",
      "guardian": "https://account1.guardian.purview.azure-test.com"
    },
    "publicNetworkAccess": "Enabled",
    "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"
    }
  },
  "tags": {
    "newTag": "New tag value."
  }
}

Definições

Name	Description
Account	Recurso de conta
AccountProperties	As propriedades da conta
AccountProperties.AccountStatus	Obtém ou define o estado da conta.
AccountProperties.ManagedResources	Obtém os identificadores de recursos dos recursos geridos.
accountProvisioningState	Obtém o código de estado da conta.
AccountStatus	O estado da conta.
AccountUpdateParameters	As propriedades de atualização da conta.
CloudConnectors	Conectores externos do Serviço Cloud
createdByType	O tipo de identidade que criou o recurso.
Endpoints	Os URIs que são os pontos finais públicos da conta.
Error	Obtém ou define o erro.
ErrorDetails	Obtém os detalhes do erro da conta.
ErrorModel	Modelo de erro predefinido
ErrorResponseModel	Modelo de resposta a erros predefinido
Identity	A Identidade Gerida do recurso
lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.
managedEventHubState	Obtém ou define o estado do eventhub gerido. Se o eventhub gerido ativado for criado, se desativar o eventhub gerido será removido.
ManagedResources	Os recursos geridos na subscrição do cliente.
managedResourcesPublicNetworkAccess	Obtém ou define o acesso à rede pública para recursos geridos.
name	Obtém ou define o nome do sku.
PrivateEndpoint	Uma classe de ponto final privado.
PrivateEndpointConnection	Uma classe de ligação de ponto final privado.
PrivateLinkServiceConnectionState	O estado de ligação do serviço de ligação privada.
provisioningState	Obtém ou define o estado do aprovisionamento.
publicNetworkAccess	Obtém ou define o acesso à rede pública.
Sku	Obtém ou define o Sku.
status	O estado.
SystemData	Metadados relativos à criação e última modificação do recurso.
TrackedResource.SystemData	Metadados relativos à criação e última modificação do recurso.
type	Tipo de Identidade
UserAssignedIdentity	Utiliza o ID de cliente e o ID principal

Account

Recurso de conta

Name	Tipo	Valor Predefinido	Description
id	string		Obtém ou define o identificador.
identity	Identity		Informações de Identidade no recurso controlado
location	string		Obtém ou define a localização.
name	string		Obtém ou define o nome.
properties.accountStatus	AccountProperties.AccountStatus		Obtém ou define o estado da conta.
properties.cloudConnectors	CloudConnectors		Conectores de cloud. Identificador de cloud externo utilizado como parte da configuração de análise.
properties.createdAt	string		Obtém o momento em que a entidade foi criada.
properties.createdBy	string		Obtém o criador da entidade.
properties.createdByObjectId	string		Obtém os criadores do ID do objeto da entidade.
properties.endpoints	Endpoints		Os URIs que são os pontos finais públicos da conta.
properties.friendlyName	string		Obtém ou define o nome amigável.
properties.managedEventHubState	managedEventHubState	NotSpecified	Obtém ou define o estado do eventhub gerido. Se o eventhub gerido ativado for criado, se desativar o eventhub gerido será removido.
properties.managedResourceGroupName	string		Obtém ou define o nome do grupo de recursos geridos
properties.managedResources	AccountProperties.ManagedResources		Obtém os identificadores de recursos dos recursos geridos.
properties.managedResourcesPublicNetworkAccess	managedResourcesPublicNetworkAccess	NotSpecified	Obtém ou define o acesso à rede pública para recursos geridos.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Obtém as informações de ligações de ponto final privado.
properties.provisioningState	provisioningState		Obtém ou define o estado do aprovisionamento.
properties.publicNetworkAccess	publicNetworkAccess	Enabled	Obtém ou define o acesso à rede pública.
sku	Sku		Obtém ou define o Sku.
systemData	TrackedResource.SystemData		Metadados relativos à criação e última modificação do recurso.
tags	object		Etiquetas no recurso do azure.
type	string		Obtém ou define o tipo.

AccountProperties

As propriedades da conta

Name	Tipo	Valor Predefinido	Description
accountStatus	AccountStatus		Obtém ou define o estado da conta.
cloudConnectors	CloudConnectors		Conectores de cloud. Identificador de cloud externo utilizado como parte da configuração de análise.
createdAt	string		Obtém o momento em que a entidade foi criada.
createdBy	string		Obtém o criador da entidade.
createdByObjectId	string		Obtém os criadores do ID do objeto da entidade.
endpoints	Endpoints		Os URIs que são os pontos finais públicos da conta.
friendlyName	string		Obtém ou define o nome amigável.
managedEventHubState	managedEventHubState	NotSpecified	Obtém ou define o estado do eventhub gerido. Se o eventhub gerido ativado for criado, se desativar o eventhub gerido será removido.
managedResourceGroupName	string		Obtém ou define o nome do grupo de recursos geridos
managedResources	ManagedResources		Obtém os identificadores de recursos dos recursos geridos.
managedResourcesPublicNetworkAccess	managedResourcesPublicNetworkAccess	NotSpecified	Obtém ou define o acesso à rede pública para recursos geridos.
privateEndpointConnections	PrivateEndpointConnection[]		Obtém as informações de ligações de ponto final privado.
provisioningState	provisioningState		Obtém ou define o estado do aprovisionamento.
publicNetworkAccess	publicNetworkAccess	Enabled	Obtém ou define o acesso à rede pública.

AccountProperties.AccountStatus

Obtém ou define o estado da conta.

Name	Tipo	Description
accountProvisioningState	accountProvisioningState	Obtém o código de estado da conta.
errorDetails	ErrorDetails	Obtém os detalhes do erro da conta.

AccountProperties.ManagedResources

Obtém os identificadores de recursos dos recursos geridos.

Name	Tipo	Description
eventHubNamespace	string	Obtém o identificador de recursos do espaço de nomes do hub de eventos gerido.
resourceGroup	string	Obtém o identificador de recursos do grupo de recursos gerido. Este grupo de recursos irá alojar dependências de recursos para a conta.
storageAccount	string	Obtém o identificador de recursos da conta de armazenamento gerida.

accountProvisioningState

Obtém o código de estado da conta.

Name	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
SoftDeleted	string
SoftDeleting	string
Succeeded	string
Unknown	string
Updating	string

AccountStatus

O estado da conta.

Name	Tipo	Description
accountProvisioningState	accountProvisioningState	Obtém o código de estado da conta.
errorDetails	ErrorDetails	Obtém os detalhes do erro da conta.

AccountUpdateParameters

As propriedades de atualização da conta.

Name	Tipo	Description
identity	Identity	Informações relacionadas com a identidade para adicionar/remover userAssignedIdentities.
properties	AccountProperties	As propriedades da conta.
tags	object	Etiquetas no recurso do azure.

CloudConnectors

Conectores externos do Serviço Cloud

Name	Tipo	Description
awsExternalId	string	Identificador externo do AWS. Configurado no AWS para permitir a utilização do arn de função utilizado para análise

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Endpoints

Os URIs que são os pontos finais públicos da conta.

Name	Tipo	Description
catalog	string	Obtém o ponto final do catálogo.
guardian	string	Obtém o ponto final do guardião.
scan	string	Obtém o ponto final de análise.

Error

Obtém ou define o erro.

Name	Tipo	Description
code	string	Obtém ou define o código.
details	ErrorModel[]	Obtém ou define os detalhes.
message	string	Obtém ou define as mensagens.
target	string	Obtém ou define o destino.

ErrorDetails

Obtém os detalhes do erro da conta.

Name	Tipo	Description
code	string	Obtém ou define o código.
details	ErrorModel[]	Obtém ou define os detalhes.
message	string	Obtém ou define as mensagens.
target	string	Obtém ou define o destino.

ErrorModel

Modelo de erro predefinido

Name	Tipo	Description
code	string	Obtém ou define o código.
details	ErrorModel[]	Obtém ou define os detalhes.
message	string	Obtém ou define as mensagens.
target	string	Obtém ou define o destino.

ErrorResponseModel

Modelo de resposta a erros predefinido

Name	Tipo	Description
error	Error	Obtém ou define o erro.

Identity

A Identidade Gerida do recurso

Name	Tipo	Description
principalId	string	ID do objeto do principal de serviço
tenantId	string	ID do Inquilino
type	type	Tipo de Identidade
userAssignedIdentities	<string, UserAssignedIdentity>	Identidades Atribuídas pelo Utilizador

lastModifiedByType

O tipo de identidade que modificou o recurso pela última vez.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

managedEventHubState

Obtém ou define o estado do eventhub gerido. Se o eventhub gerido ativado for criado, se desativar o eventhub gerido será removido.

Name	Tipo	Description
Disabled	string
Enabled	string
NotSpecified	string

ManagedResources

Os recursos geridos na subscrição do cliente.

Name	Tipo	Description
eventHubNamespace	string	Obtém o identificador de recursos do espaço de nomes do hub de eventos gerido.
resourceGroup	string	Obtém o identificador de recursos do grupo de recursos gerido. Este grupo de recursos irá alojar dependências de recursos para a conta.
storageAccount	string	Obtém o identificador de recursos da conta de armazenamento gerida.

managedResourcesPublicNetworkAccess

Obtém ou define o acesso à rede pública para recursos geridos.

Name	Tipo	Description
Disabled	string
Enabled	string
NotSpecified	string

name

Obtém ou define o nome do sku.

Name	Tipo	Description
Standard	string

PrivateEndpoint

Uma classe de ponto final privado.

Name	Tipo	Description
id	string	O identificador de ponto final privado.

PrivateEndpointConnection

Uma classe de ligação de ponto final privado.

Name	Tipo	Description
id	string	Obtém ou define o identificador.
name	string	Obtém ou define o nome.
properties.privateEndpoint	PrivateEndpoint	As informações do ponto final privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	O estado de ligação do serviço de ligação privada.
properties.provisioningState	string	O estado de aprovisionamento.
systemData	SystemData	Metadados relativos à criação e última modificação do recurso.
type	string	Obtém ou define o tipo.

PrivateLinkServiceConnectionState

O estado de ligação do serviço de ligação privada.

Name	Tipo	Description
actionsRequired	string	As ações necessárias.
description	string	A descrição.
status	status	O estado.

provisioningState

Obtém ou define o estado do aprovisionamento.

Name	Tipo	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Moving	string
SoftDeleted	string
SoftDeleting	string
Succeeded	string
Unknown	string

publicNetworkAccess

Obtém ou define o acesso à rede pública.

Name	Tipo	Description
Disabled	string
Enabled	string
NotSpecified	string

Sku

Obtém ou define o Sku.

Name	Tipo	Description
capacity	integer	Obtém ou define a capacidade do sku.
name	name	Obtém ou define o nome do sku.

status

O estado.

Name	Tipo	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string
Unknown	string

SystemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC).
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	lastModifiedByType	O tipo de identidade que modificou o recurso pela última vez.

TrackedResource.SystemData