Skip to content

Add UX metadata for MariaDB and PostgreSql #22412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
YanaXu merged 1 commit into from
Aug 1, 2023
Merged

Add UX metadata for MariaDB and PostgreSql #22412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions src/MariaDb/UX/Microsoft.DBforMariaDB/servers-configurations.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"resourceType": "servers/configurations",
"apiVersion": "2018-06-01-preview",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb"
},
"commands": [
{
"name": "Get-AzMariaDbConfiguration",
"description": "Gets information about a configuration of server.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/configurations/{configurationName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbconfiguration"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"-ServerName <String>",
"[-SubscriptionId <String[]>]"
]
}
]
},
"examples": [
{
"description": "Gets information about a configuration of server.",
"parameters": [
{
"name": "-Name",
"value": "[Path.configurationName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-ServerName",
"value": "[Path.serverName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
95 changes: 95 additions & 0 deletions src/MariaDb/UX/Microsoft.DBforMariaDB/servers-firewallRules.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
{
"resourceType": "servers/firewallRules",
"apiVersion": "2018-06-01-preview",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb"
},
"commands": [
{
"name": "Get-AzMariaDbFirewallRule",
"description": "Gets information about a server firewall rule.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbfirewallrule"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"-ServerName <String>",
"[-SubscriptionId <String[]>]"
]
}
]
},
"examples": [
{
"description": "Gets information about a server firewall rule.",
"parameters": [
{
"name": "-Name",
"value": "[Path.firewallRuleName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-ServerName",
"value": "[Path.serverName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
},
{
"name": "Remove-AzMariaDbFirewallRule",
"description": "Deletes a server firewall rule.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/firewallRules/{firewallRuleName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb/remove-azmariadbfirewallrule"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"-ServerName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Deletes a server firewall rule.",
"parameters": [
{
"name": "-Name",
"value": "[Path.firewallRuleName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-ServerName",
"value": "[Path.serverName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
95 changes: 95 additions & 0 deletions src/MariaDb/UX/Microsoft.DBforMariaDB/servers-virtualNetworkRules.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
{
"resourceType": "servers/virtualNetworkRules",
"apiVersion": "2018-06-01-preview",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb"
},
"commands": [
{
"name": "Get-AzMariaDbVirtualNetworkRule",
"description": "Gets a virtual network rule.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbvirtualnetworkrule"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"-ServerName <String>",
"[-SubscriptionId <String[]>]"
]
}
]
},
"examples": [
{
"description": "Gets a virtual network rule.",
"parameters": [
{
"name": "-Name",
"value": "[Path.virtualNetworkRuleName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-ServerName",
"value": "[Path.serverName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
},
{
"name": "Remove-AzMariaDbVirtualNetworkRule",
"description": "Deletes the virtual network rule with the given name.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb/remove-azmariadbvirtualnetworkrule"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"-ServerName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Deletes the virtual network rule with the given name.",
"parameters": [
{
"name": "-Name",
"value": "[Path.virtualNetworkRuleName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-ServerName",
"value": "[Path.serverName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
85 changes: 85 additions & 0 deletions src/MariaDb/UX/Microsoft.DBforMariaDB/servers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
{
"resourceType": "servers",
"apiVersion": "2018-06-01-preview",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb"
},
"commands": [
{
"name": "Get-AzMariaDbServer",
"description": "Gets information about a server.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb/get-azmariadbserver"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String[]>]"
]
}
]
},
"examples": [
{
"description": "Gets information about a server.",
"parameters": [
{
"name": "-Name",
"value": "[Path.serverName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
},
{
"name": "Remove-AzMariaDbServer",
"description": "Deletes a server.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.mariadb/remove-azmariadbserver"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Deletes a server.",
"parameters": [
{
"name": "-Name",
"value": "[Path.serverName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
52 changes: 52 additions & 0 deletions src/PostgreSql/UX/Microsoft.DBforPostgreSQL/flexibleServers-configurations.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"resourceType": "flexibleServers/configurations",
"apiVersion": "2021-06-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.postgresql"
},
"commands": [
{
"name": "Get-AzPostgreSqlFlexibleServerConfiguration",
"description": "Gets information about a configuration of server.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.postgresql/get-azpostgresqlflexibleserverconfiguration"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"-ServerName <String>",
"[-SubscriptionId <String[]>]"
]
}
]
},
"examples": [
{
"description": "Gets information about a configuration of server.",
"parameters": [
{
"name": "-Name",
"value": "[Path.configurationName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-ServerName",
"value": "[Path.serverName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
Loading