az relationship service-group-member

Note

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

Manage serviceGroupMember relationships.

Commands

Name	Description	Type	Status
az relationship service-group-member create	Create a ServiceGroupMemberRelationship.	Extension	GA
az relationship service-group-member delete	Delete a ServiceGroupMemberRelationship.	Extension	GA
az relationship service-group-member list	List ServiceGroupMemberRelationship resources by parent.	Extension	GA
az relationship service-group-member show	Get a ServiceGroupMemberRelationship.	Extension	GA
az relationship service-group-member update	Update a ServiceGroupMemberRelationship.	Extension	GA
az relationship service-group-member wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az relationship service-group-member create

Create a ServiceGroupMemberRelationship.

az relationship service-group-member create --name
                                            --resource-uri
                                            --source-id
                                            [--acquire-policy-token]
                                            [--change-reference]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--source-tenant]

Required Parameters

--name

Name of ServiceGroupMember relationship.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

--source-id

The relationship source resource id. Must be a service group.

Property	Value
Parameter group:	Properties 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

--source-tenant

The relationship source tenant id.

Property	Value
Parameter group:	Properties 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

az relationship service-group-member delete

Delete a ServiceGroupMemberRelationship.

az relationship service-group-member delete --name
                                            --resource-uri
                                            [--acquire-policy-token]
                                            [--change-reference]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--yes]

Required Parameters

--name

Name of ServiceGroupMember relationship.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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

az relationship service-group-member list

List ServiceGroupMemberRelationship resources by parent.

az relationship service-group-member list --resource-uri
                                          [--max-items]
                                          [--next-token]

Required Parameters

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

Optional Parameters

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

--max-items

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.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination 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

az relationship service-group-member show

Get a ServiceGroupMemberRelationship.

az relationship service-group-member show --name
                                          --resource-uri

Required Parameters

--name

Name of ServiceGroupMember relationship.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

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

az relationship service-group-member update

Update a ServiceGroupMemberRelationship.

az relationship service-group-member update --name
                                            --resource-uri
                                            [--acquire-policy-token]
                                            [--add]
                                            [--change-reference]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--remove]
                                            [--set]
                                            [--source-id]
                                            [--source-tenant]

Examples

Update the Service Group source of a membership

az relationship service-group-member update --resource-uri "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" --name myMembership --source-id "/providers/Microsoft.Management/serviceGroups/mySG"

Required Parameters

--name

Name of ServiceGroupMember relationship.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

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

--add

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>.

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--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

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--source-id

The relationship source resource id. Must be a service group.

Property	Value
Parameter group:	Properties Arguments

--source-tenant

The relationship source tenant id.

Property	Value
Parameter group:	Properties 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

az relationship service-group-member wait

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

az relationship service-group-member wait --name
                                          --resource-uri
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--created]
                                          [--custom]
                                          [--deleted]
                                          [--exists]
                                          [--interval]
                                          [--timeout]
                                          [--updated]

Required Parameters

--name

Name of ServiceGroupMember relationship.

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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