az synapse workspace key

Управление ключами рабочей области.

Команды

Имя Описание Тип Состояние
az synapse workspace key create

Создайте ключ рабочей области.

 Core GA
az synapse workspace key delete

Удалите ключ рабочей области. Невозможно удалить ключ при активном состоянии.

 Core GA
az synapse workspace key list

Список ключей в указанной рабочей области.

 Core GA
az synapse workspace key show

Отображение ключа рабочей области по имени.

 Core GA
az synapse workspace key wait

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие ключа рабочей области.

 Core GA

az synapse workspace key create

Изменить

Создайте ключ рабочей области.

az synapse workspace key create --key-identifier
                                --name
                                --resource-group
                                --workspace-name
                                [--acquire-policy-token]
                                [--change-reference]
                                [--no-wait]

Примеры

Создайте ключ рабочей области.

az synapse workspace key create --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}

Обязательные параметры

--key-identifier

URL-адрес Key Vault ключа шифрования рабочей области. должен быть в формате: https://{keyvaultname}.vault.azure.net/keys/{keyname}.

--name -n

Отображаемое имя ключа, управляемого клиентом рабочей области. Все существующие ключи можно найти с помощью командлета /"az synapse workspace key list/".

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--workspace-name

Имя рабочей области.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse workspace key delete

Изменить

Удалите ключ рабочей области. Невозможно удалить ключ при активном состоянии.

az synapse workspace key delete [--acquire-policy-token]
                                [--change-reference]
                                [--ids]
                                [--name]
                                [--no-wait]
                                [--resource-group]
                                [--subscription]
                                [--workspace-name]
                                [--yes]

Примеры

Удалите ключ рабочей области.

az synapse workspace key delete --name newkey --workspace-name testsynapseworkspace \
--resource-group rg

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--name -n

Отображаемое имя ключа, управляемого клиентом рабочей области. Все существующие ключи можно найти с помощью командлета /"az synapse workspace key list/".

Свойство Значение
Группа параметров: Resource Id Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Группа параметров: Resource Id Arguments
--workspace-name

Имя рабочей области.

Свойство Значение
Группа параметров: Resource Id Arguments
--yes -y

Не запрашивать подтверждение.

Свойство Значение
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse workspace key list

Изменить

Список ключей в указанной рабочей области.

az synapse workspace key list --resource-group
                              --workspace-name

Примеры

Список ключей в указанной рабочей области.

az synapse workspace key list --workspace-name testsynapseworkspace --resource-group rg

Обязательные параметры

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--workspace-name

Имя рабочей области.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse workspace key show

Изменить

Отображение ключа рабочей области по имени.

az synapse workspace key show [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]
                              [--workspace-name]

Примеры

Отображение ключа рабочей области.

az synapse workspace key show --name newkey --workspace-name testsynapseworkspace \
--resource-group rg

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--name -n

Отображаемое имя ключа, управляемого клиентом рабочей области. Все существующие ключи можно найти с помощью командлета /"az synapse workspace key list/".

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Группа параметров: Resource Id Arguments
--workspace-name

Имя рабочей области.

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az synapse workspace key wait

Изменить

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие ключа рабочей области.

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

Обязательные параметры

--key-name

Имя ключа рабочей области.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

Свойство Значение
Группа параметров: Wait Condition Arguments
--deleted

Дождитесь удаления.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--exists

Подождите, пока ресурс не существует.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--interval

Интервал опроса в секундах.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: 30
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Группа параметров: Resource Id Arguments
--timeout

Максимальное ожидание в секундах.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--workspace-name

Имя рабочей области.

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False