Partilhar via


az cosmosdb sql user-defined-function

Gerir funções definidas pelo utilizador no Azure Cosmos DB SQL.

Comandos

Name Description Tipo Status
az cosmosdb sql user-defined-function create

Crie uma função SQL definida pelo utilizador sob um contentor SQL do Azure Cosmos DB.

Core disponibilidade geral
az cosmosdb sql user-defined-function delete

Elimine a função SQL definida pelo utilizador sob um contentor SQL do Azure Cosmos DB.

Core disponibilidade geral
az cosmosdb sql user-defined-function list

Liste as funções SQL definidas pelo utilizador num contentor SQL do Azure Cosmos DB.

Core disponibilidade geral
az cosmosdb sql user-defined-function show

Mostre os detalhes de uma função SQL definida pelo utilizador num contentor SQL do Azure Cosmos DB.

Core disponibilidade geral
az cosmosdb sql user-defined-function update

Cria ou atualiza uma função definida pelo utilizador no Azure Cosmos DB SQL.

Core disponibilidade geral

az cosmosdb sql user-defined-function create

Crie uma função SQL definida pelo utilizador sob um contentor SQL do Azure Cosmos DB.

az cosmosdb sql user-defined-function create --account-name
                                             --body
                                             --container-name
                                             --database-name
                                             --name
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]

Exemplos

Crie uma função definida pelo utilizador no Azure Cosmos DB SQL.

az cosmosdb sql user-defined-function create -g MyResourceGroup -a MyAccount -d MyDatabase -c MyContainer -n MyUserDefinedFunction -b UserDefinedFunctionBody

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--body -b

UserDefinedFunction body, você pode inseri-lo como uma cadeia de caracteres ou como um arquivo, por exemplo, --body @udfbody-file.json.

--container-name -c

Nome do contêiner.

--database-name -d

Nome do banco de dados.

--name -n

Nome UserDefinedFunction.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql user-defined-function delete

Elimine a função SQL definida pelo utilizador sob um contentor SQL do Azure Cosmos DB.

az cosmosdb sql user-defined-function delete --account-name
                                             --container-name
                                             --database-name
                                             --name
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]
                                             [--yes]

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--container-name -c

Nome do contêiner.

--database-name -d

Nome do banco de dados.

--name -n

Nome UserDefinedFunction.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql user-defined-function list

Liste as funções SQL definidas pelo utilizador num contentor SQL do Azure Cosmos DB.

az cosmosdb sql user-defined-function list --account-name
                                           --container-name
                                           --database-name
                                           --resource-group

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--container-name -c

Nome do contêiner.

--database-name -d

Nome do banco de dados.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql user-defined-function show

Mostre os detalhes de uma função SQL definida pelo utilizador num contentor SQL do Azure Cosmos DB.

az cosmosdb sql user-defined-function show --account-name
                                           --container-name
                                           --database-name
                                           --name
                                           --resource-group

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--container-name -c

Nome do contêiner.

--database-name -d

Nome do banco de dados.

--name -n

Nome UserDefinedFunction.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az cosmosdb sql user-defined-function update

Cria ou atualiza uma função definida pelo utilizador no Azure Cosmos DB SQL.

az cosmosdb sql user-defined-function update --account-name
                                             --body
                                             --container-name
                                             --database-name
                                             --name
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]

Parâmetros Obrigatórios

--account-name -a

Nome da conta Cosmosdb.

--body -b

UserDefinedFunction body, você pode inseri-lo como uma cadeia de caracteres ou como um arquivo, por exemplo, --body @udfbody-file.json.

--container-name -c

Nome do contêiner.

--database-name -d

Nome do banco de dados.

--name -n

Nome UserDefinedFunction.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False