Partilhar via


az durabletask scheduler

Note

Esta referência faz parte da extensão durabletask para o CLI do Azure (versão 2.75.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az durabletask scheduler. Saiba mais sobre extensões.

Comandos para gerenciar agendadores de tarefas duráveis.

Comandos

Name Description Tipo Status
az durabletask scheduler attach

[Experimental] Anexe um agendador de tarefas durável a uma aplicação de funções ou a uma aplicação de contentores.

Extension disponibilidade geral
az durabletask scheduler create

Crie um Agendador.

Extension disponibilidade geral
az durabletask scheduler delete

Exclua um Agendador.

Extension disponibilidade geral
az durabletask scheduler list

Listar Agendadores por assinatura.

Extension disponibilidade geral
az durabletask scheduler show

Obtenha um agendador.

Extension disponibilidade geral
az durabletask scheduler update

Atualize um Agendador.

Extension disponibilidade geral
az durabletask scheduler wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

Extension disponibilidade geral

az durabletask scheduler attach

[Experimental] Anexe um agendador de tarefas durável a uma aplicação de funções ou a uma aplicação de contentores.

Este comando é experimental e pode mudar em futuras versões.

Atribui um papel de Tarefa Durável à identidade gerida do recurso alvo e configura as definições de aplicação ou variáveis de ambiente do destino com o endpoint do escalonador do escalonador e o nome do hub de tarefas.

az durabletask scheduler attach --name
                                --resource-group
                                --role-type {contributor, reader, worker}
                                --target
                                --task-hub-name
                                [--acquire-policy-token]
                                [--change-reference]
                                [--identity]

Exemplos

Anexe um agendador a uma aplicação de funções com a função Trabalhador

az durabletask scheduler attach -g myResourceGroup -n myScheduler \
    --task-hub-name myTaskHub --role-type worker \
    --target /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Web/sites/myFunctionApp

Anexe um agendador a uma aplicação contentor com a função de Contribuidor de Dados

az durabletask scheduler attach -g myResourceGroup -n myScheduler \
    --task-hub-name myTaskHub --role-type contributor \
    --target /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.App/containerApps/myContainerApp

Anexar usando uma identidade gerida atribuída pelo utilizador

az durabletask scheduler attach -g myResourceGroup -n myScheduler \
    --task-hub-name myTaskHub --role-type worker \
    --target /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.Web/sites/myFunctionApp \
    --identity /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity

Parâmetros Obrigatórios

--name -n

Nome do Agendador de Tarefas Duradouras.

--resource-group -g

Nome do grupo de recursos que contém o planificador.

--role-type

O tipo de função a atribuir à identidade gerida do alvo.

Propriedade Valor
Valores aceites: contributor, reader, worker
--target -t

ID de recurso da aplicação de função alvo ou aplicação de contentor.

--task-hub-name

Nome do centro de tarefas da Tarefa Durável.

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
--identity

ID de recurso de uma identidade gerida atribuída pelo utilizador. Se omitido, é utilizada a identidade gerida atribuída pelo sistema.

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 durabletask scheduler create

Crie um Agendador.

az durabletask scheduler create --name
                                --resource-group
                                [--acquire-policy-token]
                                [--change-reference]
                                [--ip-allowlist]
                                [--location]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--public-network-access {Disabled, Enabled}]
                                [--sku-capacity]
                                [--sku-name {Consumption, Dedicated}]
                                [--tags]

Exemplos

Criar um agendador no eastus

az durabletask scheduler create --resource-group testrg --name testscheduler --location eastus --ip-allowlist "[0.0.0.0/0]" --sku-capacity 1, --sku-name "Dedicated" --tags "{}"

Crie um agendador de SKU de Consumo com o acesso à rede pública desativado

az durabletask scheduler create --resource-group rgopenapi --name testscheduler --location northcentralus --sku-name "Consumption" --public-network-access Disabled  --tags "{department:research,development:true}"

Parâmetros Obrigatórios

--name -n

O nome do Agendador.

--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
--ip-allowlist

Lista de permissões de IP para agendador de tarefas durável. Os valores podem ser IPv4, IPv6 ou CIDR Suporte taquigrafia-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Default value: []
--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--public-network-access

Permitir ou proibir o acesso da rede pública ao agendador de tarefas duradouro.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: Disabled, Enabled
--sku-capacity

A capacidade de SKU. Isso permite o dimensionamento/entrada para o recurso e impacta a redundância da zona.

Propriedade Valor
Grupo de parâmetros: Sku Arguments
--sku-name

O nome do SKU.

Propriedade Valor
Grupo de parâmetros: Sku Arguments
Valores aceites: Consumption, Dedicated
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource 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 durabletask scheduler delete

Exclua um Agendador.

az durabletask scheduler delete [--acquire-policy-token]
                                [--change-reference]
                                [--ids]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--resource-group]
                                [--subscription]
                                [--yes]

Exemplos

Excluir um agendador

az durabletask scheduler delete --resource-group testrg --name testscheduler

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
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

O nome do Agendador.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id 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.

--verbose

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

Propriedade Valor
Default value: False

az durabletask scheduler list

Listar Agendadores por assinatura.

az durabletask scheduler list [--max-items]
                              [--next-token]
                              [--resource-group]

Exemplos

Listar todos os agendadores em um grupo de recursos

az durabletask scheduler list -g testrg

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.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--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 durabletask scheduler show

Obtenha um agendador.

az durabletask scheduler show [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Exemplos

Mostrar informações sobre um agendador específico

az durabletask scheduler show --resource-group testrg --name testscheduler

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.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

O nome do Agendador.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id 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.

--verbose

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

Propriedade Valor
Default value: False

az durabletask scheduler update

Atualize um Agendador.

az durabletask scheduler update [--acquire-policy-token]
                                [--add]
                                [--change-reference]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--ip-allowlist]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--public-network-access {Disabled, Enabled}]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--sku-capacity]
                                [--sku-name {Consumption, Dedicated}]
                                [--subscription]
                                [--tags]

Exemplos

Atualize a lista de IP e as etiquetas de um agendador

az durabletask scheduler update --resource-group testrg --name testscheduler --ip-allowlist "[0.0.0.0/0]" --tags "{department:research}"

Atualize um agendador para desativar o acesso à rede pública

az durabletask scheduler update --resource-group testrg --name testscheduler --public-network-access Disabled

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
--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade Valor
Grupo de parâmetros: Generic Update 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
--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ip-allowlist

Lista de permissões de IP para agendador de tarefas durável. Os valores podem ser IPv4, IPv6 ou CIDR Suporte taquigrafia-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--name -n

O nome do Agendador.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--public-network-access

Permitir ou proibir o acesso da rede pública ao agendador de tarefas duradouro.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: Disabled, Enabled
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
--sku-capacity

A capacidade de SKU. Isso permite o dimensionamento/entrada para o recurso e impacta a redundância da zona.

Propriedade Valor
Grupo de parâmetros: Sku Arguments
--sku-name

O nome do SKU.

Propriedade Valor
Grupo de parâmetros: Sku Arguments
Valores aceites: Consumption, Dedicated
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource 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.

--verbose

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

Propriedade Valor
Default value: False

az durabletask scheduler wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az durabletask scheduler wait [--acquire-policy-token]
                              [--change-reference]
                              [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--name]
                              [--resource-group]
                              [--subscription]
                              [--timeout]
                              [--updated]

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
--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 30
--name -n

O nome do Agendador.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
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.

--verbose

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

Propriedade Valor
Default value: False