|
1594 | 1594 | helps['sql server create'] = """ |
1595 | 1595 | type: command |
1596 | 1596 | short-summary: Create a server. |
| 1597 | +long-summary: | |
| 1598 | + Create a new SQL server. The server can be configured with various security, networking, |
| 1599 | + and identity management options including soft delete protection for disaster recovery. |
| 1600 | +parameters: |
| 1601 | + - name: --enable-soft-delete |
| 1602 | + short-summary: Enable soft delete protection for the server. |
| 1603 | + long-summary: | |
| 1604 | + When enabled, allows the server to be recovered after deletion within the retention period. |
| 1605 | + This provides protection against accidental deletion. |
| 1606 | + - name: --soft-delete-retention-days |
| 1607 | + short-summary: Number of days to retain a soft-deleted server. |
| 1608 | + long-summary: | |
| 1609 | + Specifies how many days to keep the server in a soft-deleted state before permanent deletion. |
| 1610 | + Valid range is 1-7 days. Requires --enable-soft-delete to be true. |
1597 | 1611 | examples: |
1598 | 1612 | - name: Create a server. |
1599 | 1613 | text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword |
1600 | 1614 | - name: Create a server with tags. |
1601 | 1615 | text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword --tags key1=value1 key2=value2 |
1602 | 1616 | - name: Create a server with disabled public network access to server. |
1603 | 1617 | text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword -e false |
| 1618 | + - name: Create a server with soft delete enabled and 7-day retention period. |
| 1619 | + text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword --enable-soft-delete --soft-delete-retention-days 7 |
| 1620 | + - name: Create a server with minimal TLS version and soft delete protection. |
| 1621 | + text: az sql server create -l westus -g mygroup -n myserver -u myadminuser -p myadminpassword --minimal-tls-version 1.2 --enable-soft-delete --soft-delete-retention-days 3 |
1604 | 1622 | - name: Create a server without SQL Admin, with AD admin and AD Only enabled. |
1605 | 1623 | text: az sql server create --enable-ad-only-auth --external-admin-principal-type User --external-admin-name myUserName --external-admin-sid c5e964e2-6bb2-1111-1111-3b16ec0e1234 -g myResourceGroup -n myServer |
1606 | 1624 | - name: Create a server without SQL Admin, with AD admin, AD Only enabled, User ManagedIdenties and Identity Type is SystemAssigned,UserAssigned. |
|
1615 | 1633 | --identity-type UserAssigned --pid /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi |
1616 | 1634 | """ |
1617 | 1635 |
|
| 1636 | +helps['sql server restore'] = """ |
| 1637 | +type: command |
| 1638 | +short-summary: Restore a deleted SQL server. |
| 1639 | +long-summary: | |
| 1640 | + Restore a deleted SQL server from a soft-deleted state. The server must have been deleted |
| 1641 | + with soft delete enabled and must be within the retention period. The server will be restored |
| 1642 | + to the specified name in the same location where it was originally deleted. |
| 1643 | +parameters: |
| 1644 | + - name: --name -n |
| 1645 | + short-summary: Name of the server to restore to. |
| 1646 | + long-summary: | |
| 1647 | + The name for the restored server. This is typically the same name as the deleted server |
| 1648 | + you want to restore. |
| 1649 | + - name: --resource-group -g |
| 1650 | + short-summary: Name of the resource group. |
| 1651 | + long-summary: | |
| 1652 | + The resource group where the server will be restored. This is typically the same |
| 1653 | + resource group where the deleted server was originally located. |
| 1654 | + - name: --location -l |
| 1655 | + short-summary: Location where the deleted server was originally located. |
| 1656 | + long-summary: | |
| 1657 | + Specifies the location where the deleted server was originally located. The restored |
| 1658 | + server will be created in this same location. |
| 1659 | +examples: |
| 1660 | + - name: Restore a deleted server. |
| 1661 | + text: az sql server restore -g mygroup -n myserver -l westus2 |
| 1662 | + - name: Restore a deleted server with no-wait option for asynchronous operation. |
| 1663 | + text: az sql server restore -g mygroup -n myserver -l westus2 --no-wait |
| 1664 | +""" |
| 1665 | + |
1618 | 1666 | helps['sql server dns-alias'] = """ |
1619 | 1667 | type: group |
1620 | 1668 | short-summary: Manage a server's DNS aliases. |
|
1796 | 1844 | helps['sql server update'] = """ |
1797 | 1845 | type: command |
1798 | 1846 | short-summary: Update a server. |
1799 | | -examples: |
1800 | | - - name: Update a server. (autogenerated) |
| 1847 | +long-summary: | |
| 1848 | + Update an existing SQL server's configuration including security settings, networking options, |
| 1849 | + identity management, and soft delete protection settings. |
| 1850 | +parameters: |
| 1851 | + - name: --enable-soft-delete |
| 1852 | + short-summary: Enable or disable soft delete protection for the server. |
| 1853 | + long-summary: | |
| 1854 | + When enabled, allows the server to be recovered after deletion within the retention period. |
| 1855 | + This provides protection against accidental deletion. Can be enabled or disabled on existing servers. |
| 1856 | + - name: --soft-delete-retention-days |
| 1857 | + short-summary: Update the number of days to retain a soft-deleted server. |
| 1858 | + long-summary: | |
| 1859 | + Specifies how many days to keep the server in a soft-deleted state before permanent deletion. |
| 1860 | + Valid range is 1-7 days. Requires soft delete to be enabled. |
| 1861 | + - name: --enable-public-network -e |
| 1862 | + short-summary: Update public network access to server. |
| 1863 | + long-summary: | |
| 1864 | + Controls whether the server can be accessed from public networks. When false, only private |
| 1865 | + endpoint connections are allowed. |
| 1866 | + - name: --restrict-outbound-network-access |
| 1867 | + short-summary: Update outbound network access restriction. |
| 1868 | + long-summary: | |
| 1869 | + Controls whether the server can initiate outbound network connections. When enabled, |
| 1870 | + restricts outbound connections for enhanced security. |
| 1871 | +examples: |
| 1872 | + - name: Update a server password. |
1801 | 1873 | text: az sql server update --admin-password myadminpassword --name MyAzureSQLServer --resource-group MyResourceGroup |
1802 | | - crafted: true |
| 1874 | + - name: Enable soft delete protection with 7-day retention. |
| 1875 | + text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --enable-soft-delete --soft-delete-retention-days 7 |
| 1876 | + - name: Disable public network access for enhanced security. |
| 1877 | + text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --enable-public-network false |
| 1878 | + - name: Update TLS version and enable outbound network restrictions. |
| 1879 | + text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --minimal-tls-version 1.2 --restrict-outbound-network-access |
| 1880 | + - name: Modify soft delete retention period. |
| 1881 | + text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --enable-soft-delete --soft-delete-retention-days 5 |
1803 | 1882 | - name: Update a server with User Managed Identies and Identity Type is SystemAssigned,UserAssigned. |
1804 | 1883 | text: az sql server update -g myResourceGroup -n myServer -i \\ |
1805 | 1884 | --user-assigned-identity-id /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \\ |
|
1808 | 1887 | text: az sql server update -g myResourceGroup -n myServer -i \\ |
1809 | 1888 | --user-assigned-identity-id /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi \\ |
1810 | 1889 | --identity-type UserAssigned --pid /subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testumi |
| 1890 | + - name: Configure server for maximum security compliance. |
| 1891 | + text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup \\ |
| 1892 | + --minimal-tls-version 1.2 --enable-public-network false \\ |
| 1893 | + --restrict-outbound-network-access --enable-soft-delete --soft-delete-retention-days 7 |
| 1894 | + - name: Disable soft delete protection (not recommended for production). |
| 1895 | + text: az sql server update --name MyAzureSQLServer --resource-group MyResourceGroup --enable-soft-delete false |
1811 | 1896 | """ |
1812 | 1897 |
|
1813 | 1898 | helps['sql server vnet-rule'] = """ |
|
0 commit comments