Skip to content

Commit

Permalink
[AutoPR sql/resource-manager] Improve documentation of sql database &…
Browse files Browse the repository at this point in the history
… elastic pool skus (#4954)

* Generated from e9cd7abc0b53f101c96bf099d197daacafdc5049

Fixed syntax error in elasticPools 2017-10-01

* Generated from ab50c9bae36ff1a9b11efda63a3a400a674fe40f

Remove DW DTU capacity example due to feedback

* Generated from 6690d07ca931ea6321bdbacdf241528248a87caa

Fixed broken Sku reference

* Generated from 20ffeb28a6971fd17d75c1fb94c561e3182c7e67

Additional doc tweaks
  • Loading branch information
AutorestCI authored Apr 29, 2019
1 parent 0062fb8 commit b733236
Show file tree
Hide file tree
Showing 11 changed files with 81 additions and 14 deletions.
15 changes: 13 additions & 2 deletions azure-mgmt-sql/azure/mgmt/sql/models/database.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,17 @@ class Database(TrackedResource):
:type location: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param sku: The name and tier of the SKU.
:param sku: The database SKU.
The list of SKUs may vary by region and support offer. To determine the
SKUs (including the SKU name, tier/edition, family, and capacity) that are
available to your subscription in an Azure region, use the
`Capabilities_ListByLocation` REST API or one of the following commands:
```azurecli
az sql db list-editions -l <location> -o table
````
```powershell
Get-AzSqlServerServiceObjective -Location <location>
````
:type sku: ~azure.mgmt.sql.models.Sku
:ivar kind: Kind of database. This is metadata used for the Azure portal
experience.
Expand Down Expand Up @@ -85,7 +95,8 @@ class Database(TrackedResource):
'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect',
'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed',
'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing',
'Paused', 'Resuming', 'Scaling'
'Paused', 'Resuming', 'Scaling', 'OfflineChangingDwPerformanceTiers',
'OnlineChangingDwPerformanceTiers'
:vartype status: str or ~azure.mgmt.sql.models.DatabaseStatus
:ivar database_id: The ID of the database.
:vartype database_id: str
Expand Down
15 changes: 13 additions & 2 deletions azure-mgmt-sql/azure/mgmt/sql/models/database_py3.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,17 @@ class Database(TrackedResource):
:type location: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param sku: The name and tier of the SKU.
:param sku: The database SKU.
The list of SKUs may vary by region and support offer. To determine the
SKUs (including the SKU name, tier/edition, family, and capacity) that are
available to your subscription in an Azure region, use the
`Capabilities_ListByLocation` REST API or one of the following commands:
```azurecli
az sql db list-editions -l <location> -o table
````
```powershell
Get-AzSqlServerServiceObjective -Location <location>
````
:type sku: ~azure.mgmt.sql.models.Sku
:ivar kind: Kind of database. This is metadata used for the Azure portal
experience.
Expand Down Expand Up @@ -85,7 +95,8 @@ class Database(TrackedResource):
'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect',
'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed',
'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing',
'Paused', 'Resuming', 'Scaling'
'Paused', 'Resuming', 'Scaling', 'OfflineChangingDwPerformanceTiers',
'OnlineChangingDwPerformanceTiers'
:vartype status: str or ~azure.mgmt.sql.models.DatabaseStatus
:ivar database_id: The ID of the database.
:vartype database_id: str
Expand Down
3 changes: 2 additions & 1 deletion azure-mgmt-sql/azure/mgmt/sql/models/database_update.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ class DatabaseUpdate(Model):
'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect',
'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed',
'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing',
'Paused', 'Resuming', 'Scaling'
'Paused', 'Resuming', 'Scaling', 'OfflineChangingDwPerformanceTiers',
'OnlineChangingDwPerformanceTiers'
:vartype status: str or ~azure.mgmt.sql.models.DatabaseStatus
:ivar database_id: The ID of the database.
:vartype database_id: str
Expand Down
3 changes: 2 additions & 1 deletion azure-mgmt-sql/azure/mgmt/sql/models/database_update_py3.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ class DatabaseUpdate(Model):
'Online', 'Restoring', 'RecoveryPending', 'Recovering', 'Suspect',
'Offline', 'Standby', 'Shutdown', 'EmergencyMode', 'AutoClosed',
'Copying', 'Creating', 'Inaccessible', 'OfflineSecondary', 'Pausing',
'Paused', 'Resuming', 'Scaling'
'Paused', 'Resuming', 'Scaling', 'OfflineChangingDwPerformanceTiers',
'OnlineChangingDwPerformanceTiers'
:vartype status: str or ~azure.mgmt.sql.models.DatabaseStatus
:ivar database_id: The ID of the database.
:vartype database_id: str
Expand Down
9 changes: 8 additions & 1 deletion azure-mgmt-sql/azure/mgmt/sql/models/elastic_pool.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,14 @@ class ElasticPool(TrackedResource):
:type location: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param sku:
:param sku: The elastic pool SKU.
The list of SKUs may vary by region and support offer. To determine the
SKUs (including the SKU name, tier/edition, family, and capacity) that are
available to your subscription in an Azure region, use the
`Capabilities_ListByLocation` REST API or the following command:
```azurecli
az sql elastic-pool list-editions -l <location> -o table
````
:type sku: ~azure.mgmt.sql.models.Sku
:ivar kind: Kind of elastic pool. This is metadata used for the Azure
portal experience.
Expand Down
9 changes: 8 additions & 1 deletion azure-mgmt-sql/azure/mgmt/sql/models/elastic_pool_py3.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,14 @@ class ElasticPool(TrackedResource):
:type location: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param sku:
:param sku: The elastic pool SKU.
The list of SKUs may vary by region and support offer. To determine the
SKUs (including the SKU name, tier/edition, family, and capacity) that are
available to your subscription in an Azure region, use the
`Capabilities_ListByLocation` REST API or the following command:
```azurecli
az sql elastic-pool list-editions -l <location> -o table
````
:type sku: ~azure.mgmt.sql.models.Sku
:ivar kind: Kind of elastic pool. This is metadata used for the Azure
portal experience.
Expand Down
14 changes: 12 additions & 2 deletions azure-mgmt-sql/azure/mgmt/sql/models/import_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,19 @@ class ImportRequest(ExportRequest):
:param database_name: Required. The name of the database to import.
:type database_name: str
:param edition: Required. The edition for the database being created.
Possible values include: 'Web', 'Business', 'Basic', 'Standard',
The list of SKUs may vary by region and support offer. To determine the
SKUs (including the SKU name, tier/edition, family, and capacity) that are
available to your subscription in an Azure region, use the
`Capabilities_ListByLocation` REST API or one of the following commands:
```azurecli
az sql db list-editions -l <location> -o table
````
```powershell
Get-AzSqlServerServiceObjective -Location <location>
````
. Possible values include: 'Web', 'Business', 'Basic', 'Standard',
'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System',
'System2'
'System2', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale'
:type edition: str or ~azure.mgmt.sql.models.DatabaseEdition
:param service_objective_name: Required. The name of the service objective
to assign to the database. Possible values include: 'System', 'System0',
Expand Down
14 changes: 12 additions & 2 deletions azure-mgmt-sql/azure/mgmt/sql/models/import_request_py3.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,19 @@ class ImportRequest(ExportRequest):
:param database_name: Required. The name of the database to import.
:type database_name: str
:param edition: Required. The edition for the database being created.
Possible values include: 'Web', 'Business', 'Basic', 'Standard',
The list of SKUs may vary by region and support offer. To determine the
SKUs (including the SKU name, tier/edition, family, and capacity) that are
available to your subscription in an Azure region, use the
`Capabilities_ListByLocation` REST API or one of the following commands:
```azurecli
az sql db list-editions -l <location> -o table
````
```powershell
Get-AzSqlServerServiceObjective -Location <location>
````
. Possible values include: 'Web', 'Business', 'Basic', 'Standard',
'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System',
'System2'
'System2', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale'
:type edition: str or ~azure.mgmt.sql.models.DatabaseEdition
:param service_objective_name: Required. The name of the service objective
to assign to the database. Possible values include: 'System', 'System0',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ class RecommendedElasticPool(ProxyResource):
:vartype type: str
:ivar database_edition: The edition of the recommended elastic pool. The
ElasticPoolEdition enumeration contains all the valid editions. Possible
values include: 'Basic', 'Standard', 'Premium'
values include: 'Basic', 'Standard', 'Premium', 'GeneralPurpose',
'BusinessCritical'
:vartype database_edition: str or
~azure.mgmt.sql.models.ElasticPoolEdition
:param dtu: The DTU for the recommended elastic pool.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ class RecommendedElasticPool(ProxyResource):
:vartype type: str
:ivar database_edition: The edition of the recommended elastic pool. The
ElasticPoolEdition enumeration contains all the valid editions. Possible
values include: 'Basic', 'Standard', 'Premium'
values include: 'Basic', 'Standard', 'Premium', 'GeneralPurpose',
'BusinessCritical'
:vartype database_edition: str or
~azure.mgmt.sql.models.ElasticPoolEdition
:param dtu: The DTU for the recommended elastic pool.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ class DatabaseEdition(str, Enum):
data_warehouse = "DataWarehouse"
system = "System"
system2 = "System2"
general_purpose = "GeneralPurpose"
business_critical = "BusinessCritical"
hyperscale = "Hyperscale"


class ServiceObjectiveName(str, Enum):
Expand Down Expand Up @@ -203,6 +206,8 @@ class ElasticPoolEdition(str, Enum):
basic = "Basic"
standard = "Standard"
premium = "Premium"
general_purpose = "GeneralPurpose"
business_critical = "BusinessCritical"


class ReplicationRole(str, Enum):
Expand Down Expand Up @@ -624,6 +629,8 @@ class DatabaseStatus(str, Enum):
paused = "Paused"
resuming = "Resuming"
scaling = "Scaling"
offline_changing_dw_performance_tiers = "OfflineChangingDwPerformanceTiers"
online_changing_dw_performance_tiers = "OnlineChangingDwPerformanceTiers"


class DatabaseLicenseType(str, Enum):
Expand Down

0 comments on commit b733236

Please sign in to comment.