az synapse workspace

Ссылка

Управление рабочими областями Synapse.

Команды

Имя	Описание	Тип	Состояние
az synapse workspace activate	Активирует рабочую область и изменяет его состояние от ожидания до состояния успешности при первой подготовке рабочей области и двойном шифровании.	Ядро	ГА
az synapse workspace check-name	Проверьте, доступно ли имя рабочей области Synapse.	Ядро	ГА
az synapse workspace create	Создайте рабочую область Synapse.	Ядро	ГА
az synapse workspace delete	Удаление рабочей области Synapse.	Ядро	ГА
az synapse workspace firewall-rule	Управление правилами брандмауэра рабочей области.	Ядро	ГА
az synapse workspace firewall-rule create	Создайте правило брандмауэра.	Ядро	ГА
az synapse workspace firewall-rule delete	Удаление правила брандмауэра.	Ядро	ГА
az synapse workspace firewall-rule list	Список всех правил брандмауэра.	Ядро	ГА
az synapse workspace firewall-rule show	Получите правило брандмауэра.	Ядро	ГА
az synapse workspace firewall-rule update	Обновление правила брандмауэра.	Ядро	ГА
az synapse workspace firewall-rule wait	Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие правила брандмауэра.	Ядро	ГА
az synapse workspace key	Управление ключами рабочей области.	Ядро	ГА
az synapse workspace key create	Создайте ключ рабочей области.	Ядро	ГА
az synapse workspace key delete	Удалите ключ рабочей области. Невозможно удалить ключ при активном состоянии.	Ядро	ГА
az synapse workspace key list	Список ключей в указанной рабочей области.	Ядро	ГА
az synapse workspace key show	Отображение ключа рабочей области по имени.	Ядро	ГА
az synapse workspace key wait	Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие ключа рабочей области.	Ядро	ГА
az synapse workspace list	Список всех рабочих областей Synapse.	Ядро	ГА
az synapse workspace managed-identity	Управление управляемым удостоверением рабочей области.	Ядро	ГА
az synapse workspace managed-identity grant-sql-access	Предоставление sql-доступа рабочей области к управляемому удостоверению.	Ядро	ГА
az synapse workspace managed-identity revoke-sql-access	Отмените sql-доступ рабочей области к управляемому удостоверению.	Ядро	ГА
az synapse workspace managed-identity show-sql-access	Отображение состояния sql-доступа рабочей области к управляемому удостоверению.	Ядро	ГА
az synapse workspace managed-identity wait	Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие состояния доступа к управляемому удостоверению.	Ядро	ГА
az synapse workspace show	Получите рабочую область Synapse.	Ядро	ГА
az synapse workspace update	Обновите рабочую область Synapse.	Ядро	ГА
az synapse workspace wait	Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие рабочей области.	Ядро	ГА

az synapse workspace activate

Изменить

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

При создании рабочей области Azure Synapse Analytics можно зашифровать все неактивных данных в рабочей области с помощью ключа, управляемого клиентом, который обеспечит двойное шифрование рабочей области. Сначала может потребоваться настроить среду шифрования, например создать хранилище ключей с защитой очистки и указать полиции доступа в хранилище ключей. Затем используйте этот командлет для активации новой рабочей области Azure Synapse Analytics, которая включает двойное шифрование с помощью ключа, управляемого клиентом.

az synapse workspace activate --key-identifier
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--subscription]
                              [--workspace-name]

Примеры

активируйте рабочую область.

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

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

--key-identifier

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

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

--ids

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

--name -n

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

--no-wait

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

Default value: False

--resource-group -g

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

--subscription

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

--workspace-name

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

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

--debug

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

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az synapse workspace check-name

Изменить

Проверьте, доступно ли имя рабочей области Synapse.

az synapse workspace check-name --name

Примеры

Проверьте, доступно ли имя рабочей области Synapse.

az synapse workspace check-name --name testsynapseworkspace

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

--name -n

Имя, который вы хотите проверить.

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

--debug

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

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az synapse workspace create

Изменить

Создайте рабочую область Synapse.

az synapse workspace create --file-system
                            --name
                            --resource-group
                            --sql-admin-login-password
                            --sql-admin-login-user
                            --storage-account
                            [--account-name]
                            [--allowed-tenant-ids]
                            [--cmk]
                            [--collaboration-branch]
                            [--enable-managed-virtual-network {false, true}]
                            [--host-name]
                            [--key-name]
                            [--last-commit-id]
                            [--location]
                            [--managed-rg-name]
                            [--no-wait]
                            [--prevent-data-exfiltration {false, true}]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--root-folder]
                            [--tags]
                            [--tenant-id]
                            [--uami-id]
                            [--uami-id-in-encrypt]
                            [--use-sami-in-encrypt]

Примеры

Создание рабочей области Synapse

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

Создание рабочей области Synapse с идентификатором ресурса хранилища

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

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

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname} --key-name testcmk \
  --use-sami-in-encrypt True

Создание рабочей области Synapse, подключающейся к azure devops

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --repository-type AzureDevOpsGit --account-name testuser --project-name testprj \
  --repository-name testrepo --collaboration-branch main --last-commit-id 000000

Создание рабочей области Synapse с управляемой группой ресурсов

az synapse workspace create --name testworkspace --resource-group rg \
  --managed-rg-name managedrg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"

Создание рабочей области Synapse с назначенным пользователем управляемым удостоверением

az synapse workspace create --name testworkspace --resource-group rg \
  --storage-account testadlsgen2 --file-system testfilesystem \
  --sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
  --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

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

--file-system

Файловая система учетной записи хранения озера данных.

--name -n

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

--resource-group -g

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

--sql-admin-login-password -p

Пароль для входа администратора SQL.

--sql-admin-login-user -u

Имя пользователя для входа администратора SQL.

--storage-account

Имя учетной записи хранения озера данных или идентификатор ресурса.

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

--account-name

Имя учетной записи GitHub, используемое для репозитория или имени организации Azure devops.

--allowed-tenant-ids

Утвержденные клиенты Azure AD, которым разрешен исходящий трафик данных. Клиент Azure AD текущего пользователя будет включен по умолчанию. Используйте "" или "" ("" в PowerShell), чтобы отключить все разрешенные идентификаторы клиента.

--cmk --key-identifier

Управляемый клиентом ключ, используемый для шифрования всех неактивных данных в рабочей области. Идентификатор ключа должен быть в формате: https://{keyvaultname}.vault.azure.net/keys/{keyname}.

--collaboration-branch

Имя ветви, в которой вы будете сотрудничать с другими пользователями и откуда будете публиковаться.

--enable-managed-virtual-network --enable-managed-vnet

Флаг указывает, включена ли управляемая виртуальная сеть.

Допустимые значения: false, true

--host-name

Если используется github Enterprise Server, укажите URL-адрес сервера. Не используйте этот параметр в GitHub Enterprise Cloud.

--key-name

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

Default value: default

--last-commit-id

Последний идентификатор фиксации.

--location -l

Местоположение. Значения из: az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--managed-rg-name

Управляемая рабочая область группы ресурсов. Имя группы ресурсов однозначно идентифицирует группу ресурсов в идентификаторе подписки пользователя.

--no-wait

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

Default value: False

--prevent-data-exfiltration --prevent-exfiltration

Флаг указывает, включена ли фильтрация данных.

Допустимые значения: false, true

--project-name

Имя проекта, к которому вы подключаетесь.

--repository-name

Имя репозитория, к которому вы подключаетесь.

--repository-type

Тип конфигурации репозитория.

Допустимые значения: AzureDevOpsGit, GitHub

--root-folder

Имя папки в расположение ресурсов JSON Synapse Azure импортируются. Значение по умолчанию — /.

Default value: /

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--tenant-id

Идентификатор клиента, используемый для подключения к Azure devops.

--uami-id

Список идентификатора управляемого удостоверения, назначаемого пользователем для рабочей области.

--uami-id-in-encrypt

Идентификатор ресурса назначаемого пользователем удостоверения, используемый в шифровании рабочей области.

--use-sami-in-encrypt

Следует ли использовать назначенное системой удостоверение в шифровании рабочей области. Если используется uami, задайте значение True.If not, установите значение False.

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

--debug

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

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az synapse workspace delete

Изменить

Удаление рабочей области Synapse.

az synapse workspace delete [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Примеры

Удаление рабочей области Synapse.

az synapse workspace delete --name testsynapseworkspace --resource-group rg

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

--ids

--name -n

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

--no-wait

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

Default value: False

--resource-group -g

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

--subscription

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

--yes -y

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

Default value: False

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

--debug

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

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az synapse workspace list

Изменить

Список всех рабочих областей Synapse.

az synapse workspace list [--resource-group]

Примеры

Вывод списка всех рабочих областей Synapse в подписке

az synapse workspace list

Вывод списка всех рабочих областей Synapse в определенной группе ресурсов

az synapse workspace list --resource-group rg

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

--resource-group -g

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

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

--debug

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

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az synapse workspace show

Изменить

Получите рабочую область Synapse.

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

Примеры

Получите рабочую область Synapse.

az synapse workspace show --name testsynapseworkspace --resource-group rg

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

--ids

--name -n

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

--resource-group -g

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

--subscription

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

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

--debug

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

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az synapse workspace update

Изменить

Обновите рабочую область Synapse.

az synapse workspace update [--account-name]
                            [--allowed-tenant-ids]
                            [--collaboration-branch]
                            [--host-name]
                            [--ids]
                            [--key-name]
                            [--last-commit-id]
                            [--name]
                            [--no-wait]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--resource-group]
                            [--root-folder]
                            [--sql-admin-login-password]
                            [--subscription]
                            [--tags]
                            [--tenant-id]
                            [--uami-action {Add, Remove, Set}]
                            [--uami-id]
                            [--uami-id-in-encrypt]
                            [--use-sami-in-encrypt]

Примеры

Обновление рабочей области Synapse

az synapse workspace update --name fromcli4 --resource-group rg \
  --tags key1=value1

Обновление рабочей области Synapse, добавление управляемого удостоверения, назначаемого пользователем

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Add --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Обновление рабочей области Synapse, удаление управляемого удостоверения, назначаемого пользователем

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Remove --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Обновление рабочей области Synapse, переопределение назначаемого пользователем управляемого удостоверения

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Set --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"

Обновление рабочей области Synapse, настройка шифрования рабочих областей uami

az synapse workspace update --name fromcli4 --resource-group rg \
--uami-id-in-encrypt "{your-encrytion-uami-resourceid}" --use-sami-in-encrypt False

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

--account-name

Имя учетной записи GitHub, используемое для репозитория или имени организации Azure devops.

--allowed-tenant-ids

--collaboration-branch

Имя ветви, в которой вы будете сотрудничать с другими пользователями и откуда будете публиковаться.

--host-name

Если используется github Enterprise Server, укажите URL-адрес сервера. Не используйте этот параметр в GitHub Enterprise Cloud.

--ids

--key-name

--last-commit-id

Последний идентификатор фиксации.

--name -n

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

--no-wait

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

Default value: False

--project-name

Имя проекта, к которому вы подключаетесь.

--repository-name

Имя репозитория, к которому вы подключаетесь.

--repository-type

Тип конфигурации репозитория.

Допустимые значения: AzureDevOpsGit, GitHub

--resource-group -g

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

--root-folder

Имя папки в расположение ресурсов JSON Synapse Azure импортируются. Значение по умолчанию — /.

--sql-admin-login-password -p

Пароль для входа администратора SQL.

--subscription

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

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--tenant-id

Идентификатор клиента, используемый для подключения к Azure devops.

--uami-action

Действие должно быть указано при добавлении или удалении или установке управляемых удостоверений, назначенных пользователем для рабочей области. Поддерживаемые действия: Add,Remove,Set.Add означает добавление назначенных пользователем управляемых удостоверений для рабочей области, Удаление средств для удаления назначенных пользователем управляемых удостоверений из рабочей области, установка может использоваться при добавлении и удалении назначенных пользователем управляемых удостоверений одновременно, текущие удостоверения будут охватываться указанными.

Допустимые значения: Add, Remove, Set

--uami-id

Список идентификатора управляемого удостоверения, назначаемого пользователем для рабочей области.

--uami-id-in-encrypt

--use-sami-in-encrypt

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

--debug

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

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

az synapse workspace wait

Изменить

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

az synapse workspace wait --resource-group
                          --workspace-name
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--interval]
                          [--timeout]
                          [--updated]

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

--resource-group -g

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

--workspace-name

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

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

--created

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

Default value: False

--custom

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

--deleted

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

Default value: False

--exists

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

Default value: False

--interval

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

Default value: 30

--timeout

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

Default value: 3600

--updated

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

Default value: False

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

--debug

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

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

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

--output -o

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

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

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

--verbose

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

Поделиться через

az synapse workspace

Команды

az synapse workspace activate

Примеры

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

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

az synapse workspace check-name

Примеры

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

az synapse workspace create

Примеры

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

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

az synapse workspace delete

Примеры

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

az synapse workspace list

Примеры

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

az synapse workspace show

Примеры

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

az synapse workspace update

Примеры

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

az synapse workspace wait

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

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

Дополнительные ресурсы