Invoke-ASCmd

Módulo:

SqlServer Module

Permite que os administradores de banco de dados executem um script XMLA, um script TMSL, uma consulta DAX (Data Analysis Expressions), uma consulta MDX (Expressões Multidimensionais) ou uma instrução DMX (Data Mining Extensions) em uma instância do Analysis Services.

Sintaxe

QuerySet (Padrão)

Invoke-ASCmd
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ParameterSetName

Invoke-ASCmd
    [-Database <String>]
    [-Query <String>]
    [-ConnectionString <String>]
    [-QueryTimeout <Int32>]
    [-ConnectionTimeout <Int32>]
    [-TraceFile <String>]
    [-Variables <String[]>]
    [-TraceTimeout <Int32>]
    [-TraceLevel <TraceLevelOption>]
    [-TraceFileFormat <TraceFileFormatOption>]
    [-TraceFileDelimiter <String>]
    [-Server <String>]
    [-Credential <PSCredential>]
    [-ServicePrincipal]
    [-ApplicationId <String>]
    [-TenantId <String>]
    [-CertificateThumbprint <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ParameterSetInputObject

Invoke-ASCmd
    [-Database <String>]
    [-ConnectionString <String>]
    [-InputFile <String>]
    [-QueryTimeout <Int32>]
    [-ConnectionTimeout <Int32>]
    [-TraceFile <String>]
    [-Variables <String[]>]
    [-TraceTimeout <Int32>]
    [-TraceLevel <TraceLevelOption>]
    [-TraceFileFormat <TraceFileFormatOption>]
    [-TraceFileDelimiter <String>]
    [-Server <String>]
    [-Credential <PSCredential>]
    [-ServicePrincipal]
    [-ApplicationId <String>]
    [-TenantId <String>]
    [-CertificateThumbprint <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ParameterSetTabularName

Invoke-ASCmd
    [-Server <String>]
    [-Credential <PSCredential>]
    [-ServicePrincipal]
    [-ApplicationId <String>]
    [-TenantId <String>]
    [-CertificateThumbprint <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ParameterSetTabularInputObject

Invoke-ASCmd
    [-Server <String>]
    [-Credential <PSCredential>]
    [-ServicePrincipal]
    [-ApplicationId <String>]
    [-TenantId <String>]
    [-CertificateThumbprint <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Permite que os administradores de banco de dados executem um script XMLA, um script TMSL, uma consulta DAX (Data Analysis Expressions), uma consulta MDX (Expressões Multidimensionais) ou uma instrução DMX (Data Mining Extensions) em uma instância do Analysis Services.

A execução de cmdlets dessas consultas ou scripts em arquivos de entrada.

O script que é passado é um comando XMLA e há suporte para os seguintes comandos: Alter, Backup, Lote, BeginTransaction, Cancel, ClearCache, CommitTransaction, Create, Delete, DesignAggregations, Drop, Insert, Lock, MergePartitions, NotifyTableChange, Process, Restore, RollbackTransaction, Statement (usado para executar consultas MDX e instruções DMX), Assinar, Sincronizar, Desbloquear, Atualizar, AtualizarCells.

Esse script também aceitará comandos JSON projetados para executar em um banco de dados tabular com o modo de compatibilidade 1200 ou superior.

Module requirements: version 21+ on PowerShell 5.1; version 21 (recent preview) or version 22+ on PowerShell 7.x.

Exemplos

Invocar descoberta

Invoke-ASCmd -Server:localhost -Query "<Discover xmlns='urn:schemas-microsoft-com:xml-analysis'><RequestType>DBSCHEMA_CATALOGS</RequestType><Restrictions /><Properties /></Discover>"

Invocar descoberta 2

Invoke-ASCmd -Database "Adventure Works DW 2008R2" -Query "<Discover xmlns='urn:schemas-microsoft-com:xml-analysis'><RequestType>DISCOVER_DATASOURCES</RequestType><Restrictions></Restrictions><Properties></Properties></Discover>"

Invocar seleção

Invoke-ASCmd -Database "Adventure Works DW 2008R2" -Query "SELECT {[Measures].[Internet Sales Amount]} ON COLUMNS, BOTTOMCOUNT(NONEMPTY(DESCENDANTS( [Customer].[Customer Geography].[All Customers], [Customer].[Customer Geography].[Customer]), ( [Measures].[Internet Sales Amount] ) ), 10, ( [Measures].[Internet Sales Amount] )) ON ROWS FROM [Adventure Works] WHERE ( [Date].[Calendar].[Calendar Year].&[2008] )"

Invocar seleção 2

Invoke-ASCmd -Database "Adventure Works DW 2008R2" -Query "SELECT MODEL_CATALOG, MODEL_NAME, ATTRIBUTE_NAME, NODE_NAME FROM [Forecasting].CONTENT"

Invocar com o arquivo xmla

Invoke-ASCmd -InputFile C:\MyFolder\DiscoverConnections.xmla

<# DiscoverConnections.xmla is as follows:

 <Discover xmlns="urn:schemas-microsoft-com:xml-analysis">
   <RequestType>DISCOVER_CONNECTIONS</RequestType>
   <Restrictions />
   <Properties>
     <PropertyList>
       <Content>Data</Content>
     </PropertyList>
   </Properties>
 </Discover>

#>

Parâmetros

-ApplicationId

A ID do aplicativo para a entidade de serviço.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-CertificateThumbprint

A impressão digital do certificado para a entidade de serviço.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	cf

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-ConnectionString

Especifica a cadeia de conexão.

Observe que outras propriedades de nível de conexão, como Servidor, Banco de Dados etc. são ignoradas quando essa propriedade é especificada e, portanto, essas propriedades devem ser incluídas na cadeia de conexão.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-ConnectionTimeout

Especifica o número de segundos antes do tempo limite da conexão com a instância do Analysis Services. O valor de tempo limite deve ser um inteiro entre 0 e 65534. Se 0 for especificado, as tentativas de conexão não chegarão ao tempo limite.

Propriedades do parâmetro

Tipo:	Int32
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Credential

Se esse parâmetro for especificado, o nome de usuário e a senha passados serão usados para se conectar à instância especificada do Analysis Server. Se nenhuma credencial for especificada, a conta do Windows padrão do usuário que está executando a ferramenta será usada.

Propriedades do parâmetro

Tipo:	PSCredential
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Database

Especifica o banco de dados no qual uma consulta MDX ou instrução DMX será executada. O parâmetro de banco de dados é ignorado quando o cmdlet executa um script XMLA, porque o nome do banco de dados é inserido no script XMLA.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-InputFile

Identifica o arquivo que contém o script XMLA, a consulta MDX, a instrução DMX ou o script TMSL (em JSON). Você deve especificar um valor para o InputFile ou o parâmetro *Query *ao usar Invoke-AsCmd.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Query

Especifica o script, a consulta ou a instrução real diretamente na linha de comando em vez de em um arquivo.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-QueryTimeout

Especifica o número de segundos antes do tempo limite das consultas. Se um valor de tempo limite não for especificado, as consultas não perderão tempo limite. O tempo limite deve ser um inteiro entre 1 e 65535.

Propriedades do parâmetro

Tipo:	Int32
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Server

Opcionalmente, especifica a instância do servidor à qual se conectar se não estiver atualmente no diretório do Provedor do SQLAS.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-ServicePrincipal

Especifica que essa conexão está usando a entidade de serviço.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-TenantId

A ID do locatário da entidade de serviço.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetTabularInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-TraceFile

Identifica um arquivo que recebe eventos de rastreamento do Analysis Services durante a execução do script XMLA, da consulta MDX ou da instrução DMX. Se o arquivo já existir, ele será substituído automaticamente (exceto pelos arquivos de rastreamento criados usando as configurações de parâmetro -TraceLevel:Duration e -TraceLevel:DurationResult).

Os nomes de arquivo que contêm espaços devem ser colocados entre aspas ("").

Se o nome do arquivo não for válido, uma mensagem de erro será gerada.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-TraceFileDelimiter

Especifica um único caractere como delimitador de arquivo de rastreamento quando você especifica o csv como o formato do arquivo de rastreamento que usa o parâmetro -TraceFileFormat.

O padrão é | (pipe ou barra vertical).

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-TraceFileFormat

Especifica o formato de arquivo para o parâmetro -TraceFile (se esse parâmetro for especificado).

O valor padrão é "Csv".

Propriedades do parâmetro

Tipo:	TraceFileFormatOption
Valor padrão:	None
Valores aceitos:	Csv, Text
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-TraceLevel

Especifica quais dados são coletados e registrados no arquivo de rastreamento. Os valores possíveis são Alto, Médio, Baixo, Duração, DurationResult.

Propriedades do parâmetro

Tipo:	TraceLevelOption
Valor padrão:	None
Valores aceitos:	High, Medium, Low, Duration, DurationResult
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-TraceTimeout

Especifica o número de segundos que o mecanismo do Analysis Services aguarda antes de encerrar o rastreamento (se você especificar o parâmetro -TraceFile).

O rastreamento será considerado concluído se nenhuma mensagem de rastreamento tiver sido registrada durante o período de tempo especificado.

O valor de tempo limite de rastreamento padrão é de 5 segundos.

Propriedades do parâmetro

Tipo:	Int32
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Variables

Especifica variáveis de script adicionais. Cada variável é um par nome-valor. Se o valor contiver espaços inseridos ou caracteres de controle, ele deverá ser colocado entre aspas duplas. Use uma matriz do PowerShell para especificar várias variáveis e seus valores.

Propriedades do parâmetro

Tipo:	String[]
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ParameterSetName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ParameterSetInputObject

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	wi

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSObject

Saídas

string