az napster companion-api

Note

This reference is part of the napster extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az napster companion-api command. Learn more about extensions.

Manage Companion Api.

Commands

Name Description Type Status
az napster companion-api activate-saas

Resolve the token to get the SaaS resource ID and activate the SaaS resource.

Extension GA
az napster companion-api organization

Manage Organization.

Extension GA
az napster companion-api organization create

Create a OrganizationResource.

Extension GA
az napster companion-api organization delete

Delete a OrganizationResource.

Extension GA
az napster companion-api organization latest-linked-saas

Returns the latest SaaS linked to the Napster organization of the underlying monitor.

Extension GA
az napster companion-api organization link-saas

Links a new SaaS to the Napster organization of the underlying monitor.

Extension GA
az napster companion-api organization list

List OrganizationResource resources by subscription ID.

Extension GA
az napster companion-api organization show

Get a OrganizationResource.

Extension GA
az napster companion-api organization update

Update a OrganizationResource.

Extension GA
az napster companion-api organization wait

Place the CLI in a waiting state until a condition is met.

Extension GA

az napster companion-api activate-saas

Resolve the token to get the SaaS resource ID and activate the SaaS resource.

az napster companion-api activate-saas --saas-guid
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--publisher-id]

Examples

SaaSOperationGroup_ActivateResource_MaximumSet - generated by [MaximumSet] rule

az napster companion-api activate-saas --saas-guid 09fffd7d-d000-4467-cc23-d82b97e9431d --publisher-id touchcastinc1655995956899

SaaSOperationGroup_ActivateResource_MinimumSet - generated by [MinimumSet] rule

az napster companion-api activate-saas --saas-guid 09fffd7d-d000-4467-cc23-d82b97e9431d --publisher-id touchcastinc1655995956899

Required Parameters

--saas-guid

SaaS guid for Activate and Validate SaaS Resource.

Property Value
Parameter group: Body Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--publisher-id

Publisher Id for Napster resource.

Property Value
Parameter group: Body Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False