text
stringlengths 1.14k
21k
| source_file
stringlengths 18
81
|
|---|---|
There is a command group 'az_arcappliance_upgrade'. This group of commands could 'command group for upgrading an appliance cluster'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_arcappliance_upgrade_vmware'.The syntax is: az arcappliance upgrade vmware --config-file
[--location]
[--name]
[--no-wait]
[--resource-group]. The 1th example of the child command would be to use it to 'upgrade vmware appliance', the syntax is: az arcappliance upgrade vmware --config-file [REQUIRED]. The parameter '--config-file' is required. It is used to path to appliance config file.. The parameter '--location -l' is optional. location. values from: `az account list-locations`. you can configure the default location using `az configure --defaults location=<location>`.. The parameter '--name -n' is optional. name of the arc resource bridge.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/arcappliance/upgrade.yml |
There is a command group 'az_arcappliance_validate'. This group of commands could 'command group to perform validations on arc resource bridge configuration files and network settings'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_arcappliance_validate_hci'.The syntax is: az arcappliance validate hci --config-file
[--cloudagent]
[--location]
[--loginconfigfile]
[--name]
[--resource-group]. The 1th example of the child command would be to use it to 'validate arc resource bridge configuration and network settings for azure stack hci', the syntax is: az arcappliance validate hci --config-file [REQUIRED] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]. The parameter '--config-file' is required. It is used to path to the arc resource bridge appliance config file, <resourcename>-appliance.yaml.. The parameter '--cloudagent' is optional. fqdn or ip address of the azure stack hci moc cloud agent service used by arc resource bridge. this can be found in the <bridgename>-infra.yaml configuration file stored locally on the hci cluster.. The parameter '--location -l' is optional. location. values from: `az account list-locations`. you can configure the default location using `az configure --defaults location=<location>`.. The parameter '--loginconfigfile' is optional. file path for the azure stack hci login configuration file, kvatoken.tok. by default, it is stored locally on the hci cluster.. The parameter '--name -n' is optional. name of the arc resource bridge.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/arcappliance/validate.yml |
There is a command group 'az_arcappliance_validate'. This group of commands could 'command group to perform validations on arc resource bridge configuration files and network settings'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_arcappliance_validate_scvmm'.The syntax is: az arcappliance validate scvmm --config-file
[--address]
[--location]
[--name]
[--password]
[--port]
[--resource-group]
[--username]. The 1th example of the child command would be to use it to 'validate arc resource bridge configuration files and network settings for arc enabled scvmm', the syntax is: az arcappliance validate scvmm --config-file [REQUIRED] --address [OPTIONAL] --port [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]. The parameter '--config-file' is required. It is used to path to the arc resource bridge appliance config file, <resourcename>-appliance.yaml.. The parameter '--address' is optional. scvmm server fqdn (e.g. vmmuser001.contoso.lab) or ipv4 address. if you have a highly available vmm setup, enter the role name.. The parameter '--location -l' is optional. location. values from: `az account list-locations`. you can configure the default location using `az configure --defaults location=<location>`.. The parameter '--name -n' is optional. name of the arc resource bridge.. The parameter '--password' is optional. scvmm administrator password.. The parameter '--port' is optional. scvmm server port number (default: 8100).. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--username' is optional. scvmm administrator username in the format domain\username where 'domain' should be the netbios name of the domain (e.g. contoso\administrator).. | database/arcappliance/validate.yml |
There is a command group 'az_arcappliance_validate'. This group of commands could 'command group to perform validations on arc resource bridge configuration files and network settings'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_arcappliance_validate_vmware'.The syntax is: az arcappliance validate vmware --config-file
[--address]
[--location]
[--name]
[--password]
[--resource-group]
[--username]. The 1th example of the child command would be to use it to 'validate arc resource bridge configuration and network settings for arc enabled vmware', the syntax is: az arcappliance validate vmware --config-file [REQUIRED] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]. The parameter '--config-file' is required. It is used to path to the arc resource bridge appliance config file, <resourcename>-appliance.yaml.. The parameter '--address' is optional. fqdn or ip address for vcenter server instance. ex: 10.160.0.1.. The parameter '--location -l' is optional. location. values from: `az account list-locations`. you can configure the default location using `az configure --defaults location=<location>`.. The parameter '--name -n' is optional. name of the arc resource bridge.. The parameter '--password' is optional. password for vsphere account that arc resource bridge uses for on-premises infrastructure guest management.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--username' is optional. username for vsphere account that arc resource bridge uses for on-premises infrastructure guest management.. | database/arcappliance/validate.yml |
There is a command group 'az_arcappliance_troubleshoot_command'. This group of commands could 'command group for troubleshooting an appliance cluster by executing a shell command'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_arcappliance_troubleshoot_command_hci'.The syntax is: az arcappliance troubleshoot command hci [--cloudagent]
[--command]
[--credentials-dir]
[--ip]
[--kubeconfig]
[--loginconfigfile]. The 1th example of the child command would be to use it to 'execute a troubleshooting command on an hci cluster passing in ip', the syntax is: az arcappliance troubleshoot command hci --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL]. The 2th example of the child command would be to use it to 'execute a troubleshooting command on an hci cluster passing in kubeconfig', the syntax is: az arcappliance troubleshoot command hci --command [REQUIRED] --kubeconfig [REQUIRED] --credentials-dir [OPTIONAL]. The 3th example of the child command would be to use it to 'execute a troubleshooting command on an hci cluster passing in ip', the syntax is: az arcappliance troubleshoot command hci --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL] --cloudagent [OPTIONAL] --loginconfigfile [OPTIONAL]. The parameter '--cloudagent' is optional. fqdn or ip address of the azure stack hci moc cloud agent service used by arc resource bridge. this can be found in the <bridgename>-infra.yaml configuration file stored locally on the hci cluster.. The parameter '--command' is optional. this is the shell command to be executed.. The parameter '--credentials-dir' is optional. this is the path to the log key directory, which stores credentials for your resource bridge. once a scoped access key has been generated, use the az arcappliance get-credentials command to download it.. The parameter '--ip' is optional. arc resource bridge on-premises appliance vm ip or its control plane ip.. The parameter '--kubeconfig' is optional. path to kubeconfig.. The parameter '--loginconfigfile' is optional. file path for the azure stack hci login configuration file, kvatoken.tok. by default, it is stored locally on the hci cluster.. | database/arcappliance/troubleshoot/command.yml |
There is a command group 'az_arcappliance_troubleshoot_command'. This group of commands could 'command group for troubleshooting an appliance cluster by executing a shell command'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_arcappliance_troubleshoot_command_scvmm'.The syntax is: az arcappliance troubleshoot command scvmm [--address]
[--command]
[--credentials-dir]
[--ip]
[--kubeconfig]
[--password]
[--port]
[--username]. The 1th example of the child command would be to use it to 'execute a troubleshooting command on an scvmm cluster passing in ip', the syntax is: az arcappliance troubleshoot command scvmm --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL]. The 2th example of the child command would be to use it to 'execute a troubleshooting command on an scvmm cluster passing in kubeconfig', the syntax is: az arcappliance troubleshoot command scvmm --command [REQUIRED] --kubeconfig [REQUIRED] --credentials-dir [OPTIONAL]. The 3th example of the child command would be to use it to 'execute a troubleshooting command on an scvmm cluster using noninteractive credentials parameters passing in ip', the syntax is: az arcappliance troubleshoot command scvmm --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL] --address [OPTIONAL] --port [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]. The parameter '--address' is optional. scvmm server fqdn (e.g. vmmuser001.contoso.lab) or ipv4 address. if you have a highly available vmm setup, enter the role name.. The parameter '--command' is optional. this is the shell command to be executed.. The parameter '--credentials-dir' is optional. this is the path to the log key directory, which stores credentials for your resource bridge. once a scoped access key has been generated, use the az arcappliance get-credentials command to download it.. The parameter '--ip' is optional. arc resource bridge on-premises appliance vm ip or its control plane ip.. The parameter '--kubeconfig' is optional. path to kubeconfig.. The parameter '--password' is optional. scvmm administrator password.. The parameter '--port' is optional. scvmm server port number (default: 8100).. The parameter '--username' is optional. scvmm administrator username (domain\username).. | database/arcappliance/troubleshoot/command.yml |
There is a command group 'az_arcappliance_troubleshoot_command'. This group of commands could 'command group for troubleshooting an appliance cluster by executing a shell command'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_arcappliance_troubleshoot_command_vmware'.The syntax is: az arcappliance troubleshoot command vmware [--address]
[--command]
[--credentials-dir]
[--ip]
[--kubeconfig]
[--password]
[--username]. The 1th example of the child command would be to use it to 'execute a troubleshooting command on an vmware cluster passing in ip', the syntax is: az arcappliance troubleshoot command vmware --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL]. The 2th example of the child command would be to use it to 'execute a troubleshooting command on an vmware cluster passing in kubeconfig', the syntax is: az arcappliance troubleshoot command vmware --command [REQUIRED] --kubeconfig [REQUIRED] --credentials-dir [OPTIONAL]. The 3th example of the child command would be to use it to 'execute a troubleshooting command on an vmware cluster using noninteractive credentials parameters passing in ip', the syntax is: az arcappliance troubleshoot command vmware --command [REQUIRED] --ip [REQUIRED] --credentials-dir [OPTIONAL] --address [OPTIONAL] --username [OPTIONAL] --password [OPTIONAL]. The parameter '--address' is optional. fqdn or ip address for vcenter server instance. ex: 10.160.0.1.. The parameter '--command' is optional. this is the shell command to be executed.. The parameter '--credentials-dir' is optional. this is the path to the log key directory, which stores credentials for your resource bridge. once a scoped access key has been generated, use the az arcappliance get-credentials command to download it.. The parameter '--ip' is optional. arc resource bridge on-premises appliance vm ip or its control plane ip.. The parameter '--kubeconfig' is optional. path to kubeconfig.. The parameter '--password' is optional. password for vsphere account that arc resource bridge uses for on-premises infrastructure guest management.. The parameter '--username' is optional. username for vsphere account that arc resource bridge uses for on-premises infrastructure guest management.. | database/arcappliance/troubleshoot/command.yml |
There is a command group 'az_akshybrid_vnet'. This group of commands could 'manage virtual networks for provisioned clusters'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_vnet_create'.The syntax is: az akshybrid vnet create --custom-location
--name
--resource-group
[--location]
[--moc-group]
[--moc-location]
[--moc-vnet-name]
[--no-wait]
[--tags]
[--vsphere-segment-name]. The 1th example of the child command would be to use it to 'putvirtualnetwork', the syntax is: az akshybrid vnet create --name "test-vnet-static" --resource-group "test-arcappliance-resgrp" --custom-location "testcustomlocation" --moc-vnet-name "test-vnet". The parameter '--custom-location' is required. It is used to name or id of the custom location to use for the virtual network.. The parameter '--name -n' is required. It is used to name of the virtual network.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--location -l' is optional. location. values from: `az account list-locations`. you can configure the default location using `az configure --defaults location=<location>`.. The parameter '--moc-group' is optional. name of the moc group containing the moc network for hci infrastructure.. The parameter '--moc-location' is optional. name of the moc location containing the moc group with the network for hci infrastructure.. The parameter '--moc-vnet-name' is optional. name of the moc network for hci infrastructure.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--tags' is optional. space-separated tags: key[=value] [key[=value] ...]. use "" to clear existing tags.. The parameter '--vsphere-segment-name' is optional. name of the vsphere segment for vmware infrastructure.. | database/akshybrid/vnet.yml |
There is a command group 'az_akshybrid_vnet'. This group of commands could 'manage virtual networks for provisioned clusters'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_vnet_delete'.The syntax is: az akshybrid vnet delete --name
--resource-group
[--no-wait]
[--yes]. The 1th example of the child command would be to use it to 'deletevirtualnetwork', the syntax is: az akshybrid vnet delete --resource-group "test-arcappliance-resgrp" --name "test-vnet-static". The parameter '--name -n' is required. It is used to name of the virtual network.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/akshybrid/vnet.yml |
There is a command group 'az_akshybrid_vnet'. This group of commands could 'manage virtual networks for provisioned clusters'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_vnet_list'.The syntax is: az akshybrid vnet list [--resource-group]. The 1th example of the child command would be to use it to 'listvirtualnetworkbyresourcegroup', the syntax is: az akshybrid vnet list --resource-group "test-arcappliance-resgrp". The 2th example of the child command would be to use it to 'listvirtualnetworkbysubscription', the syntax is: az akshybrid vnet list. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/akshybrid/vnet.yml |
There is a command group 'az_akshybrid_vnet'. This group of commands could 'manage virtual networks for provisioned clusters'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_vnet_show'.The syntax is: az akshybrid vnet show --name
--resource-group. The 1th example of the child command would be to use it to 'getvirtualnetwork', the syntax is: az akshybrid vnet show --resource-group "test-arcappliance-resgrp" --name "test-vnet-static". The parameter '--name -n' is required. It is used to name of the virtual network.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/akshybrid/vnet.yml |
There is a command group 'az_akshybrid_vmsize'. This group of commands could 'manage virtual machine skus for akshybrid'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_vmsize_list'.The syntax is: az akshybrid vmsize list --custom-location
--resource-group. The 1th example of the child command would be to use it to 'vmlistskus', the syntax is: az akshybrid vmsize list -g sample-rg --custom-location sample-cl. The parameter '--custom-location' is required. It is used to name or id of the custom location to use for the virtual machine skus.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/akshybrid/vmsize.yml |
There is a command group 'az_akshybrid_nodepool'. This group of commands could 'manage nodepools in a provisioned cluster'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_nodepool_add'.The syntax is: az akshybrid nodepool add --cluster-name
--name
--resource-group
[--location]
[--no-wait]
[--node-count]
[--node-vm-size]
[--os-sku]
[--os-type]
[--tags]. The 1th example of the child command would be to use it to 'addnodepool', the syntax is: az akshybrid nodepool add --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg". The parameter '--cluster-name' is required. It is used to name of the provisioned cluster.. The parameter '--name -n' is required. It is used to name of the nodepool.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--location -l' is optional. location. values from: `az account list-locations`. you can configure the default location using `az configure --defaults location=<location>`.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--node-count -c' is optional. number of nodes to be created in the nodepool.. The parameter '--node-vm-size' is optional. vm size of the nodes in the nodepool.. The parameter '--os-sku' is optional. os sku for the nodes in the nodepool. options: "cblmariner" | "windows2019" | "windows2022".. The parameter '--os-type' is optional. os type for the nodes in the nodepool. options: "linux" | "windows".. The parameter '--tags' is optional. space-separated tags: key[=value] [key[=value] ...]. use "" to clear existing tags.. | database/akshybrid/nodepool.yml |
There is a command group 'az_akshybrid_nodepool'. This group of commands could 'manage nodepools in a provisioned cluster'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_nodepool_delete'.The syntax is: az akshybrid nodepool delete --cluster-name
--name
--resource-group
[--no-wait]
[--yes]. The 1th example of the child command would be to use it to 'deletenodepool', the syntax is: az akshybrid nodepool delete --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg". The parameter '--cluster-name' is required. It is used to name of the provisioned cluster.. The parameter '--name -n' is required. It is used to name of the nodepool.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/akshybrid/nodepool.yml |
There is a command group 'az_akshybrid_nodepool'. This group of commands could 'manage nodepools in a provisioned cluster'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_nodepool_list'.The syntax is: az akshybrid nodepool list --cluster-name
--resource-group. The 1th example of the child command would be to use it to 'listnodepool', the syntax is: az akshybrid nodepool list --cluster-name "samplecluster" --resource-group "sample-rg". The parameter '--cluster-name' is required. It is used to name of the provisioned cluster.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/akshybrid/nodepool.yml |
There is a command group 'az_akshybrid_nodepool'. This group of commands could 'manage nodepools in a provisioned cluster'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_nodepool_scale'.The syntax is: az akshybrid nodepool scale --cluster-name
--name
--resource-group
[--no-wait]
[--node-count]
[--node-vm-size]
[--yes]. The 1th example of the child command would be to use it to 'scalenodepool', the syntax is: az akshybrid nodepool scale --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg" --node-count 3 --node-vm-size "Standard_A2_v2". The parameter '--cluster-name' is required. It is used to name of the provisioned cluster.. The parameter '--name -n' is required. It is used to name of the nodepool.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--node-count -c' is optional. number of nodes to scale to in the nodepool.. The parameter '--node-vm-size' is optional. vm size of the nodes in the nodepool.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/akshybrid/nodepool.yml |
There is a command group 'az_akshybrid_nodepool'. This group of commands could 'manage nodepools in a provisioned cluster'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_akshybrid_nodepool_show'.The syntax is: az akshybrid nodepool show --cluster-name
--name
--resource-group. The 1th example of the child command would be to use it to 'getnodepool', the syntax is: az akshybrid nodepool show --name "samplenodepool" --cluster-name "samplecluster" --resource-group "sample-rg". The parameter '--cluster-name' is required. It is used to name of the provisioned cluster.. The parameter '--name -n' is required. It is used to name of the nodepool.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/akshybrid/nodepool.yml |
There is a command group 'az_apic_api'. This group of commands could 'commands to manage apis in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_create'.The syntax is: az apic api create --api-id
--resource-group
--service
--title
--type {graphql, grpc, rest, soap, webhook, websocket}
[--contacts]
[--custom-properties]
[--description]
[--external-documentation]
[--license]
[--summary]. The 1th example of the child command would be to use it to 'create api', the syntax is: az apic api create -g contoso-resources -s contoso --api-id echo-api --title "Echo API" --type REST. The 2th example of the child command would be to use it to 'create api with custom properties', the syntax is: az apic api create -g contoso-resources -s contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'. The parameter '--api-id' is required. It is used to the id of the api.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--title' is required. It is used to api title.. The parameter '--type' is required. It is used to type of api.. The parameter '--contacts' is optional. the contact information for the api. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--custom-properties' is optional. the custom metadata defined for api catalog entities. support json-file and yaml-file.. The parameter '--description' is optional. description of the api.. The parameter '--external-documentation' is optional. additional, external documentation for the api. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--license' is optional. the license information for the api. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--summary' is optional. short description of the api.. | database/apic/api.yml |
There is a command group 'az_apic_api'. This group of commands could 'commands to manage apis in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_delete'.The syntax is: az apic api delete [--api-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--yes]. The 1th example of the child command would be to use it to 'delete api', the syntax is: az apic api delete -g contoso-resources -s contoso --api-id echo-api. The parameter '--api-id' is optional. the id of the api.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/apic/api.yml |
There is a command group 'az_apic_api'. This group of commands could 'commands to manage apis in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_list'.The syntax is: az apic api list --resource-group
--service
[--filter]
[--max-items]
[--next-token]. The 1th example of the child command would be to use it to 'list apis', the syntax is: az apic api list -g contoso-resources -s contoso. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--filter' is optional. odata filter parameter.. The parameter '--max-items' is optional. total number of items to return in the command's output. if the total number of items available is more than the value specified, a token is provided in the command's output. to resume pagination, provide the token value in `--next-token` argument of a subsequent command.. The parameter '--next-token' is optional. token to specify where to start paginating. this is the token value from a previously truncated response.. | database/apic/api.yml |
There is a command group 'az_apic_api'. This group of commands could 'commands to manage apis in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_register'.The syntax is: az apic api register --api-location
--resource-group
--service
[--environment-name]. The 1th example of the child command would be to use it to 'register api by providing spec file', the syntax is: az apic api register -g api-center-test -s contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-name public
az apic api register -g api-center-test -s contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-name public. The parameter '--api-location -l' is required. It is used to location of spec file.. The parameter '--resource-group -g' is required. It is used to resource group name.. The parameter '--service -s' is required. It is used to apicenter catalog or service name.. The parameter '--environment-name -e' is optional. name of environment created before.. | database/apic/api.yml |
There is a command group 'az_apic_api'. This group of commands could 'commands to manage apis in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_show'.The syntax is: az apic api show [--api-id]
[--ids]
[--resource-group]
[--service]
[--subscription]. The 1th example of the child command would be to use it to 'show api details', the syntax is: az apic api show -g contoso-resources -s contoso --api-id echo-api. The parameter '--api-id' is optional. the id of the api.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. | database/apic/api.yml |
There is a command group 'az_apic_api'. This group of commands could 'commands to manage apis in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_update'.The syntax is: az apic api update [--add]
[--api-id]
[--contacts]
[--custom-properties]
[--description]
[--external-documentation]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--license]
[--remove]
[--resource-group]
[--service]
[--set]
[--subscription]
[--summary]
[--title]
[--type {graphql, grpc, rest, soap, webhook, websocket}]. The 1th example of the child command would be to use it to 'update api', the syntax is: az apic api update -g contoso-resources -s contoso --api-id echo-api --summary "Basic REST API service". The 2th example of the child command would be to use it to 'update custom properties', the syntax is: az apic api update -g contoso-resources -s contoso --api-id echo-api --custom-properties '{"public-facing":true}'. The parameter '--add' is optional. add an object to a list of objects by specifying a path and key value pairs. example: --add property.listproperty <key=value, string or json string>.. The parameter '--api-id' is optional. the id of the api.. The parameter '--contacts' is optional. the contact information for the api. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--custom-properties' is optional. the custom metadata defined for api catalog entities. support json-file and yaml-file.. The parameter '--description' is optional. description of the api.. The parameter '--external-documentation' is optional. additional, external documentation for the api. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--force-string' is optional. when using 'set' or 'add', preserve string literals instead of attempting to convert to json.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--license' is optional. the license information for the api. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--remove' is optional. remove a property or an element from a list. example: --remove property.list <indextoremove> or --remove propertytoremove.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--set' is optional. update an object by specifying a property path and value to set. example: --set property1.property2=<value>.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--summary' is optional. short description of the api.. The parameter '--title' is optional. api title.. The parameter '--type' is optional. type of api.. | database/apic/api.yml |
There is a command group 'az_apic_metadata'. This group of commands could 'commands to manage metadata schemas in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_metadata_create'.The syntax is: az apic metadata create --assignments
--metadata-schema
--resource-group
--schema
--service
[--file-name]. The 1th example of the child command would be to use it to 'create metadata example 1', the syntax is: az apic metadata create --resource-group api-center-test --service-name contoso --name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'. The 2th example of the child command would be to use it to 'create metadata example 2', the syntax is: az apic metadata create --resource-group api-center-test --service-name contoso --name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'. The parameter '--assignments' is required. It is used to defines the assignment scope for the custom metadata, e.g. "[{entity:api,required:true,deprecated:false}]". the available entity values are: api, deployment, environment. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--metadata-schema --metadata-schema-name --name' is required. It is used to the name of the metadata schema.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--schema' is required. It is used to json schema defining the type.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--file-name' is optional. name of the file from that contains the metadata schema.. | database/apic/metadata.yml |
There is a command group 'az_apic_metadata'. This group of commands could 'commands to manage metadata schemas in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_metadata_delete'.The syntax is: az apic metadata delete [--ids]
[--metadata-schema]
[--resource-group]
[--service]
[--subscription]
[--yes]. The 1th example of the child command would be to use it to 'delete metadata schema', the syntax is: az apic metadata delete --resource-group api-center-test --service-name contoso --name "test1". The 2th example of the child command would be to use it to 'delete schema', the syntax is: az apic metadata delete -g api-center-test -s contosoeuap --name "approver". The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--metadata-schema --metadata-schema-name --name' is optional. the name of the metadata schema.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/apic/metadata.yml |
There is a command group 'az_apic_metadata'. This group of commands could 'commands to manage metadata schemas in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_metadata_export'.The syntax is: az apic metadata export --assignments {api, deployment, environment}
--file-name
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]. The 1th example of the child command would be to use it to 'export metadata schema assigned to api', the syntax is: az apic metadata export -g api-center-test -s contosoeuap --assignments api --file-name filename.json. The 2th example of the child command would be to use it to 'export metadata schema assigned to deployment', the syntax is: az apic metadata export -g api-center-test -s contosoeuap --assignments deployment --file-name filename.json. The 3th example of the child command would be to use it to 'export metadata schema assigned to environment', the syntax is: az apic metadata export -g api-center-test -s contosoeuap --assignments environment --file-name filename.json. The parameter '--assignments' is required. It is used to an entity the metadata schema is requested for.. The parameter '--file-name' is required. It is used to name of the file where to export the metadata schema to.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--name --service --service-name -s' is optional. the name of the api center service.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. | database/apic/metadata.yml |
There is a command group 'az_apic_metadata'. This group of commands could 'commands to manage metadata schemas in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_metadata_list'.The syntax is: az apic metadata list --resource-group
--service
[--filter]
[--max-items]
[--next-token]. The 1th example of the child command would be to use it to 'list schemas', the syntax is: az apic metadata list -g api-center-test -s contosoeuap. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--filter' is optional. odata filter parameter.. The parameter '--max-items' is optional. total number of items to return in the command's output. if the total number of items available is more than the value specified, a token is provided in the command's output. to resume pagination, provide the token value in `--next-token` argument of a subsequent command.. The parameter '--next-token' is optional. token to specify where to start paginating. this is the token value from a previously truncated response.. | database/apic/metadata.yml |
There is a command group 'az_apic_metadata'. This group of commands could 'commands to manage metadata schemas in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_metadata_show'.The syntax is: az apic metadata show [--ids]
[--metadata-schema]
[--resource-group]
[--service]
[--subscription]. The 1th example of the child command would be to use it to 'show schema details 1', the syntax is: az apic metadata show -g api-center-test -s contosoeuap --name approver. The 2th example of the child command would be to use it to 'show schema details 2', the syntax is: az apic metadata show --resource-group api-center-test --service-name contoso --name "testchoices". The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--metadata-schema --metadata-schema-name --name' is optional. the name of the metadata schema.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. | database/apic/metadata.yml |
There is a command group 'az_apic_metadata'. This group of commands could 'commands to manage metadata schemas in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_metadata_update'.The syntax is: az apic metadata update [--add]
[--assignments]
[--file-name]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--metadata-schema]
[--remove]
[--resource-group]
[--schema]
[--service]
[--set]
[--subscription]. The 1th example of the child command would be to use it to 'update schema', the syntax is: az apic metadata update --resource-group api-center-test --service-name contoso --name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'. The parameter '--add' is optional. add an object to a list of objects by specifying a path and key value pairs. example: --add property.listproperty <key=value, string or json string>.. The parameter '--assignments' is optional. defines the assignment scope for the custom metadata, e.g. "[{entity:api,required:true,deprecated:false}]". the available entity values are: api, deployment, environment. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--file-name' is optional. name of the file from that contains the metadata schema.. The parameter '--force-string' is optional. when using 'set' or 'add', preserve string literals instead of attempting to convert to json.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--metadata-schema --metadata-schema-name --name' is optional. the name of the metadata schema.. The parameter '--remove' is optional. remove a property or an element from a list. example: --remove property.list <indextoremove> or --remove propertytoremove.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--schema' is optional. yaml schema defining the type.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--set' is optional. update an object by specifying a property path and value to set. example: --set property1.property2=<value>.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. | database/apic/metadata.yml |
There is a command group 'az_apic_service'. This group of commands could 'manage an azure api center service instance'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_service_create'.The syntax is: az apic service create --name
--resource-group
[--identity]
[--location]
[--tags]. The 1th example of the child command would be to use it to 'create service example 1', the syntax is: az apic service create -g contoso-resources -s contoso -l eastus. The 2th example of the child command would be to use it to 'create service example 2', the syntax is: az apic service create --resource-group contoso-resources --name contoso --location eastus. The parameter '--name --service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--identity' is optional. the managed service identities assigned to this resource. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--location -l' is optional. the geo-location where the resource lives when not specified, the location of the resource group will be used.. The parameter '--tags' is optional. resource tags. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. | database/apic/service.yml |
There is a command group 'az_apic_service'. This group of commands could 'manage an azure api center service instance'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_service_delete'.The syntax is: az apic service delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]. The 1th example of the child command would be to use it to 'delete service', the syntax is: az apic service delete -s contoso -g contoso-resources. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--name --service --service-name -s' is optional. the name of the api center service.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/apic/service.yml |
There is a command group 'az_apic_service'. This group of commands could 'manage an azure api center service instance'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_service_import from apim'.The syntax is: az apic service import-from-apim --source-resource-ids
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service]
[--subscription]. The 1th example of the child command would be to use it to 'import from apim', the syntax is: az apic service import-from-apim -g api-center-test --service-name contosoeuap --source-resource-ids '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicegroup/providers/Microsoft.ApiManagement/service/contoso/apis/contosoapi'. The parameter '--source-resource-ids' is required. It is used to support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of azure api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. | database/apic/service.yml |
There is a command group 'az_apic_service'. This group of commands could 'manage an azure api center service instance'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_service_list'.The syntax is: az apic service list [--max-items]
[--next-token]
[--resource-group]. The 1th example of the child command would be to use it to 'list services in resource group', the syntax is: az apic service list -g contoso-resources. The parameter '--max-items' is optional. total number of items to return in the command's output. if the total number of items available is more than the value specified, a token is provided in the command's output. to resume pagination, provide the token value in `--next-token` argument of a subsequent command.. The parameter '--next-token' is optional. token to specify where to start paginating. this is the token value from a previously truncated response.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/apic/service.yml |
There is a command group 'az_apic_service'. This group of commands could 'manage an azure api center service instance'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_service_show'.The syntax is: az apic service show [--ids]
[--name]
[--resource-group]
[--subscription]. The 1th example of the child command would be to use it to 'show service details', the syntax is: az apic service show -g contoso-resources -s contoso. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--name --service --service-name -s' is optional. the name of the api center service.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. | database/apic/service.yml |
There is a command group 'az_apic_service'. This group of commands could 'manage an azure api center service instance'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_service_update'.The syntax is: az apic service update [--identity]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--tags]. The 1th example of the child command would be to use it to 'update service details', the syntax is: az apic service update -g contoso-resources -s contoso. The parameter '--identity' is optional. the managed service identities assigned to this resource. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--name --service --service-name -s' is optional. the name of azure api center service.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--tags' is optional. resource tags. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. | database/apic/service.yml |
There is a command group 'az_apic_environment'. This group of commands could 'commands to manage environments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_environment_create'.The syntax is: az apic environment create --environment-id
--resource-group
--service
--title
--type {development, production, staging, testing}
[--custom-properties]
[--description]
[--onboarding]
[--server]. The 1th example of the child command would be to use it to 'create environment', the syntax is: az apic environment create -g api-center-test -s contosoeuap --environment-id public --title "Public cloud" --type "development". The parameter '--environment-id' is required. It is used to the id of the environment.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--title' is required. It is used to environment title.. The parameter '--type' is required. It is used to environment type.. The parameter '--custom-properties' is optional. the custom metadata defined for api catalog entities. support json-file and yaml-file.. The parameter '--description' is optional. environment description.. The parameter '--onboarding' is optional. provide onboarding documentation related to your environment, e.g. {developerportaluri:['https://developer.contoso.com'],instructions:'instructions markdown'} support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--server' is optional. server information of the environment. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. | database/apic/environment.yml |
There is a command group 'az_apic_environment'. This group of commands could 'commands to manage environments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_environment_delete'.The syntax is: az apic environment delete [--environment-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--yes]. The 1th example of the child command would be to use it to 'delete environment', the syntax is: az apic environment delete -g api-center-test -s contosoeuap --environment-id public. The parameter '--environment-id' is optional. the id of the environment.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/apic/environment.yml |
There is a command group 'az_apic_environment'. This group of commands could 'commands to manage environments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_environment_list'.The syntax is: az apic environment list --resource-group
--service
[--filter]
[--max-items]
[--next-token]. The 1th example of the child command would be to use it to 'list environments', the syntax is: az apic environment list -g api-center-test -s contosoeuap. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--filter' is optional. odata filter parameter.. The parameter '--max-items' is optional. total number of items to return in the command's output. if the total number of items available is more than the value specified, a token is provided in the command's output. to resume pagination, provide the token value in `--next-token` argument of a subsequent command.. The parameter '--next-token' is optional. token to specify where to start paginating. this is the token value from a previously truncated response.. | database/apic/environment.yml |
There is a command group 'az_apic_environment'. This group of commands could 'commands to manage environments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_environment_show'.The syntax is: az apic environment show [--environment-id]
[--ids]
[--resource-group]
[--service]
[--subscription]. The 1th example of the child command would be to use it to 'show environment details', the syntax is: az apic environment show -g api-center-test -s contosoeuap --environment-id public. The parameter '--environment-id' is optional. the id of the environment.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. | database/apic/environment.yml |
There is a command group 'az_apic_environment'. This group of commands could 'commands to manage environments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_environment_update'.The syntax is: az apic environment update [--add]
[--custom-properties]
[--description]
[--environment-id]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--onboarding]
[--remove]
[--resource-group]
[--server]
[--service]
[--set]
[--subscription]
[--title]
[--type {development, production, staging, testing}]. The 1th example of the child command would be to use it to 'update environment', the syntax is: az apic environment update -g api-center-test -s contosoeuap --environment-id public --title "Public cloud". The parameter '--add' is optional. add an object to a list of objects by specifying a path and key value pairs. example: --add property.listproperty <key=value, string or json string>.. The parameter '--custom-properties' is optional. the custom metadata defined for api catalog entities. support json-file and yaml-file.. The parameter '--description' is optional. description.. The parameter '--environment-id' is optional. the id of the environment.. The parameter '--force-string' is optional. when using 'set' or 'add', preserve string literals instead of attempting to convert to json.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--onboarding' is optional. {developerportaluri:['https://developer.contoso.com'],instructions:'instructions markdown'} support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--remove' is optional. remove a property or an element from a list. example: --remove property.list <indextoremove> or --remove propertytoremove.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--server' is optional. server information of the environment. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--set' is optional. update an object by specifying a property path and value to set. example: --set property1.property2=<value>.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--title' is optional. environment title.. The parameter '--type' is optional. environment type.. | database/apic/environment.yml |
There is a command group 'az_apic_api_version'. This group of commands could 'commands to manage api versions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_version_create'.The syntax is: az apic api version create --api-id
--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
--resource-group
--service
--title
--version-id. The 1th example of the child command would be to use it to 'create api version', the syntax is: az apic api version create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01". The parameter '--api-id' is required. It is used to the id of the api.. The parameter '--lifecycle-stage' is required. It is used to current lifecycle stage of the api.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--title' is required. It is used to api version.. The parameter '--version-id' is required. It is used to the id of the api version.. | database/apic/api/version.yml |
There is a command group 'az_apic_api_version'. This group of commands could 'commands to manage api versions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_version_delete'.The syntax is: az apic api version delete [--api-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--version-id]
[--yes]. The 1th example of the child command would be to use it to 'delete api version', the syntax is: az apic api version delete -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01. The parameter '--api-id' is optional. the id of the api.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--version-id' is optional. the id of the api version.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/apic/api/version.yml |
There is a command group 'az_apic_api_version'. This group of commands could 'commands to manage api versions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_version_list'.The syntax is: az apic api version list --api-id
--resource-group
--service
[--filter]
[--max-items]
[--next-token]. The 1th example of the child command would be to use it to 'list api versions', the syntax is: az apic api version list -g api-center-test -s contosoeuap --api-id echo-api. The parameter '--api-id' is required. It is used to the id of the api.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--filter' is optional. odata filter parameter.. The parameter '--max-items' is optional. total number of items to return in the command's output. if the total number of items available is more than the value specified, a token is provided in the command's output. to resume pagination, provide the token value in `--next-token` argument of a subsequent command.. The parameter '--next-token' is optional. token to specify where to start paginating. this is the token value from a previously truncated response.. | database/apic/api/version.yml |
There is a command group 'az_apic_api_version'. This group of commands could 'commands to manage api versions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_version_show'.The syntax is: az apic api version show [--api-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--version-id]. The 1th example of the child command would be to use it to 'show api version details', the syntax is: az apic api version show -g api-center-test -s contoso --api-id echo-api --version-id 2023-01-01. The parameter '--api-id' is optional. the id of the api.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--version-id' is optional. the id of the api version.. | database/apic/api/version.yml |
There is a command group 'az_apic_api_version'. This group of commands could 'commands to manage api versions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_version_update'.The syntax is: az apic api version update [--add]
[--api-id]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
[--remove]
[--resource-group]
[--service]
[--set]
[--subscription]
[--title]
[--version-id]. The 1th example of the child command would be to use it to 'update api version', the syntax is: az apic api version update -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01". The parameter '--add' is optional. add an object to a list of objects by specifying a path and key value pairs. example: --add property.listproperty <key=value, string or json string>.. The parameter '--api-id' is optional. the id of the api.. The parameter '--force-string' is optional. when using 'set' or 'add', preserve string literals instead of attempting to convert to json.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--lifecycle-stage' is optional. current lifecycle stage of the api.. The parameter '--remove' is optional. remove a property or an element from a list. example: --remove property.list <indextoremove> or --remove propertytoremove.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--set' is optional. update an object by specifying a property path and value to set. example: --set property1.property2=<value>.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--title' is optional. api version.. The parameter '--version-id' is optional. the id of the api version.. | database/apic/api/version.yml |
There is a command group 'az_apic_api_deployment'. This group of commands could 'commands to manage api deployments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_deployment_create'.The syntax is: az apic api deployment create --api-id
--deployment-id
--resource-group
--service
[--custom-properties]
[--definition-id]
[--description]
[--environment-id]
[--server]
[--state {active, inactive}]
[--title]. The 1th example of the child command would be to use it to 'create deployment', the syntax is: az apic api deployment create -g api-center-test -s contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'. The parameter '--api-id' is required. It is used to the id of the api.. The parameter '--deployment-id' is required. It is used to the id of the api deployment.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--custom-properties' is optional. the custom metadata defined for api catalog entities. support json-file and yaml-file.. The parameter '--definition-id' is optional. api center-scoped definition resource id.. The parameter '--description' is optional. description of the deployment.. The parameter '--environment-id' is optional. api center-scoped environment resource id.. The parameter '--server' is optional. server support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--state' is optional. state of api deployment.. The parameter '--title' is optional. deployment title.. | database/apic/api/deployment.yml |
There is a command group 'az_apic_api_deployment'. This group of commands could 'commands to manage api deployments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_deployment_delete'.The syntax is: az apic api deployment delete [--api-id]
[--deployment-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--yes]. The 1th example of the child command would be to use it to 'delete api deployment', the syntax is: az apic api deployment delete -g api-center-test -s contoso --deployment-id production --api-id echo-api. The parameter '--api-id' is optional. the id of the api.. The parameter '--deployment-id' is optional. the id of the api deployment.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/apic/api/deployment.yml |
There is a command group 'az_apic_api_deployment'. This group of commands could 'commands to manage api deployments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_deployment_list'.The syntax is: az apic api deployment list --api-id
--resource-group
--service
[--filter]
[--max-items]
[--next-token]. The 1th example of the child command would be to use it to 'list api deployments', the syntax is: az apic api deployment list -g api-center-test -s contoso --api-id echo-api. The parameter '--api-id' is required. It is used to the id of the api.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--filter' is optional. odata filter parameter.. The parameter '--max-items' is optional. total number of items to return in the command's output. if the total number of items available is more than the value specified, a token is provided in the command's output. to resume pagination, provide the token value in `--next-token` argument of a subsequent command.. The parameter '--next-token' is optional. token to specify where to start paginating. this is the token value from a previously truncated response.. | database/apic/api/deployment.yml |
There is a command group 'az_apic_api_deployment'. This group of commands could 'commands to manage api deployments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_deployment_show'.The syntax is: az apic api deployment show [--api-id]
[--deployment-id]
[--ids]
[--resource-group]
[--service]
[--subscription]. The 1th example of the child command would be to use it to 'show api deployment details', the syntax is: az apic api deployment show -g api-center-test -s contoso --deployment-id production --api-id echo-api. The parameter '--api-id' is optional. the id of the api.. The parameter '--deployment-id' is optional. the id of the api deployment.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. | database/apic/api/deployment.yml |
There is a command group 'az_apic_api_deployment'. This group of commands could 'commands to manage api deployments in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_deployment_update'.The syntax is: az apic api deployment update [--add]
[--api-id]
[--custom-properties]
[--definition-id]
[--deployment-id]
[--description]
[--environment-id]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--server]
[--service]
[--set]
[--state {active, inactive}]
[--subscription]
[--title]. The 1th example of the child command would be to use it to 'update api deployment', the syntax is: az apic api deployment update -g api-center-test -s contoso --deployment-id production --title "Production deployment" --api-id echo-api. The parameter '--add' is optional. add an object to a list of objects by specifying a path and key value pairs. example: --add property.listproperty <key=value, string or json string>.. The parameter '--api-id' is optional. the id of the api.. The parameter '--custom-properties' is optional. the custom metadata defined for api catalog entities. support json-file and yaml-file.. The parameter '--definition-id' is optional. service-scoped definition resource id.. The parameter '--deployment-id' is optional. the id of the api deployment.. The parameter '--description' is optional. description of the deployment.. The parameter '--environment-id' is optional. service-scoped environment resource id.. The parameter '--force-string' is optional. when using 'set' or 'add', preserve string literals instead of attempting to convert to json.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--remove' is optional. remove a property or an element from a list. example: --remove property.list <indextoremove> or --remove propertytoremove.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--server' is optional. server support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--set' is optional. update an object by specifying a property path and value to set. example: --set property1.property2=<value>.. The parameter '--state' is optional. state of api deployment.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--title' is optional. title.. | database/apic/api/deployment.yml |
There is a command group 'az_apic_api_definition'. This group of commands could 'commands to manage api definitions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_definition_create'.The syntax is: az apic api definition create --api-id
--definition-id
--resource-group
--service
--title
--version-id
[--description]. The 1th example of the child command would be to use it to 'create api definition', the syntax is: az apic api definition create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI". The parameter '--api-id' is required. It is used to the id of the api.. The parameter '--definition-id' is required. It is used to the id of the api definition.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--title' is required. It is used to api version.. The parameter '--version-id' is required. It is used to the id of the api version.. The parameter '--description' is optional. api definition description.. | database/apic/api/definition.yml |
There is a command group 'az_apic_api_definition'. This group of commands could 'commands to manage api definitions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_definition_delete'.The syntax is: az apic api definition delete [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--version-id]
[--yes]. The 1th example of the child command would be to use it to 'delete api definition', the syntax is: az apic api definition delete -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi". The parameter '--api-id' is optional. the id of the api.. The parameter '--definition-id' is optional. the id of the api definition.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--version-id' is optional. the id of the api version.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/apic/api/definition.yml |
There is a command group 'az_apic_api_definition'. This group of commands could 'commands to manage api definitions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_definition_export specification'.The syntax is: az apic api definition export-specification --file-name
[--api-id]
[--definition-id]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service]
[--subscription]
[--version-id]. The 1th example of the child command would be to use it to 'export specification', the syntax is: az apic api version definition export-specification -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default. The parameter '--file-name' is required. It is used to name of the file where to export the spec to.. The parameter '--api-id' is optional. the id of the api.. The parameter '--definition-id' is optional. the id of the api definition.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--version-id' is optional. the id of the api version.. | database/apic/api/definition.yml |
There is a command group 'az_apic_api_definition'. This group of commands could 'commands to manage api definitions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_definition_import specification'.The syntax is: az apic api definition import-specification [--api-id]
[--definition-id]
[--file-name]
[--format {inline, link}]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--service]
[--specification]
[--subscription]
[--value]
[--version-id]. The 1th example of the child command would be to use it to 'import specification example 1', the syntax is: az apic api definition import-specification -g api-center-test -s contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'. The 2th example of the child command would be to use it to 'import specification example 2', the syntax is: az apic api definition import-specification -g api-center-test -s contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'. The parameter '--api-id' is optional. the id of the api.. The parameter '--definition-id' is optional. the id of the api definition.. The parameter '--file-name' is optional. name of the file from where to import the spec from.. The parameter '--format' is optional. format of the api specification source.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--specification' is optional. api specification details. support shorthand-syntax, json-file and yaml-file. try "??" to show more.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--value' is optional. value of the api specification source.. The parameter '--version-id' is optional. the id of the api version.. | database/apic/api/definition.yml |
There is a command group 'az_apic_api_definition'. This group of commands could 'commands to manage api definitions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_definition_list'.The syntax is: az apic api definition list --api-id
--resource-group
--service
--version-id
[--filter]
[--max-items]
[--next-token]. The 1th example of the child command would be to use it to 'list api definitions', the syntax is: az apic api definition list -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01. The parameter '--api-id' is required. It is used to the id of the api.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is required. It is used to the name of the api center service.. The parameter '--version-id' is required. It is used to the id of the api version.. The parameter '--filter' is optional. odata filter parameter.. The parameter '--max-items' is optional. total number of items to return in the command's output. if the total number of items available is more than the value specified, a token is provided in the command's output. to resume pagination, provide the token value in `--next-token` argument of a subsequent command.. The parameter '--next-token' is optional. token to specify where to start paginating. this is the token value from a previously truncated response.. | database/apic/api/definition.yml |
There is a command group 'az_apic_api_definition'. This group of commands could 'commands to manage api definitions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_definition_show'.The syntax is: az apic api definition show [--api-id]
[--definition-id]
[--ids]
[--resource-group]
[--service]
[--subscription]
[--version-id]. The 1th example of the child command would be to use it to 'show api definition details', the syntax is: az apic api definition show -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi". The parameter '--api-id' is optional. the id of the api.. The parameter '--definition-id' is optional. the id of the api definition.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--version-id' is optional. the id of the api version.. | database/apic/api/definition.yml |
There is a command group 'az_apic_api_definition'. This group of commands could 'commands to manage api definitions in api center'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_apic_api_definition_update'.The syntax is: az apic api definition update [--add]
[--api-id]
[--definition-id]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--remove]
[--resource-group]
[--service]
[--set]
[--subscription]
[--title]
[--version-id]. The 1th example of the child command would be to use it to 'update api definition', the syntax is: az apic api definition update -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI". The parameter '--add' is optional. add an object to a list of objects by specifying a path and key value pairs. example: --add property.listproperty <key=value, string or json string>.. The parameter '--api-id' is optional. the id of the api.. The parameter '--definition-id' is optional. the id of the api definition.. The parameter '--description' is optional. api definition description.. The parameter '--force-string' is optional. when using 'set' or 'add', preserve string literals instead of attempting to convert to json.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--remove' is optional. remove a property or an element from a list. example: --remove property.list <indextoremove> or --remove propertytoremove.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--service --service-name -s' is optional. the name of the api center service.. The parameter '--set' is optional. update an object by specifying a property path and value to set. example: --set property1.property2=<value>.. The parameter '--subscription' is optional. name or id of subscription. you can configure the default subscription using `az account set -s name_or_id`.. The parameter '--title' is optional. api version title.. The parameter '--version-id' is optional. the id of the api version.. | database/apic/api/definition.yml |
There is a command group 'az_ad_group'. This group of commands could 'manage microsoft entra groups'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_create'.The syntax is: az ad group create --display-name
--mail-nickname
[--description]
[--force {false, true}]. The 1th example of the child command would be to use it to 'create a group in the directory autogenerated', the syntax is: az ad group create --display-name MyDisplay --mail-nickname MyDisplay. The parameter '--display-name' is required. It is used to object's display name or its prefix.. The parameter '--mail-nickname' is required. It is used to mail nickname.. The parameter '--description' is optional. group description.. The parameter '--force' is optional. always create a new group instead of updating the one with same display and mail nickname.. | database/ad/group.yml |
There is a command group 'az_ad_group'. This group of commands could 'manage microsoft entra groups'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_delete'.The syntax is: az ad group delete --group. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. | database/ad/group.yml |
There is a command group 'az_ad_group'. This group of commands could 'manage microsoft entra groups'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_get member groups'.The syntax is: az ad group get-member-groups --group
[--security-enabled-only {false, true}]. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. The parameter '--security-enabled-only' is optional. true to specify that only security groups that the entity is a member of should be returned; false to specify that all groups and directory roles that the entity is a member of should be returned.. | database/ad/group.yml |
There is a command group 'az_ad_group'. This group of commands could 'manage microsoft entra groups'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_list'.The syntax is: az ad group list [--display-name]
[--filter]. The parameter '--display-name' is optional. object's display name or its prefix.. The parameter '--filter' is optional. odata filter, e.g. --filter "displayname eq 'test' and serviceprincipaltype eq 'application'".. | database/ad/group.yml |
There is a command group 'az_ad_group'. This group of commands could 'manage microsoft entra groups'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_show'.The syntax is: az ad group show --group. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. | database/ad/group.yml |
There is a command group 'az_ad_signed in user'. This group of commands could 'show graph information about current signed in user in cli'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_signed in user_list owned objects'.The syntax is: az ad signed-in-user list-owned-objects [--type]. The parameter '--type -t' is optional. object type filter, e.g. "application", "serviceprincipal" "group", etc.. | database/ad/signed-in-user.yml |
There is a command group 'az_ad_signed in user'. This group of commands could 'show graph information about current signed in user in cli'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_signed in user_show'.The syntax is: az ad signed-in-user show. | database/ad/signed-in-user.yml |
There is a command group 'az_ad_ds'. This group of commands could 'manage domain service with azure active directory'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_ds_create'.The syntax is: az ad ds create --domain
--name
--replica-sets
--resource-group
[--domain-config-type {fullysynced, resourcetrusting}]
[--external-access {disabled, enabled}]
[--filtered-sync {disabled, enabled}]
[--ldaps {disabled, enabled}]
[--no-wait]
[--notify-dc-admins {disabled, enabled}]
[--notify-global-admins {disabled, enabled}]
[--notify-others]
[--ntlm-v1 {disabled, enabled}]
[--pfx-cert]
[--pfx-cert-pwd]
[--resource-forest {disabled, enabled}]
[--settings]
[--sku {enterprise, premium, standard}]
[--sync-kerberos-pwd {disabled, enabled}]
[--sync-ntlm-pwd {disabled, enabled}]
[--sync-on-prem-pwd {disabled, enabled}]
[--tags]
[--tls-v1 {disabled, enabled}]. The 1th example of the child command would be to use it to 'create domain service', the syntax is: az ad ds create --domain "TestDS.com" --replica-sets location="West US" subnet-id="<subnetId>" --name "TestDS.com" --resource-group "rg". The 2th example of the child command would be to use it to 'create domain service with specified settings line breaks for legibility only', the syntax is: az ad ds create --domain "TestDS.com" --replica-sets location="West US" subnet-id="<subnetId>" --name "TestDS.com" --resource-group "rg"
--ntlm-v1 "Enabled" --sync-ntlm-pwd "Enabled" --tls-v1 "Disabled" --filtered-sync "Enabled" --external-access "Enabled"
--ldaps "Enabled" --pfx-cert "cert or path to cert" --pfx-cert-pwd "<pfxCertificatePassword>"
--notify-others "a@gmail.com" "b@gmail.com" --notify-dc-admins "Enabled" --notify-global-admins "Enabled". The parameter '--domain' is required. It is used to the name of the azure domain that the user would like to deploy domain services to.. The parameter '--name -n' is required. It is used to the name of the domain service.. The parameter '--replica-sets' is required. It is used to list of replicasets.. The parameter '--resource-group -g' is required. It is used to name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--domain-config-type' is optional. domain configuration type.. The parameter '--external-access' is optional. a flag to determine whether or not secure ldap access over the internet is enabled or disabled.. The parameter '--filtered-sync' is optional. enabled or disabled flag to turn on group-based filtered sync.. The parameter '--ldaps' is optional. a flag to determine whether or not secure ldap is enabled or disabled.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--notify-dc-admins' is optional. should domain controller admins be notified.. The parameter '--notify-global-admins' is optional. should global admins be notified.. The parameter '--notify-others' is optional. the list of additional recipients.. The parameter '--ntlm-v1' is optional. a flag to determine whether or not ntlmv1 is enabled or disabled.. The parameter '--pfx-cert' is optional. the certificate required to configure secure ldap. the parameter passed here should be the file path to the certificate pfx file or a base64encoded representation of the certificate pfx file.. The parameter '--pfx-cert-pwd' is optional. the password to decrypt the provided secure ldap certificate pfx file.. The parameter '--resource-forest' is optional. resource forest.. The parameter '--settings' is optional. list of settings for resource forest. this can be either a json-formatted string or the location to a file containing the json object.. The parameter '--sku' is optional. sku type.. The parameter '--sync-kerberos-pwd' is optional. a flag to determine whether or not synckerberospasswords is enabled or disabled.. The parameter '--sync-ntlm-pwd' is optional. a flag to determine whether or not syncntlmpasswords is enabled or disabled.. The parameter '--sync-on-prem-pwd' is optional. a flag to determine whether or not synconprempasswords is enabled or disabled.. The parameter '--tags' is optional. space-separated tags: key[=value] [key[=value] ...]. use "" to clear existing tags.. The parameter '--tls-v1' is optional. a flag to determine whether or not tlsv1 is enabled or disabled.. | database/ad/ds.yml |
There is a command group 'az_ad_ds'. This group of commands could 'manage domain service with azure active directory'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_ds_delete'.The syntax is: az ad ds delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--yes]. The 1th example of the child command would be to use it to 'delete domain service', the syntax is: az ad ds delete --name "TestDomainService.com" --resource-group "TestResourceGroup". The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--name -n' is optional. the name of the domain service.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--yes -y' is optional. do not prompt for confirmation.. | database/ad/ds.yml |
There is a command group 'az_ad_ds'. This group of commands could 'manage domain service with azure active directory'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_ds_list'.The syntax is: az ad ds list [--resource-group]. The 1th example of the child command would be to use it to 'list domain service by group', the syntax is: az ad ds list --resource-group "TestResourceGroup". The 2th example of the child command would be to use it to 'list domain service by sub', the syntax is: az ad ds list. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/ad/ds.yml |
There is a command group 'az_ad_ds'. This group of commands could 'manage domain service with azure active directory'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_ds_show'.The syntax is: az ad ds show [--ids]
[--name]
[--resource-group]. The 1th example of the child command would be to use it to 'get domain service', the syntax is: az ad ds show --name "TestDomainService.com" --resource-group "TestResourceGroup". The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--name -n' is optional. the name of the domain service.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. | database/ad/ds.yml |
There is a command group 'az_ad_ds'. This group of commands could 'manage domain service with azure active directory'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_ds_update'.The syntax is: az ad ds update [--domain-config-type {fullysynced, resourcetrusting}]
[--external-access {disabled, enabled}]
[--filtered-sync {disabled, enabled}]
[--ids]
[--ldaps {disabled, enabled}]
[--name]
[--no-wait]
[--notify-dc-admins {disabled, enabled}]
[--notify-global-admins {disabled, enabled}]
[--notify-others]
[--ntlm-v1 {disabled, enabled}]
[--pfx-cert]
[--pfx-cert-pwd]
[--replica-sets]
[--resource-forest {disabled, enabled}]
[--resource-group]
[--settings]
[--sku {enterprise, premium, standard}]
[--sync-kerberos-pwd {disabled, enabled}]
[--sync-ntlm-pwd {disabled, enabled}]
[--sync-on-prem-pwd {disabled, enabled}]
[--tags]
[--tls-v1 {disabled, enabled}]. The 1th example of the child command would be to use it to 'update sku', the syntax is: az ad ds update --name "TestDS.com" --resource-group "rg" --sku "Enterprise". The 2th example of the child command would be to use it to 'update domain security settings', the syntax is: az ad ds update --name "TestDS.com" --resource-group "rg" --ntlm-v1 "Enabled" --tls-v1 "Disabled". The 3th example of the child command would be to use it to 'update ldaps settings', the syntax is: az ad ds update --name "TestDS.com" --resource-group "rg" --external-access "Enabled" --ldaps "Enabled" --pfx-cert "MIIDPDCCAiSg..." --pfx-cert-pwd "<pfxCertificatePassword>". The 4th example of the child command would be to use it to 'update notification settings', the syntax is: az ad ds update --name "TestDS.com" --resource-group "rg" --notify-dc-admins "Enabled" --notify-global-admins "Disabled". The parameter '--domain-config-type' is optional. domain configuration type.. The parameter '--external-access' is optional. a flag to determine whether or not secure ldap access over the internet is enabled or disabled.. The parameter '--filtered-sync' is optional. enabled or disabled flag to turn on group-based filtered sync.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--ldaps' is optional. a flag to determine whether or not secure ldap is enabled or disabled.. The parameter '--name -n' is optional. the name of the domain service.. The parameter '--no-wait' is optional. do not wait for the long-running operation to finish.. The parameter '--notify-dc-admins' is optional. should domain controller admins be notified.. The parameter '--notify-global-admins' is optional. should global admins be notified.. The parameter '--notify-others' is optional. the list of additional recipients.. The parameter '--ntlm-v1' is optional. a flag to determine whether or not ntlmv1 is enabled or disabled.. The parameter '--pfx-cert' is optional. the certificate required to configure secure ldap. the parameter passed here should be the file path to the certificate pfx file or a base64encoded representation of the certificate pfx file.. The parameter '--pfx-cert-pwd' is optional. the password to decrypt the provided secure ldap certificate pfx file.. The parameter '--replica-sets' is optional. list of replicasets.. The parameter '--resource-forest' is optional. resource forest.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--settings' is optional. list of settings for resource forest. this can be either a json-formatted string or the location to a file containing the json object.. The parameter '--sku' is optional. sku type.. The parameter '--sync-kerberos-pwd' is optional. a flag to determine whether or not synckerberospasswords is enabled or disabled.. The parameter '--sync-ntlm-pwd' is optional. a flag to determine whether or not syncntlmpasswords is enabled or disabled.. The parameter '--sync-on-prem-pwd' is optional. a flag to determine whether or not synconprempasswords is enabled or disabled.. The parameter '--tags' is optional. space-separated tags: key[=value] [key[=value] ...]. use "" to clear existing tags.. The parameter '--tls-v1' is optional. a flag to determine whether or not tlsv1 is enabled or disabled.. | database/ad/ds.yml |
There is a command group 'az_ad_ds'. This group of commands could 'manage domain service with azure active directory'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_ds_wait'.The syntax is: az ad ds wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--timeout]
[--updated]. The 1th example of the child command would be to use it to 'pause executing next line of cli script until the ad ds is successfully created', the syntax is: az ad ds wait --name "TestDomainService.com" --resource-group "TestResourceGroup" --created. The 2th example of the child command would be to use it to 'pause executing next line of cli script until the ad ds is successfully updated', the syntax is: az ad ds wait --name "TestDomainService.com" --resource-group "TestResourceGroup" --updated. The 3th example of the child command would be to use it to 'pause executing next line of cli script until the ad ds is successfully deleted', the syntax is: az ad ds wait --name "TestDomainService.com" --resource-group "TestResourceGroup" --deleted. The parameter '--created' is optional. wait until created with 'provisioningstate' at 'succeeded'.. The parameter '--custom' is optional. wait until the condition satisfies a custom jmespath query. e.g. provisioningstate!='inprogress', instanceview.statuses[?code=='powerstate/running'].. The parameter '--deleted' is optional. wait until deleted.. The parameter '--exists' is optional. wait until the resource exists.. The parameter '--ids' is optional. one or more resource ids (space-delimited). it should be a complete resource id containing all information of 'resource id' arguments. you should provide either --ids or other 'resource id' arguments.. The parameter '--interval' is optional. polling interval in seconds.. The parameter '--name -n' is optional. the name of the domain service.. The parameter '--resource-group -g' is optional. name of resource group. you can configure the default group using `az configure --defaults group=<name>`.. The parameter '--timeout' is optional. maximum wait in seconds.. The parameter '--updated' is optional. wait until updated with provisioningstate at 'succeeded'.. | database/ad/ds.yml |
There is a command group 'az_ad_sp'. This group of commands could 'manage microsoft entra service principals'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_create'.The syntax is: az ad sp create --id. The 1th example of the child command would be to use it to 'create a service principal autogenerated', the syntax is: az ad sp create --id 00000000-0000-0000-0000-000000000000. The parameter '--id' is required. It is used to identifier uri, application id, or object id of the associated application.. | database/ad/sp.yml |
There is a command group 'az_ad_sp'. This group of commands could 'manage microsoft entra service principals'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_create for rbac'.The syntax is: az ad sp create-for-rbac [--cert]
[--create-cert]
[--display-name]
[--json-auth {false, true}]
[--keyvault]
[--role]
[--scopes]
[--years]. The 1th example of the child command would be to use it to 'create without role assignment', the syntax is: az ad sp create-for-rbac. The 2th example of the child command would be to use it to 'create using a custom display name', the syntax is: az ad sp create-for-rbac -n MyApp. The 3th example of the child command would be to use it to 'create with a contributor role assignments on specified scopes to retrieve current subscription id run az account show query id output tsv', the syntax is: az ad sp create-for-rbac -n MyApp --role Contributor --scopes /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup2. The 4th example of the child command would be to use it to 'create using a self signed certificate', the syntax is: az ad sp create-for-rbac --create-cert. The 5th example of the child command would be to use it to 'create using a self signed certificate and store it within keyvault', the syntax is: az ad sp create-for-rbac --keyvault MyVault --cert CertName --create-cert. The 6th example of the child command would be to use it to 'create using existing certificate in keyvault', the syntax is: az ad sp create-for-rbac --keyvault MyVault --cert CertName. The parameter '--cert' is optional. certificate to use for credentials. when used with `--keyvault,`, indicates the name of the cert to use or create. otherwise, supply a pem or der formatted public certificate string. use `@{path}` to load from a file. do not include private key info.. The parameter '--create-cert' is optional. create a self-signed certificate to use for the credential. only the current os user has read/write permission to this certificate. use with `--keyvault` to create the certificate in key vault. otherwise, a certificate will be created locally.. The parameter '--display-name --name -n' is optional. display name of the service principal. if not present, default to azure-cli-%y-%m-%d-%h-%m-%s where the suffix is the time of creation.. The parameter '--json-auth --sdk-auth' is optional. output service principal credential along with cloud endpoints in json format.. The parameter '--keyvault' is optional. name or id of a keyvault to use for creating or retrieving certificates.. The parameter '--role' is optional. role of the service principal.. The parameter '--scopes' is optional. space-separated list of scopes the service principal's role assignment applies to. e.g., subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourcegroups/mygroup, /subscriptions/0b1f6471-1bf0-4dda-aec3-111122223333/resourcegroups/mygroup/providers/microsoft.compute/virtualmachines/myvm.. The parameter '--years' is optional. number of years for which the credentials will be valid. default: 1 year.. | database/ad/sp.yml |
There is a command group 'az_ad_sp'. This group of commands could 'manage microsoft entra service principals'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_delete'.The syntax is: az ad sp delete --id. The 1th example of the child command would be to use it to 'delete a service principal', the syntax is: az ad sp delete --id 00000000-0000-0000-0000-000000000000. The parameter '--id' is required. It is used to service principal name, or object id.. | database/ad/sp.yml |
There is a command group 'az_ad_sp'. This group of commands could 'manage microsoft entra service principals'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_list'.The syntax is: az ad sp list [--all]
[--display-name]
[--filter]
[--show-mine]
[--spn]. The parameter '--all' is optional. list all entities, expect long delay if under a big organization.. The parameter '--display-name' is optional. object's display name or its prefix.. The parameter '--filter' is optional. odata filter, e.g. --filter "displayname eq 'test' and serviceprincipaltype eq 'application'".. The parameter '--show-mine' is optional. list entities owned by the current user.. The parameter '--spn' is optional. service principal name.. | database/ad/sp.yml |
There is a command group 'az_ad_sp'. This group of commands could 'manage microsoft entra service principals'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_show'.The syntax is: az ad sp show --id. The 1th example of the child command would be to use it to 'get the details of a service principal with appid', the syntax is: az ad sp show --id 00000000-0000-0000-0000-000000000000. The 2th example of the child command would be to use it to 'get the details of a service principal with id', the syntax is: az ad sp show --id 00000000-0000-0000-0000-000000000000. The 3th example of the child command would be to use it to 'get the details of a service principal with identifier uri', the syntax is: az ad sp show --id api://myapp. The parameter '--id' is required. It is used to service principal name, or object id.. | database/ad/sp.yml |
There is a command group 'az_ad_sp'. This group of commands could 'manage microsoft entra service principals'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_update'.The syntax is: az ad sp update --id
[--add]
[--force-string]
[--remove]
[--set]. The 1th example of the child command would be to use it to 'update a service principal autogenerated', the syntax is: az ad sp update --id 00000000-0000-0000-0000-000000000000 --set groupMembershipClaims=All. The parameter '--id' is required. It is used to service principal name, or object id.. The parameter '--add' is optional. add an object to a list of objects by specifying a path and key value pairs. example: `--add property.listproperty <key=value, string or json string>`.. The parameter '--force-string' is optional. when using 'set' or 'add', preserve string literals instead of attempting to convert to json.. The parameter '--remove' is optional. remove a property or an element from a list. example: `--remove property.list <indextoremove>` or `--remove propertytoremove`.. The parameter '--set' is optional. update an object by specifying a property path and value to set. example: `--set property1.property2=<value>`.. | database/ad/sp.yml |
There is a command group 'az_ad_app'. This group of commands could 'manage microsoft entra applications'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_app_create'.The syntax is: az ad app create --display-name
[--app-roles]
[--enable-access-token-issuance {false, true}]
[--enable-id-token-issuance {false, true}]
[--end-date]
[--identifier-uris]
[--is-fallback-public-client {false, true}]
[--key-display-name]
[--key-type {asymmetricx509cert, password, symmetric}]
[--key-usage {sign, verify}]
[--key-value]
[--optional-claims]
[--public-client-redirect-uris]
[--required-resource-accesses]
[--sign-in-audience {azureadmultipleorgs, azureadmyorg, azureadandpersonalmicrosoftaccount, personalmicrosoftaccount}]
[--start-date]
[--web-home-page-url]
[--web-redirect-uris]. The 1th example of the child command would be to use it to 'create an application', the syntax is: az ad app create --display-name mytestapp. The 2th example of the child command would be to use it to 'create an application that can fall back to public client with microsoft graph delegated permission user read', the syntax is: az ad app create --display-name my-public --is-fallback-public-client --required-resource-accesses @manifest.json
("manifest.json" contains the following content)
[{
"resourceAppId": "00000003-0000-0000-c000-000000000000",
"resourceAccess": [
{
"id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
"type": "Scope"
}
]
}]. The 3th example of the child command would be to use it to 'create an application with a role', the syntax is: az ad app create --display-name mytestapp --identifier-uris https://mytestapp.websites.net --app-roles @manifest.json
("manifest.json" contains the following content)
[{
"allowedMemberTypes": [
"User"
],
"description": "Approvers can mark documents as approved",
"displayName": "Approver",
"isEnabled": "true",
"value": "approver"
}]. The 4th example of the child command would be to use it to 'create an application with optional claims', the syntax is: az ad app create --display-name mytestapp --optional-claims @manifest.json
("manifest.json" contains the following content)
{
"idToken": [
{
"name": "auth_time",
"essential": false
}
],
"accessToken": [
{
"name": "ipaddr",
"essential": false
}
],
"saml2Token": [
{
"name": "upn",
"essential": false
},
{
"name": "extension_ab603c56068041afb2f6832e2a17e237_skypeId",
"source": "user",
"essential": false
}
]
}. The parameter '--display-name' is required. It is used to the display name of the application.. The parameter '--app-roles' is optional. the collection of roles assigned to the application. with app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. should be json file path or in-line json string. see examples for details.. The parameter '--enable-access-token-issuance' is optional. specifies whether this web application can request an access token using the oauth 2.0 implicit flow.. The parameter '--enable-id-token-issuance' is optional. specifies whether this web application can request an id token using the oauth 2.0 implicit flow.. The parameter '--end-date' is optional. date or datetime after which credentials expire (e.g. '2017-12-31t11:59:59+00:00' or '2017-12-31'). default value is one year after current time.. The parameter '--identifier-uris' is optional. space-separated values. also known as app id uri, this value is set when an application is used as a resource app. the identifieruris acts as the prefix for the scopes you'll reference in your api's code, and it must be globally unique. you can use the default value provided, which is in the form api://<application-client-id>, or specify a more readable uri like https://contoso.com/api.. The parameter '--is-fallback-public-client' is optional. specifies the fallback application type as public client, such as an installed application running on a mobile device. the default value is false which means the fallback application type is confidential client such as a web app.. The parameter '--key-display-name' is optional. friendly name for the key.. The parameter '--key-type' is optional. the type of the key credentials associated with the application.. The parameter '--key-usage' is optional. the usage of the key credentials associated with the application.. The parameter '--key-value' is optional. the value for the key credentials associated with the application.. The parameter '--optional-claims' is optional. application developers can configure optional claims in their microsoft entra applications to specify the claims that are sent to their application by the microsoft security token service. for more information, see https://docs.microsoft.com/azure/active-directory/develop/active-directory-optional-claims. should be json file path or in-line json string. see examples for details.. The parameter '--public-client-redirect-uris' is optional. space-separated values. specifies the urls where user tokens are sent for sign-in, or the redirect uris where oauth 2.0 authorization codes and access tokens are sent.. The parameter '--required-resource-accesses' is optional. specifies the resources that the application needs to access. this property also specifies the set of delegated permissions and application roles that it needs for each of those resources. this configuration of access to the required resources drives the consent experience. should be json file path or in-line json string. see examples for details.. The parameter '--sign-in-audience' is optional. specifies the microsoft accounts that are supported for the current application.. The parameter '--start-date' is optional. date or datetime at which credentials become valid (e.g. '2017-01-01t01:00:00+00:00' or '2017-01-01'). default value is current time.. The parameter '--web-home-page-url' is optional. home page or landing page of the application.. The parameter '--web-redirect-uris' is optional. space-separated values. specifies the urls where user tokens are sent for sign-in, or the redirect uris where oauth 2.0 authorization codes and access tokens are sent.. | database/ad/app.yml |
There is a command group 'az_ad_app'. This group of commands could 'manage microsoft entra applications'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_app_delete'.The syntax is: az ad app delete --id. The 1th example of the child command would be to use it to 'delete an application autogenerated', the syntax is: az ad app delete --id 00000000-0000-0000-0000-000000000000. The parameter '--id' is required. It is used to identifier uri, application id, or object id.. | database/ad/app.yml |
There is a command group 'az_ad_app'. This group of commands could 'manage microsoft entra applications'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_app_list'.The syntax is: az ad app list [--all]
[--app-id]
[--display-name]
[--filter]
[--identifier-uri]
[--show-mine]. The parameter '--all' is optional. list all entities, expect long delay if under a big organization.. The parameter '--app-id' is optional. application id.. The parameter '--display-name' is optional. the display name of the application.. The parameter '--filter' is optional. odata filter, e.g. --filter "displayname eq 'test' and serviceprincipaltype eq 'application'".. The parameter '--identifier-uri' is optional. graph application identifier, must be in uri format.. The parameter '--show-mine' is optional. list entities owned by the current user.. | database/ad/app.yml |
There is a command group 'az_ad_app'. This group of commands could 'manage microsoft entra applications'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_app_show'.The syntax is: az ad app show --id. The 1th example of the child command would be to use it to 'get the details of an application with appid', the syntax is: az ad app show --id 00000000-0000-0000-0000-000000000000. The 2th example of the child command would be to use it to 'get the details of an application with id', the syntax is: az ad app show --id 00000000-0000-0000-0000-000000000000. The 3th example of the child command would be to use it to 'get the details of an application with identifier uri', the syntax is: az ad app show --id api://myapp. The parameter '--id' is required. It is used to identifier uri, application id, or object id.. | database/ad/app.yml |
There is a command group 'az_ad_app'. This group of commands could 'manage microsoft entra applications'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_app_update'.The syntax is: az ad app update --id
[--add]
[--app-roles]
[--display-name]
[--enable-access-token-issuance {false, true}]
[--enable-id-token-issuance {false, true}]
[--end-date]
[--force-string]
[--identifier-uris]
[--is-fallback-public-client {false, true}]
[--key-display-name]
[--key-type {asymmetricx509cert, password, symmetric}]
[--key-usage {sign, verify}]
[--key-value]
[--optional-claims]
[--public-client-redirect-uris]
[--remove]
[--required-resource-accesses]
[--set]
[--sign-in-audience {azureadmultipleorgs, azureadmyorg, azureadandpersonalmicrosoftaccount, personalmicrosoftaccount}]
[--start-date]
[--web-home-page-url]
[--web-redirect-uris]. The 1th example of the child command would be to use it to 'update an application with microsoft graph delegated permission user read', the syntax is: az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --required-resource-accesses @manifest.json
("manifest.json" contains the following content)
[{
"resourceAppId": "00000003-0000-0000-c000-000000000000",
"resourceAccess": [
{
"id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
"type": "Scope"
}
]
}]. The 2th example of the child command would be to use it to 'declare an application role', the syntax is: az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --app-roles @manifest.json
("manifest.json" contains the following content)
[{
"allowedMemberTypes": [
"User"
],
"description": "Approvers can mark documents as approved",
"displayName": "Approver",
"isEnabled": "true",
"value": "approver"
}]. The 3th example of the child command would be to use it to 'update optional claims', the syntax is: az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --optional-claims @manifest.json
("manifest.json" contains the following content)
{
"idToken": [
{
"name": "auth_time",
"essential": false
}
],
"accessToken": [
{
"name": "ipaddr",
"essential": false
}
],
"saml2Token": [
{
"name": "upn",
"essential": false
},
{
"name": "extension_ab603c56068041afb2f6832e2a17e237_skypeId",
"source": "user",
"essential": false
}
]
}. The 4th example of the child command would be to use it to 'update an application s group membership claims to all', the syntax is: az ad app update --id e042ec79-34cd-498f-9d9f-123456781234 --set groupMembershipClaims=All. The parameter '--id' is required. It is used to identifier uri, application id, or object id.. The parameter '--add' is optional. add an object to a list of objects by specifying a path and key value pairs. example: `--add property.listproperty <key=value, string or json string>`.. The parameter '--app-roles' is optional. the collection of roles assigned to the application. with app role assignments, these roles can be assigned to users, groups, or service principals associated with other applications. should be json file path or in-line json string. see examples for details.. The parameter '--display-name' is optional. the display name of the application.. The parameter '--enable-access-token-issuance' is optional. specifies whether this web application can request an access token using the oauth 2.0 implicit flow.. The parameter '--enable-id-token-issuance' is optional. specifies whether this web application can request an id token using the oauth 2.0 implicit flow.. The parameter '--end-date' is optional. date or datetime after which credentials expire (e.g. '2017-12-31t11:59:59+00:00' or '2017-12-31'). default value is one year after current time.. The parameter '--force-string' is optional. when using 'set' or 'add', preserve string literals instead of attempting to convert to json.. The parameter '--identifier-uris' is optional. space-separated values. also known as app id uri, this value is set when an application is used as a resource app. the identifieruris acts as the prefix for the scopes you'll reference in your api's code, and it must be globally unique. you can use the default value provided, which is in the form api://<application-client-id>, or specify a more readable uri like https://contoso.com/api.. The parameter '--is-fallback-public-client' is optional. specifies the fallback application type as public client, such as an installed application running on a mobile device. the default value is false which means the fallback application type is confidential client such as a web app.. The parameter '--key-display-name' is optional. friendly name for the key.. The parameter '--key-type' is optional. the type of the key credentials associated with the application.. The parameter '--key-usage' is optional. the usage of the key credentials associated with the application.. The parameter '--key-value' is optional. the value for the key credentials associated with the application.. The parameter '--optional-claims' is optional. application developers can configure optional claims in their microsoft entra applications to specify the claims that are sent to their application by the microsoft security token service. for more information, see https://docs.microsoft.com/azure/active-directory/develop/active-directory-optional-claims. should be json file path or in-line json string. see examples for details.. The parameter '--public-client-redirect-uris' is optional. space-separated values. specifies the urls where user tokens are sent for sign-in, or the redirect uris where oauth 2.0 authorization codes and access tokens are sent.. The parameter '--remove' is optional. remove a property or an element from a list. example: `--remove property.list <indextoremove>` or `--remove propertytoremove`.. The parameter '--required-resource-accesses' is optional. specifies the resources that the application needs to access. this property also specifies the set of delegated permissions and application roles that it needs for each of those resources. this configuration of access to the required resources drives the consent experience. should be json file path or in-line json string. see examples for details.. The parameter '--set' is optional. update an object by specifying a property path and value to set. example: `--set property1.property2=<value>`.. The parameter '--sign-in-audience' is optional. specifies the microsoft accounts that are supported for the current application.. The parameter '--start-date' is optional. date or datetime at which credentials become valid (e.g. '2017-01-01t01:00:00+00:00' or '2017-01-01'). default value is current time.. The parameter '--web-home-page-url' is optional. home page or landing page of the application.. The parameter '--web-redirect-uris' is optional. space-separated values. specifies the urls where user tokens are sent for sign-in, or the redirect uris where oauth 2.0 authorization codes and access tokens are sent.. | database/ad/app.yml |
There is a command group 'az_ad_user'. This group of commands could 'manage microsoft entra users'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_user_create'.The syntax is: az ad user create --display-name
--password
--user-principal-name
[--force-change-password-next-sign-in {false, true}]
[--immutable-id]
[--mail-nickname]. The 1th example of the child command would be to use it to 'create a user', the syntax is: az ad user create --display-name myuser --password password --user-principal-name myuser@contoso.com. The parameter '--display-name' is required. It is used to object's display name or its prefix.. The parameter '--password' is required. It is used to the password that should be assigned to the user for authentication.. The parameter '--user-principal-name' is required. It is used to the user principal name (someuser@contoso.com). it must contain one of the verified domains for the tenant.. The parameter '--force-change-password-next-sign-in' is optional. marks this user as needing to update their password the next time they authenticate. if omitted, false will be used.. The parameter '--immutable-id' is optional. this property is used to associate an on-premises active directory user account to their microsoft entra user object. this property must be specified when creating a new user account in the graph if you're using a federated domain for the user's userprincipalname (upn) property. note: the $ and _ characters can't be used when specifying this property.. The parameter '--mail-nickname' is optional. mail alias. defaults to user principal name.. | database/ad/user.yml |
There is a command group 'az_ad_user'. This group of commands could 'manage microsoft entra users'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_user_delete'.The syntax is: az ad user delete --id. The 1th example of the child command would be to use it to 'delete a user', the syntax is: az ad user delete --id myuser@contoso.com. The parameter '--id' is required. It is used to the object id or principal name of the user for which to get information.. | database/ad/user.yml |
There is a command group 'az_ad_user'. This group of commands could 'manage microsoft entra users'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_user_get member groups'.The syntax is: az ad user get-member-groups --id
[--security-enabled-only {false, true}]. The 1th example of the child command would be to use it to 'get groups of which the user is a member', the syntax is: az ad user get-member-groups --id myuser@contoso.com. The parameter '--id' is required. It is used to the object id or principal name of the user for which to get information.. The parameter '--security-enabled-only' is optional. true to specify that only security groups that the entity is a member of should be returned; false to specify that all groups and directory roles that the entity is a member of should be returned.. | database/ad/user.yml |
There is a command group 'az_ad_user'. This group of commands could 'manage microsoft entra users'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_user_list'.The syntax is: az ad user list [--display-name]
[--filter]
[--upn]. The 1th example of the child command would be to use it to 'list all users', the syntax is: az ad user list. The parameter '--display-name' is optional. object's display name or its prefix.. The parameter '--filter' is optional. odata filter, e.g. --filter "displayname eq 'test' and serviceprincipaltype eq 'application'".. The parameter '--upn' is optional. user principal name, e.g. john.doe@contoso.com.. | database/ad/user.yml |
There is a command group 'az_ad_user'. This group of commands could 'manage microsoft entra users'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_user_show'.The syntax is: az ad user show --id. The 1th example of the child command would be to use it to 'show a user', the syntax is: az ad user show --id myuser@contoso.com. The parameter '--id' is required. It is used to the object id or principal name of the user for which to get information.. | database/ad/user.yml |
There is a command group 'az_ad_user'. This group of commands could 'manage microsoft entra users'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_user_update'.The syntax is: az ad user update --id
[--account-enabled {false, true}]
[--display-name]
[--force-change-password-next-sign-in {false, true}]
[--mail-nickname]
[--password]. The 1th example of the child command would be to use it to 'update a user', the syntax is: az ad user update --id myuser@contoso.com --display-name username2. The parameter '--id' is required. It is used to the object id or principal name of the user for which to get information.. The parameter '--account-enabled' is optional. enable the user account.. The parameter '--display-name' is optional. object's display name or its prefix.. The parameter '--force-change-password-next-sign-in' is optional. if the user must change her password on the next login.. The parameter '--mail-nickname' is optional. mail alias. defaults to user principal name.. The parameter '--password' is optional. user password.. | database/ad/user.yml |
There is a command group 'az_ad_sp_credential'. This group of commands could 'manage a service principal s password or certificate credentials'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_credential_delete'.The syntax is: az ad sp credential delete --id
--key-id
[--cert]. The 1th example of the child command would be to use it to 'delete a service principal s password credential', the syntax is: az ad sp credential delete --id 00000000-0000-0000-0000-000000000000 --key-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. The 2th example of the child command would be to use it to 'delete a service principal s certificate credential', the syntax is: az ad sp credential delete --id 00000000-0000-0000-0000-000000000000 --key-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --cert. The parameter '--id' is required. It is used to service principal name, or object id.. The parameter '--key-id' is required. It is used to credential key id.. The parameter '--cert' is optional. operate on certificate credentials.. | database/ad/sp/credential.yml |
There is a command group 'az_ad_sp_credential'. This group of commands could 'manage a service principal s password or certificate credentials'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_credential_list'.The syntax is: az ad sp credential list --id
[--cert]. The 1th example of the child command would be to use it to 'list a service principal s password credentials', the syntax is: az ad sp credential list --id 00000000-0000-0000-0000-000000000000. The 2th example of the child command would be to use it to 'list a service principal s certificate credentials', the syntax is: az ad sp credential list --id 00000000-0000-0000-0000-000000000000 --cert. The parameter '--id' is required. It is used to service principal name, or object id.. The parameter '--cert' is optional. operate on certificate credentials.. | database/ad/sp/credential.yml |
There is a command group 'az_ad_sp_credential'. This group of commands could 'manage a service principal s password or certificate credentials'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_credential_reset'.The syntax is: az ad sp credential reset --id
[--append]
[--cert]
[--create-cert]
[--display-name]
[--end-date]
[--keyvault]
[--years]. The 1th example of the child command would be to use it to 'reset a service principal s credential with a password', the syntax is: az ad sp credential reset --id 00000000-0000-0000-0000-000000000000. The 2th example of the child command would be to use it to 'reset a service principal s credential with a new self signed certificate', the syntax is: az ad sp credential reset --id 00000000-0000-0000-0000-000000000000 --create-cert. The 3th example of the child command would be to use it to 'append a certificate to the service principal with the certificate string', the syntax is: az ad sp credential reset --id 00000000-0000-0000-0000-000000000000 --cert "MIICoT..." --append. The 4th example of the child command would be to use it to 'append a certificate to the service principal with the certificate file', the syntax is: az ad sp credential reset --id 00000000-0000-0000-0000-000000000000 --cert "@~/cert.pem" --append
`cert.pem` contains the following content
-----BEGIN CERTIFICATE----- <<< this line is optional
MIICoT...
-----END CERTIFICATE----- <<< this line is optional. The parameter '--id' is required. It is used to service principal name, or object id.. The parameter '--append' is optional. append the new credential instead of overwriting.. The parameter '--cert' is optional. certificate to use for credentials. when used with `--keyvault,`, indicates the name of the cert to use or create. otherwise, supply a pem or der formatted public certificate string. use `@{path}` to load from a file. do not include private key info.. The parameter '--create-cert' is optional. create a self-signed certificate to use for the credential. only the current os user has read/write permission to this certificate. use with `--keyvault` to create the certificate in key vault. otherwise, a certificate will be created locally.. The parameter '--display-name' is optional. friendly name for the credential.. The parameter '--end-date' is optional. finer grain of expiry time if '--years' is insufficient, e.g. '2020-12-31t11:59:59+00:00' or '2299-12-31'.. The parameter '--keyvault' is optional. name or id of a keyvault to use for creating or retrieving certificates.. The parameter '--years' is optional. number of years for which the credentials will be valid. default: 1 year.. | database/ad/sp/credential.yml |
There is a command group 'az_ad_sp_owner'. This group of commands could 'manage service principal owners'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_sp_owner_list'.The syntax is: az ad sp owner list --id. The 1th example of the child command would be to use it to 'list service principal owners autogenerated', the syntax is: az ad sp owner list --id 00000000-0000-0000-0000-000000000000. The parameter '--id' is required. It is used to service principal name, or object id or the service principal.. | database/ad/sp/owner.yml |
There is a command group 'az_ad_group_owner'. This group of commands could 'manage group owners'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_owner_add'.The syntax is: az ad group owner add --group
--owner-object-id. The 1th example of the child command would be to use it to 'add a group owner autogenerated', the syntax is: az ad group owner add --group MyGroupDisplayName --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. The parameter '--owner-object-id' is required. It is used to owner's object id.. | database/ad/group/owner.yml |
There is a command group 'az_ad_group_owner'. This group of commands could 'manage group owners'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_owner_list'.The syntax is: az ad group owner list --group. The 1th example of the child command would be to use it to 'list group owners autogenerated', the syntax is: az ad group owner list --group MyGroupDisplayName. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. | database/ad/group/owner.yml |
There is a command group 'az_ad_group_owner'. This group of commands could 'manage group owners'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_owner_remove'.The syntax is: az ad group owner remove --group
--owner-object-id. The 1th example of the child command would be to use it to 'remove a group owner autogenerated', the syntax is: az ad group owner remove --group MyGroupDisplayName --owner-object-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. The parameter '--owner-object-id' is required. It is used to owner's object id.. | database/ad/group/owner.yml |
There is a command group 'az_ad_group_member'. This group of commands could 'manage group members'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_member_add'.The syntax is: az ad group member add --group
--member-id. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. The parameter '--member-id' is required. It is used to the object id of the contact, group, user, or service principal.. | database/ad/group/member.yml |
There is a command group 'az_ad_group_member'. This group of commands could 'manage group members'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_member_check'.The syntax is: az ad group member check --group
--member-id. The 1th example of the child command would be to use it to 'check if a member is in a group autogenerated', the syntax is: az ad group member check --group MyGroupDisplayName --member-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. The parameter '--member-id' is required. It is used to the object id of the contact, group, user, or service principal.. | database/ad/group/member.yml |
There is a command group 'az_ad_group_member'. This group of commands could 'manage group members'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_member_list'.The syntax is: az ad group member list --group. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. | database/ad/group/member.yml |
There is a command group 'az_ad_group_member'. This group of commands could 'manage group members'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_group_member_remove'.The syntax is: az ad group member remove --group
--member-id. The parameter '--group -g' is required. It is used to group's object id or display name(prefix also works if there is a unique match).. The parameter '--member-id' is required. It is used to the object id of the contact, group, user, or service principal.. | database/ad/group/member.yml |
There is a command group 'az_ad_app_credential'. This group of commands could 'manage an application s password or certificate credentials'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_app_credential_delete'.The syntax is: az ad app credential delete --id
--key-id
[--cert]. The 1th example of the child command would be to use it to 'delete an application s password credentials', the syntax is: az ad app credential delete --id 00000000-0000-0000-0000-000000000000 --key-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. The 2th example of the child command would be to use it to 'delete an application s certificate credentials', the syntax is: az ad app credential delete --id 00000000-0000-0000-0000-000000000000 --key-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --cert. The parameter '--id' is required. It is used to identifier uri, application id, or object id.. The parameter '--key-id' is required. It is used to credential key id.. The parameter '--cert' is optional. operate on certificate credentials.. | database/ad/app/credential.yml |
There is a command group 'az_ad_app_credential'. This group of commands could 'manage an application s password or certificate credentials'. The group of commands has global parameter '--debug' which means 'Increase logging verbosity to show all debug logs.'. The group of commands has global parameter '--help -h' which means 'Show this help message and exit.'. The group of commands has global parameter '--only-show-errors' which means 'Only show errors, suppressing warnings.'. The group of commands has global parameter '--output -o' which means 'Output format.'. The group of commands has global parameter '--query' which means 'JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.'. The group of commands has global parameter '--subscription' which means 'Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.'. The group of commands has global parameter '--verbose' which means 'Increase logging verbosity. Use --debug for full debug logs.'. This group contains a child command 'az_ad_app_credential_list'.The syntax is: az ad app credential list --id
[--cert]. The 1th example of the child command would be to use it to 'list an application s password credentials', the syntax is: az ad app credential list --id 00000000-0000-0000-0000-000000000000. The 2th example of the child command would be to use it to 'list an application s certificate credentials', the syntax is: az ad app credential list --id 00000000-0000-0000-0000-000000000000 --cert. The parameter '--id' is required. It is used to identifier uri, application id, or object id.. The parameter '--cert' is optional. operate on certificate credentials.. | database/ad/app/credential.yml |