Power Platform para Administradores

O Conector de Gerenciamento do Power Platform fornece acesso aos recursos de gerenciamento do ciclo de vida do ambiente, ao gerenciamento de políticas DLP e a outros recursos de administrador fornecidos na API BAP.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Standard	Todas as regiões do Power Automate
Power Apps	Standard	Todas as regiões do Power Apps
Power Automate	Standard	Todas as regiões do Power Automate

Contato
Nome	Suporte do Microsoft Power Apps
URL	https://powerapps.microsoft.com/en-us/support/

Metadados do conector
Publicador	Microsoft
Site	https://admin.powerplatform.microsoft.com/
Política de privacidade	https://privacy.microsoft.com/en-us/privacystatement

O Power Platform para Administradores é uma interface de conector para acessar a API bap (Business Applications Platform), que é usada para gerenciar os recursos relacionados ao administrador do Power Platform -- a mesma API que opera o Centro de Administração do Power Platform. Isso inclui o gerenciamento de ciclo de vida do ambiente e permissões, operações de provisionamento do Dataverse, políticas DLP e sincronização de usuário.

Pré-requisitos

Qualquer usuário pode criar uma conexão autenticada da ID do Microsoft Entra para esse conector, os dados serão retornados com base no escopo do usuário.

Os administradores de serviços do Power Platform terão acesso a todos os recursos e operações disponíveis em seu locatário a partir desse ponto de extremidade.
Os administradores de ambiente só terão acesso a dados e operações em seus ambientes, políticas DLP pelas quais podem gerenciar ou são afetadas.

Problemas e limitações conhecidos

Não passe um valor nulo ou blank() como um grupo de conectores de API (matriz) ao criar ou atualizar uma política DLP, ele pode interromper a política e se tornar inutilizável com outras consequências não intencionais. Se o grupo não deve ter conectores nele, passe um conjunto vazio de colchetes [ ].
As operações DLP antigas não funcionam com os grupos bloqueados DLP atualizados e estão sendo preteridas. Use as versões 'V2' de todas as operações DLP.
Os grupos de políticas DLP não preenchem automaticamente com conectores, portanto, eles precisarão ser recuperados, formatados e adicionados como parâmetros de entrada:
- Crie uma variável de matriz para armazenar os conectores.
- Salve a ID de ambiente padrão do locatário em uma variável.
- Use a operação GetConnectors do Power Platform for App Makers para recuperar todos os conectores de um ambiente (use o filtro: "environment eq '{environmentName}' ", em que o nome do ambiente é da etapa anterior).
- Use a operação Selecionar para usar apenas os campos de id, nome e tipo da resposta GetConnectors (use a última opção de conteúdo dinâmico 'value'). Coloque id, nome e tipo no lado esquerdo e mapeie a id, displayName e digite no lado direito da ação de seleção.
- Salvar a saída de Selecionar na variável de matriz
- Acrescente esses conectores codificados à variável de matriz (eles não aparecem na resposta GetConnectors):
```
[
    {
      "id": "/providers/Microsoft.PowerApps/apis/shared_microsoftspatialservices",
      "name": "Spatial Services",
      "type": "Microsoft.PowerApps/apis"
    },
    {
      "id": "HttpRequestReceived",
      "name": "When a HTTP request is received",
      "type": "Microsoft.PowerApps/apis"
    },
    {
      "id": "HttpWebhook",
      "name": "HTTP Webhook",
      "type": "Microsoft.PowerApps/apis"
    },
      {
      "id": "Http",
      "name": "HTTP",
      "type": "Microsoft.PowerApps/apis"
    }
]
```

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Atualizar ambiente	Atualiza as propriedades de um ambiente.
Atualizar política DLP de locatário	Atualiza os campos em uma Política DLP.
Atualizar política DLP do ambiente	Atualiza uma política de DLP de ambiente.
Atualizar política DLP V2	Atualiza uma política DLP.
Criar ambiente	Cria um novo Ambiente.
Criar banco de dados CDS	Cria uma nova instância de CDS no Ambiente especificado.
Criar política de DLP do ambiente	Cria uma política de DLP de ambiente.
Criar política DLP de locatário	Cria uma nova Política DLP de Locatário.
Criar política DLP V2	Cria uma nova política DLP.
Editar Atribuição de Função de Ambiente	Define permissões para um Ambiente.
Excluir ambiente	Exclui um ambiente.
Excluir Política de DLP V2	Exclui uma política DLP.
Excluir Política DLP de Locatário	Exclui uma política DLP de locatário.
Excluir política DLP do ambiente	Exclui uma política DLP de ambiente.
Forçar usuário de Sincronização	Usado para sincronizar o usuário do PowerApps com o CRM.
Listar ambientes como administrador	Retorna uma lista de Ambientes.
Listar atribuições de função de ambiente	Retorna uma lista de permissões para um Ambiente sem CDS para Aplicativos.
Listar conectores desbloqueáveis	Retorna uma lista de conectores que não podem ser bloqueados com uma política DLP.
Listar conectores virtuais	Retorna uma lista de conectores virtuais.
Listar idiomas de ambiente com suporte	Retorna uma lista de idiomas com suporte com base no local.
Listar locais com suporte	Retorna uma lista de locais em que há suporte para o serviço BAP.
Listar moedas de ambiente com suporte	Retorna uma lista de moedas com suporte com base no local.
Listar políticas DLP	Retorna uma lista de todas as Políticas DLP de Locatário e Ambiente.
Listar políticas DLP V2	Retorna uma lista de todas as políticas DLP que a conta pode acessar.
Obter o Ambiente como Administrador	Retorna um único Ambiente como Administrador.
Obter o status da operação do ambiente (versão prévia)	Usado para verificar o status de uma operação de ambiente, sucn como exclusão.
Obter o status da operação do ciclo de vida	Retorna o status atual da operação de ciclo de vida que ocorre após um patch de ambiente.
Obter o status de provisionamento de banco de dados	Usado para verificar o status de uma operação de provisionamento.
Obter o status de provisionamento do CDS	Usado para verificar o status de uma operação de provisionamento.
Obter política de DLP do ambiente	Retorna uma política de DLP de ambiente.
Obter política de DLP V2	Retorna uma política DLP.
Obter política DLP de locatário	Retorna uma política DLP de locatário.
Validar exclusão de ambiente	Usado para verificar se um Ambiente pode ser excluído.

Atualizar ambiente

ID da operação:: UpdateEnvironment

Atualiza as propriedades de um ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Versão da API	api-version		string	O valor de data da API.
descrição	description		string
nome de exibição	displayName		string
ID do grupo de segurança	securityGroupId		string

Atualizar política DLP de locatário

ID da operação:: Edit-AdminDlpPolicy

Atualiza os campos em uma Política DLP.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Policy	policy	True	string	O campo nome da Política.
Versão da API	api-version		string	O valor de data da API.
Nome de Exibição	displayName	True	string	Nome de exibição da Política de API.
Versão do esquema	$schema	True	string	Definição de política de API $schema.
Tipo de restrição	type	True	string	Tipo de restrição de política, deixe em branco para aplicar a política a todos os Ambientes.
Nome	name	True	string	Campo nome do ambiente de política.
ID	id	True	string	Campo ID do Ambiente de Política.
Tipo	type	True	string	Campo tipo ambiente de política.
Tipo de filtro de ambiente	filterType	True	string	FilterType do parâmetro environmentFilter1 da restrição de Política de API.
Descrição de dados corporativos	description		string	Descrição do grupo de dados de negócios de política.
ID do Conector	id		string	Campo ID do conector de Dados Corporativos.
Nome do Conector	name		string	Campo nome do conector de Dados Corporativos.
Tipo de conector	type		string	Campo de tipo do conector de Dados Corporativos.
Descrição de dados não comerciais	description		string	Descrição do grupo de dados não comercial da política.
ID do Conector	id		string	Campo ID do conector de Dados Não Comerciais.
Nome do Conector	name		string	Campo de nome do conector de Dados Não Corporativos.
Tipo de conector	type		string	Campo de tipo de conector de Dados Não Comerciais.
Grupo Padrão	defaultApiGroup	True	string	Agrupar um novo conector ao qual é adicionado automaticamente.
tipo	type	True	string	Tipo apiGroupRule da regra de política.
apiGrupo	apiGroup	True	string	ApiGroupRule parameter apiGroup da regra de política.
Tipo de ação de bloco	type	True	string	Bloquear o tipo de ação, deixe em branco se não for desejado adicionar um bloco.

Retornos

Corpo: Policy

Atualizar política DLP do ambiente

ID da operação:: EditEnvironmentPolicy

Atualiza uma política de DLP de ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Policy	policy	True	string	O campo nome da Política.
Versão da API	api-version		string	O valor de data da API.
Nome de Exibição	displayName	True	string	Nome de exibição da Política de API.
Versão do esquema	$schema	True	string	Definição de política de API $schema.
Nome	name	True	string	Campo nome do ambiente de política.
ID	id	True	string	Campo ID do Ambiente de Política.
Tipo	type	True	string	Campo tipo ambiente de política.
Descrição de dados corporativos	description		string	Descrição do grupo de dados de negócios de política.
ID do Conector	id		string	Campo ID do conector de Dados Corporativos.
Nome do Conector	name		string	Campo nome do conector de Dados Corporativos.
Tipo de conector	type		string	Campo de tipo do conector de Dados Corporativos.
Descrição de dados não comerciais	description		string	Descrição do grupo de dados não comercial da política.
ID do Conector	id		string	Campo ID do conector de Dados Não Comerciais.
Nome do Conector	name		string	Campo de nome do conector de Dados Não Corporativos.
Tipo de conector	type		string	Campo de tipo de conector de Dados Não Comerciais.
Grupo Padrão	defaultApiGroup	True	string	Agrupar um novo conector ao qual é adicionado automaticamente.
tipo	type	True	string	Tipo apiGroupRule da regra de política.
apiGrupo	apiGroup	True	string	ApiGroupRule parameter apiGroup da regra de política.
Tipo de ação de bloco	type	True	string	Bloquear o tipo de ação, deixe em branco se não for desejado adicionar um bloco.

Retornos

Corpo: Policy

Atualizar política DLP V2

ID da operação:: UpdatePolicyV2

Atualiza uma política DLP.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Policy	policy	True	string	O campo nome da Política.
Versão da API	api-version		string	O valor de data da API.
Nome de exibição	displayName		string
Classificação de conectores padrão	defaultConnectorsClassification		string
classificação	classification	True	string
id	id	True	string
tipo	type	True	string
nome	name	True	string
Tipo de ambiente de política	environmentType		string
id	id	True	string
tipo	type	True	string
nome	name	True	string

Retornos

Corpo: PolicyV2

Criar ambiente

ID da operação:: NewAdminEnvironment

Cria um novo Ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	api-version	True	string	O valor de data da API.
Localização	location	True	string	Região em que o Ambiente é implantado.
Nome de Exibição	displayName	True	string	Nome da vaidade do Ambiente.
SKU do ambiente	environmentSku	True	string	Tipo de ambiente.

Retornos

Objeto de ambiente.

Corpo: Environment

Criar banco de dados CDS

ID da operação:: ProvisionInstance

Cria uma nova instância de CDS no Ambiente especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Idioma base	baseLanguage		integer	Qualquer idioma retornado das Linguagens de Ambiente de Lista.
Código de moeda	code		string	Qualquer código de moeda retornado de Moedas de Ambiente de Lista.
Modelos	templates		array of string	Lista validada de modelos de CRM a serem passados para a chamada de provisionamento.

Retornos

Objeto de ambiente.

Corpo: Environment

Criar política de DLP do ambiente

ID da operação:: NewEnvironmentPolicy

Cria uma política de DLP de ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	api-version		string	O valor de data da API.
Ambiente	environment	True	string	Nome do Ambiente.
Nome de Exibição	displayName	True	string	Nome de exibição da Política de API.
Versão do esquema	$schema	True	string	Definição de política de API $schema.
Nome	name	True	string	Campo nome do ambiente de política.
ID	id	True	string	Campo ID do Ambiente de Política.
Tipo	type	True	string	Campo tipo ambiente de política.
Descrição de dados corporativos	description		string	Descrição do grupo de dados de negócios de política.
ID do Conector	id		string	Campo ID do conector de Dados Corporativos.
Nome do Conector	name		string	Campo nome do conector de Dados Corporativos.
Tipo de conector	type		string	Campo de tipo do conector de Dados Corporativos.
Descrição de dados não comerciais	description		string	Descrição do grupo de dados não comercial da política.
ID do Conector	id		string	Campo ID do conector de Dados Não Comerciais.
Nome do Conector	name		string	Campo de nome do conector de Dados Não Corporativos.
Tipo de conector	type		string	Campo de tipo de conector de Dados Não Comerciais.
Grupo Padrão	defaultApiGroup	True	string	Agrupar um novo conector ao qual é adicionado automaticamente.
tipo	type	True	string	Tipo apiGroupRule da regra de política.
apiGrupo	apiGroup	True	string	ApiGroupRule parameter apiGroup da regra de política.
Tipo de ação de bloco	type	True	string	Bloquear o tipo de ação, deixe em branco se não for desejado adicionar um bloco.

Retornos

Corpo: Policy

Criar política DLP de locatário

ID da operação:: NewTenantPolicy

Cria uma nova Política DLP de Locatário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	api-version		string	O valor de data da API.
Nome de Exibição	displayName	True	string	Nome de exibição da Política de API.
Versão do esquema	$schema	True	string	Definição de política de API $schema.
Tipo de restrição	type	True	string	Tipo de restrição de política, deixe em branco para aplicar a política a todos os Ambientes.
Nome	name	True	string	Campo nome do ambiente de política.
ID	id	True	string	Campo ID do Ambiente de Política.
Tipo	type	True	string	Campo tipo ambiente de política.
Tipo de filtro de ambiente	filterType	True	string	FilterType do parâmetro environmentFilter1 da restrição de Política de API.
Descrição de dados corporativos	description		string	Descrição do grupo de dados de negócios de política.
ID do Conector	id		string	Campo ID do conector de Dados Corporativos.
Nome do Conector	name		string	Campo nome do conector de Dados Corporativos.
Tipo de conector	type		string	Campo de tipo do conector de Dados Corporativos.
Descrição de dados não comerciais	description		string	Descrição do grupo de dados não comercial da política.
ID do Conector	id		string	Campo ID do conector de Dados Não Comerciais.
Nome do Conector	name		string	Campo de nome do conector de Dados Não Corporativos.
Tipo de conector	type		string	Campo de tipo de conector de Dados Não Comerciais.
Grupo Padrão	defaultApiGroup	True	string	Agrupar um novo conector ao qual é adicionado automaticamente.
tipo	type	True	string	Tipo apiGroupRule da regra de política.
apiGrupo	apiGroup	True	string	ApiGroupRule parameter apiGroup da regra de política.
Tipo de ação de bloco	type	True	string	Bloquear o tipo de ação, deixe em branco se não for desejado adicionar um bloco.

Retornos

Corpo: Policy

Criar política DLP V2

ID da operação:: CreatePolicyV2

Cria uma nova política DLP.

Parâmetros

Nome	Chave	Obrigatório	Tipo
Nome de exibição	displayName		string
Classificação de conectores padrão	defaultConnectorsClassification		string
classificação	classification	True	string
id	id	True	string
tipo	type	True	string
nome	name	True	string
Tipo de ambiente de política	environmentType		string
id	id	True	string
tipo	type	True	string
nome	name	True	string

Retornos

Corpo: PolicyV2

Editar Atribuição de Função de Ambiente

ID da operação:: Edit-AdminEnvironmentRoleAssignment

Define permissões para um Ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Versão da API	api-version		string	O valor de data da API.
Principal Email	email		string	O email principal do usuário.
ID do locatário principal	tenantId		string	A ID do locatário principal do usuário.
ID do objeto Principal	id		string	A ID do objeto principal do usuário.
Tipo de entidade de segurança	type		string	O tipo principal do usuário.
ID de definição de função	id		string	A ID da definição de função. Formato: /providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/{environment}/{roleName}.
id	id		string	O campo de ID.

Retornos

Corpo: RoleAssignment

Excluir ambiente

ID da operação:: Remove-AdminEnvironment

Exclui um ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Versão da API	api-version		string	O valor de data da API.

Retornos

response: object

Excluir Política de DLP V2

ID da operação:: DeletePolicyV2

Exclui uma política DLP.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Policy	policy	True	string	O campo nome da Política.

Retornos

response: object

Excluir Política DLP de Locatário

ID da operação:: RemoveTenantPolicy

Exclui uma política DLP de locatário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Policy	policy	True	string	O campo nome da Política.
Versão da API	api-version		string	O valor de data da API.

Retornos

response: object

Excluir política DLP do ambiente

ID da operação:: RemoveEnvironmentPolicy

Exclui uma política DLP de ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Policy	policy	True	string	O campo nome da Política.
Versão da API	api-version		string	O valor de data da API.

Retornos

response: object

Forçar usuário de Sincronização

ID da operação:: Add-AdminPowerAppsSyncUser

Usado para sincronizar o usuário do PowerApps com o CRM.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
IdentificadorDeObjeto	ObjectId	True	string	ID do objeto do usuário.
Versão da API	api-version		string	O valor de data da API.

Listar ambientes como administrador

ID da operação:: Get-AdminEnvironment

Retorna uma lista de Ambientes.

Parâmetros

Nome	Chave	Tipo	Description
Versão da API	api-version	string	O valor de data da API.
Ignorar Token	$skiptoken	string	A entrada usada para obter a próxima página da resposta.
Tamanho da página	$top	integer	Número de ambientes na resposta.
Expandir propriedades	$expand	string	Permite o acesso para expandir as propriedades de resposta.

Retornos

Corpo: ResourceArray[Environment]

Listar atribuições de função de ambiente

ID da operação:: Get-AdminEnvironmentRoleAssignment

Retorna uma lista de permissões para um Ambiente sem CDS para Aplicativos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Versão da API	api-version		string	O valor de data da API.

Retornos

Corpo: ResourceArray[RoleAssignment]

Listar conectores desbloqueáveis

ID da operação:: ListUnblockableConnectors

Retorna uma lista de conectores que não podem ser bloqueados com uma política DLP.

Retornos

Nome	Caminho	Tipo
		array of object
id	id	string
desbloqueável	metadata.unblockable	boolean

Listar conectores virtuais

ID da operação:: ListVirtualConnectors

Retorna uma lista de conectores virtuais.

Retornos

Nome	Caminho	Tipo
		array of object
id	id	string
virtualConnector	metadata.virtualConnector	boolean
nome	metadata.name	string
tipo	metadata.type	string
iconUri	metadata.iconUri	string
nome de exibição	metadata.displayName	string

Listar idiomas de ambiente com suporte

ID da operação:: ListEnvironmentLanguages

Retorna uma lista de idiomas com suporte com base no local.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Localização	environmentLocation	True	string	O local do Ambiente.
Versão da API	api-version		string	O valor de data da API.

Retornos

Corpo: Languages

Listar locais com suporte

ID da operação:: ListSupportedLocations

Retorna uma lista de locais em que há suporte para o serviço BAP.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	api-version		string	O valor de data da API.

Retornos

Corpo: Locations

Listar moedas de ambiente com suporte

ID da operação:: ListEnvironmentCurrencies

Retorna uma lista de moedas com suporte com base no local.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Localização	environmentLocation	True	string	O local do Ambiente.
Versão da API	api-version		string	O valor de data da API.

Retornos

Corpo: Currencies

Listar políticas DLP

ID da operação:: Get-AdminDlpPolicies

Retorna uma lista de todas as Políticas DLP de Locatário e Ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Versão da API	api-version		string	O valor de data da API.

Retornos

Corpo: ResourceArray[Policy]

Listar políticas DLP V2

ID da operação:: ListPoliciesV2

Retorna uma lista de todas as políticas DLP que a conta pode acessar.

Retornos

Corpo: ResourceArray[PolicyV2]

Obter o Ambiente como Administrador

ID da operação:: GetSingleEnvironment

Retorna um único Ambiente como Administrador.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Versão da API	api-version		string	O valor de data da API.

Retornos

Objeto de ambiente.

Corpo: Environment

Obter o status da operação do ambiente (versão prévia)

ID da operação:: GetEnvironmentOperation

Usado para verificar o status de uma operação de ambiente, sucn como exclusão.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Operation	operationName	True	string	Nome da operação.
Versão da API	api-version		string	O valor de data da API.

Obter o status da operação do ciclo de vida

ID da operação:: GetLifecycleOperationStatus

Retorna o status atual da operação de ciclo de vida que ocorre após um patch de ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Operação de ciclo de vida	lifecycleOperationId	True	string	A ID da operação de ciclo de vida.
Versão da API	api-version		string	O valor de data da API.

Obter o status de provisionamento de banco de dados

ID da operação:: GetProvisionOperationV2

Usado para verificar o status de uma operação de provisionamento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Operation	operationName	True	string	O nome da operação. Todo esse URI será retornado como o cabeçalho Location de /provisionInstance e incluirá esse valor.
Versão da API	api-version		string	O valor de data da API.

Obter o status de provisionamento do CDS

ID da operação:: GetProvisionOperation

Usado para verificar o status de uma operação de provisionamento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Operation	operationName	True	string	Nome da operação.
Versão da API	api-version		string	O valor de data da API.

Obter política de DLP do ambiente

ID da operação:: GetEnvironmentPolicy

Retorna uma política de DLP de ambiente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Policy	policy	True	string	O campo nome da Política.
Versão da API	api-version		string	O valor de data da API.

Retornos

Corpo: Policy

Obter política de DLP V2

ID da operação:: GetPolicyV2

Retorna uma política DLP.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Policy	policy	True	string	O campo nome da Política.

Retornos

Corpo: PolicyV2

Obter política DLP de locatário

ID da operação:: GetTenantPolicy

Retorna uma política DLP de locatário.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Policy	policy	True	string	O campo nome da Política.
Versão da API	api-version		string	O valor de data da API.

Retornos

Corpo: Policy

Validar exclusão de ambiente

ID da operação:: ValidateDelete

Usado para verificar se um Ambiente pode ser excluído.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Ambiente	environment	True	string	Nome do Ambiente.
Versão da API	api-version		string	O valor de data da API.

Retornos

Corpo: ValidateDeleteResponse

Definições

ResourceArray[Policy]

Nome	Caminho	Tipo	Description
value	value	array of Policy

Policy

Nome	Caminho	Tipo	Description
ID da Política	id	string	Campo ID da política.
Tipo de Política	type	string	Campo tipo de política.
Nome da política	name	string	Campo nome da política.
Nome de Exibição	properties.displayName	string	Nome de exibição da Política de API.
Tempo de criação	properties.createdTime	date-time	Hora de criação da Política de API.
Criado por	properties.createdBy	Principal[CreatedBy]	Política criada pelo objeto principal.
Tempo modificado	properties.lastModifiedTime	date-time	Tempo modificado da Política de API.
Modificado por	properties.lastModifiedBy	Principal[ModifiedBy]	Política modificada pelo objeto principal.
Versão do esquema	properties.definition.$schema	PolicySchema	Definição de política de API $schema.
Tipo	properties.definition.constraints.environmentFilter1.type	string	Tipo de environmentFilter de política.
Environments	properties.definition.constraints.environmentFilter1.parameters.environments	PolicyEnvironments	Ambiente de política.
Tipo de Filtro	properties.definition.constraints.environmentFilter1.parameters.filterType	string	FilterType do parâmetro environmentFilter1 da restrição de Política de API.
apiGroups	properties.definition.apiGroups	PolicyApiGroups
Grupo Padrão	properties.definition.defaultApiGroup	PolicyDefaultApiGroup	Agrupar um novo conector ao qual é adicionado automaticamente.
regras	properties.definition.rules	PolicyRules	Objeto de regras de política.

ResourceArray[PolicyV2]

Nome	Caminho	Tipo	Description
value	value	array of PolicyV2

PolicyV2

Nome	Caminho	Tipo
nome	name	string
nome de exibição	displayName	string
defaultConnectorsClassification	defaultConnectorsClassification	string
connectorGroups	connectorGroups	array of object
classificação	connectorGroups.classification	string
conectores	connectorGroups.connectors	array of object
id	connectorGroups.connectors.id	string
nome	connectorGroups.connectors.name	string
tipo	connectorGroups.connectors.type	string
tipo ambiente	environmentType	string
environments	environments	array of object
id	environments.id	string
tipo	environments.type	string
nome	environments.name	string
id	createdBy.id	string
nome de exibição	createdBy.displayName	string
createdTime	createdTime	string
id	lastModifiedBy.id	string
nome de exibição	lastModifiedBy.displayName	string
hora da última modificação	lastModifiedTime	string
isLegacySchemaVersion	isLegacySchemaVersion	boolean

ResourceArray[Environment]

Nome	Caminho	Tipo	Description
value	value	array of Environment	Matriz de objeto de valor de ambiente.
Próximo Link	nextLink	string	A URL para obter a próxima página da lista Ambientes.

Ambiente

Objeto de ambiente.

Nome	Caminho	Tipo	Description
ID	id	string	Campo ID do ambiente.
Tipo	type	string	Campo tipo de ambiente.
Nome	name	string	Campo nome do ambiente.
Localização	location	string	Campo de localização do ambiente.
Dica de Região do Azure	properties.azureRegionHint	string	Campo AzureRegionHint do ambiente.
Nome de Exibição	properties.displayName	string	Nome de exibição do ambiente.
Hora de Criação	properties.createdTime	date-time	Tempo de Ambiente Criado.
Criado por	properties.createdBy	Principal[CreatedBy]	Política criada pelo objeto principal.
hora da última modificação	properties.lastModifiedTime	date-time	Data e hora do lastModified do ambiente.
Modificado por	properties.lastModifiedBy	Principal[ModifiedBy]	Política modificada pelo objeto principal.
Estado de provisionamento	properties.provisioningState	string	Provisionamento de ambienteState.
capacidade	properties.capacity	array of object
tipo de capacidade	properties.capacity.capacityType	string
actualConsumption	properties.capacity.actualConsumption	number
ratedConsumption	properties.capacity.ratedConsumption	number
capacityUnit	properties.capacity.capacityUnit	string
updatedOn	properties.capacity.updatedOn	string
addons	properties.addons	array of object
tipo de complemento	properties.addons.addonType	string
Alocado	properties.addons.allocated	number
addonUnit	properties.addons.addonUnit	string
Tipo de criação	properties.creationType	string	Tipo de criação de ambiente.
SKU do ambiente	properties.environmentSku	string	ID de SKU do Ambiente.
Tipo de ambiente	properties.environmentType	string	Tipo de ambiente.
É Padrão	properties.isDefault	boolean	É o ambiente padrão ou não.
Plataforma de Aplicativos Empresariais	properties.runtimeEndpoints.microsoft.BusinessAppPlatform	string	Ponto de extremidade de runtime BusinessAppPlatform.
Common Data Model	properties.runtimeEndpoints.microsoft.CommonDataModel	string	Ponto de extremidade de runtime CommonDataModel.
PowerApps	properties.runtimeEndpoints.microsoft.PowerApps	string	Ponto de extremidade de runtime do PowerApps.
Flow	properties.runtimeEndpoints.microsoft.Flow	string	Ponto de extremidade de runtime de fluxo.
Tempo De Exclusão Reversível	properties.softDeletedTime	date-time	Ambiente softDeletedTime.
Tipo	properties.linkedEnvironmentMetadata.type	string	Tipo de Ambiente linkedEnvironmentMetadata.
ID do recurso	properties.linkedEnvironmentMetadata.resourceId	string	Ambiente linkedEnvironmentMetadata resourceId.
Nome amigável	properties.linkedEnvironmentMetadata.friendlyName	string	Ambiente linkedEnvironmentMetadata friendlyName.
Nome Exclusivo	properties.linkedEnvironmentMetadata.uniqueName	string	Ambiente linkedEnvironmentMetadata uniqueName.
Nome de domínio	properties.linkedEnvironmentMetadata.domainName	string	Ambiente linkedEnvironmentMetadata domainName.
Versão	properties.linkedEnvironmentMetadata.version	string	Versão linkedEnvironmentMetadata do ambiente.
URL da Instância	properties.linkedEnvironmentMetadata.instanceUrl	string	Ambiente linkedEnvironmentMetadata instanceUrl.
URL da API de Instância	properties.linkedEnvironmentMetadata.instanceApiUrl	string	Ambiente linkedEnvironmentMetadata instanceApiUrl.
Idioma Base	properties.linkedEnvironmentMetadata.baseLanguage	integer	Ambiente linkedEnvironmentMetadata baseLanguage.
Estado da instância	properties.linkedEnvironmentMetadata.instanceState	string	Ambiente linkedEnvironmentMetadata instanceState.
Hora de Criação	properties.linkedEnvironmentMetadata.createdTime	date-time	Ambiente linkedEnvironmentMetadata createdTime.
Tempo Modificado	properties.linkedEnvironmentMetadata.modifiedTime	date-time	Ambiente linkedEnvironmentMetadata modifiedTime.
Sufixo nome do host	properties.linkedEnvironmentMetadata.hostNameSuffix	string	Ambiente linkedEnvironmentMetadata hostNameSuffix.
ID da solução BAP	properties.linkedEnvironmentMetadata.bapSolutionId	string	Ambiente linkedEnvironmentMetadata bapSolutionId.
Modelos de criação	properties.linkedEnvironmentMetadata.creationTemplates	array of string	Ambiente linkedEnvironmentMetadata creationTemplates.
Versão do pacote de gerenciamento	properties.linkedEnvironmentMetadata.managementPackageVersion	string	Ambiente linkedEnvironmentMetadata managementPackageVersion.

PolicyEnvironments

Ambiente de política.

Nome	Caminho	Tipo	Description
Nome	name	string	Campo nome do ambiente de política.
ID	id	string	Campo ID do Ambiente de Política.
Tipo	type	string	Campo tipo ambiente de política.

PolicyRules

Objeto de regras de política.

Nome	Caminho	Tipo	Description
tipo	apiGroupRule.type	string	Tipo apiGroupRule da regra de política.
apiGrupo	apiGroupRule.parameters.apiGroup	string	ApiGroupRule parameter apiGroup da regra de política.
Tipo de ação de bloco	apiGroupRule.actions.blockAction.type	string	Bloquear o tipo de ação, deixe em branco se não for desejado adicionar um bloco.

PolicySchema

Definição de política de API $schema.

Versão do esquema: string

PolicyApiGroups

Nome	Caminho	Tipo	Description
hbi	hbi	PolicyHbi	Grupo Hbi de política.
lbi	lbi	PolicyLbi

PolicyHbi

Grupo Hbi de política.

Nome	Caminho	Tipo	Description
Descrição de dados corporativos	description	string	Descrição do grupo de dados de negócios de política.
Dados corporativos	apis	array of object	APIs de dados corporativos.
ID do Conector	apis.id	string	Campo ID do conector de Dados Corporativos.
Nome do Conector	apis.name	string	Campo nome do conector de Dados Corporativos.
Tipo de conector	apis.type	string	Campo de tipo do conector de Dados Corporativos.

PolicyLbi

Nome	Caminho	Tipo	Description
Descrição de dados não comerciais	description	string	Descrição do grupo de dados não comercial da política.
Dados não comerciais	apis	array of object	APIs de dados não comerciais.
ID do Conector	apis.id	string	Campo ID do conector de Dados Não Comerciais.
Nome do Conector	apis.name	string	Campo de nome do conector de Dados Não Corporativos.
Tipo de conector	apis.type	string	Campo de tipo de conector de Dados Não Comerciais.

PolicyDefaultApiGroup

Agrupar um novo conector ao qual é adicionado automaticamente.

Grupo Padrão: string

ValidateDeleteResponse

Nome	Caminho	Tipo	Description
Pode excluir	canInitiateDelete	boolean	O ambiente pode ser excluído.
Matriz de erros	errors	array of object	Matriz de erros
Code	errors.error.code	string	Código de erro para validar a exclusão.
Message	errors.error.message	string	Mensagem de erro.
resourcesToBeDeleted	resourcesToBeDeleted	array of object
ID	resourcesToBeDeleted.id	string	Recurso a ser excluído.
Nome	resourcesToBeDeleted.name	string	Recurso a ser excluído.
Tipo	resourcesToBeDeleted.type	string	Recurso a ser excluído.

ResourceArray[RoleAssignment]

Nome	Caminho	Tipo	Description
value	value	array of object	Matriz de objetos de valor de Atribuição de Função de Ambiente.
id	value.id	string	Campo ID da Atribuição de Função de Ambiente.
tipo	value.type	string	Campo Tipo de Atribuição de Função de Ambiente.
nome	value.name	string	Nome do campo Atribuição de Função de Ambiente.
escopo	value.properties.scope	string	Escopo da Atribuição de Função de Ambiente.
id	value.properties.roleDefinition.id	string	Campo ID roleDefinition da Atribuição de Função de Ambiente.
tipo	value.properties.roleDefinition.type	string	Campo de tipo roleDefinition de Atribuição de Função de Ambiente.
nome	value.properties.roleDefinition.name	string	Nome do campo roleDefinition da Atribuição de Função de Ambiente.
id	value.properties.principal.id	string	ID do objeto principal da Atribuição de Função de Ambiente.
nome de exibição	value.properties.principal.displayName	string	DisplayName da entidade de atribuição de função de ambiente.
email	value.properties.principal.email	string	Email principal da Atribuição de Função de Ambiente.
tipo	value.properties.principal.type	string	Tipo de entidade de segurança de Atribuição de Função de Ambiente.

Atribuição de Funções

Nome	Caminho	Tipo	Description
adicionar	add	array of object	Objeto adicionar atribuição de função de ambiente.
id	add.roleAssignment.id	string	Campo ID de atribuição de função de ambiente RoleAssignment.
tipo	add.roleAssignment.type	string	Campo de tipo roleAssignment de Atribuição de Função de Ambiente.
nome	add.roleAssignment.name	string	Campo nome roleAssignment da Atribuição de Função de Ambiente.
escopo	add.roleAssignment.properties.scope	string	Escopo da Atribuição de Função de Ambiente.
id	add.roleAssignment.properties.roleDefinition.id	string	Campo ID roleDefinition da Atribuição de Função de Ambiente.
tipo	add.roleAssignment.properties.roleDefinition.type	string	Campo ID roleDefinition da Atribuição de Função de Ambiente.
nome	add.roleAssignment.properties.roleDefinition.name	string	Campo de nome roleDefinition da Atribuição de Função de Ambiente.
id	add.roleAssignment.properties.principal.id	string	ID do objeto principal da Atribuição de Função de Ambiente.
nome de exibição	add.roleAssignment.properties.principal.displayName	string	DisplayName da entidade de atribuição de função de ambiente.
email	add.roleAssignment.properties.principal.email	string	Email principal da Atribuição de Função de Ambiente.
tipo	add.roleAssignment.properties.principal.type	string	Tipo de entidade de segurança de Atribuição de Função de Ambiente.
httpStatus	add.httpStatus	string	Atribuição de Função de Ambiente httpStatus.

Principal[ModifiedBy]

Política modificada pelo objeto principal.

Nome	Caminho	Tipo	Description
ID	id	string	Modificado pela ID do objeto principal.
Nome de exibição	displayName	string	Modificado pelo displayName principal.
Email	email	string	Modificado por entidade de segurança.
Tipo	type	string	Modificado por tipo de entidade de segurança.
ID do locatário	tenantId	string	Modificado pela ID do locatário principal.
UPN	userPrincipalName	string	Modificado por userPrincipalName.

Principal[CreatedBy]

Política criada pelo objeto principal.

Nome	Caminho	Tipo	Description
ID	id	string	ID do objeto principal do criador da API Policy.
Nome de exibição	displayName	string	DisplayName da entidade de segurança do criador da Política de API.
Email	email	string	Email da entidade de segurança do criador da Política de API.
Tipo	type	string	Tipo de entidade de segurança do criador da Política de API.
ID do locatário	tenantId	string	ID do locatário da entidade de segurança do criador da Política de API.
UPN	userPrincipalName	string	UserPrincipalName, criador da Política de API.

Localizações

Nome	Caminho	Tipo	Description
value	value	array of object
ID	value.id	string	ID do local.
Nome	value.name	string	Nome da localização.
Nome de Exibição	value.properties.displayName	string	Nome de exibição do local.
É Padrão	value.properties.isDefault	boolean	É o local padrão.
Está desabilitado	value.properties.isDisabled	boolean	O local está desabilitado.

Moedas

Nome	Caminho	Tipo	Description
value	value	array of object
ID	value.id	string	ID da moeda.
Nome	value.name	string	Nome da moeda.
ID da localidade	value.properties.localeId	integer	ID de localidade da moeda.
Nome localizado	value.properties.localizedName	string	Nome localizado da moeda.
Nome de Exibição	value.properties.displayName	string	Nome de exibição de moeda.

Languages

Nome	Caminho	Tipo	Description
value	value	array of object
Nome	value.name	string	Campo Nome do idioma.
ID	value.id	string	Campo ID do idioma.
Tipo	value.type	string	Campo tipo de linguagem.
ID da localidade	value.properties.localeId	integer	Campo ID da localidade do idioma.
Nome localizado	value.properties.localizedName	string	Campo de nome localizado no idioma.
Nome de Exibição	value.properties.displayName	string	Campo nome de exibição de idioma.
É o padrão do locatário	value.properties.isTenantDefault	boolean	O idioma é o campo padrão do locatário.

objeto

Esse é o tipo 'object'.

Compartilhar via

Power Platform para Administradores

Pré-requisitos

Problemas e limitações conhecidos

Limitações

Ações

Atualizar ambiente

Parâmetros

Atualizar política DLP de locatário

Parâmetros

Retornos

Atualizar política DLP do ambiente

Parâmetros

Retornos

Atualizar política DLP V2

Parâmetros

Retornos

Criar ambiente

Parâmetros

Retornos

Criar banco de dados CDS

Parâmetros

Retornos

Criar política de DLP do ambiente

Parâmetros

Retornos

Criar política DLP de locatário

Parâmetros

Retornos

Criar política DLP V2

Parâmetros

Retornos

Editar Atribuição de Função de Ambiente

Parâmetros

Retornos

Excluir ambiente

Parâmetros

Retornos

Excluir Política de DLP V2

Parâmetros

Retornos

Excluir Política DLP de Locatário

Parâmetros

Retornos

Excluir política DLP do ambiente

Parâmetros

Retornos

Forçar usuário de Sincronização

Parâmetros

Listar ambientes como administrador

Parâmetros

Retornos

Listar atribuições de função de ambiente

Parâmetros

Retornos

Listar conectores desbloqueáveis

Retornos

Listar conectores virtuais

Retornos

Listar idiomas de ambiente com suporte

Parâmetros

Retornos

Listar locais com suporte

Parâmetros

Retornos

Listar moedas de ambiente com suporte

Parâmetros

Retornos

Listar políticas DLP

Parâmetros

Retornos

Listar políticas DLP V2

Retornos

Obter o Ambiente como Administrador

Parâmetros

Retornos

Obter o status da operação do ambiente (versão prévia)

Parâmetros

Obter o status da operação do ciclo de vida

Parâmetros