az mission community community-endpoint

Note

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

Manage Community Endpoint.

Commands

Name Description Type Status
az mission community community-endpoint create

Create a CommunityEndpointResource.

 Extension GA
az mission community community-endpoint delete

Delete a CommunityEndpointResource.

 Extension GA
az mission community community-endpoint list

List CommunityEndpointResource resources by subscription ID.

 Extension GA
az mission community community-endpoint show

Get a CommunityEndpointResource.

 Extension GA
az mission community community-endpoint update

Update a CommunityEndpointResource.

 Extension GA
az mission community community-endpoint wait

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

 Extension GA

az mission community community-endpoint create

Create a CommunityEndpointResource.

az mission community community-endpoint create --community-endpoint-name --name
                                               --community-name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--location]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--rule-collection]
                                               [--tags]
                                               [--update-mode {Automatic, Manual}]

Examples

CommunityEndpoints_CreateOrUpdate

az mission community community-endpoint create --resource-group rgopenapi --community-name TestMyCommunity --community-endpoint-name TestMyCommunityEndpoint --rule-collection "[{destination-type:FQDNTag,destination:foo.example.com,ports:443,protocols:[TCP],transit-hub-resource-id:/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/testrg/providers/Microsoft.Mission/communities/TestMyCommunity/transitHubs/TestThName}]" --update-mode Automatic --tags "{sampletag:samplevalue}" --location West US

Required Parameters

--community-endpoint-name --name -n

The name of the Community Endpoint Resource.

--community-name

The name of the communityResource Resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Resource 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
--rule-collection

Community Endpoint Rule Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
--update-mode

Whether update mode is automatic or manual.

Property Value
Parameter group: Properties Arguments
Accepted values: Automatic, Manual
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 mission community community-endpoint delete

Delete a CommunityEndpointResource.

az mission community community-endpoint delete [--acquire-policy-token]
                                               [--change-reference]
                                               [--community-endpoint-name --name]
                                               [--community-name]
                                               [--ids]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]
                                               [--yes]

Examples

CommunityEndpoints_Delete

az mission community community-endpoint delete --resource-group rgopenapi --community-name TestMyCommunity --community-endpoint-name TestMyCommunityEndpoint

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
--community-endpoint-name --name -n

The name of the Community Endpoint Resource.

Property Value
Parameter group: Resource Id Arguments
--community-name

The name of the communityResource Resource.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id 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
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--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.

--verbose

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

Property Value
Default value: False

az mission community community-endpoint list

List CommunityEndpointResource resources by subscription ID.

az mission community community-endpoint list --community-name
                                             [--max-items]
                                             [--next-token]
                                             [--resource-group]

Examples

CommunityEndpoints_ListBySubscription

az mission community community-endpoint list --community-name TestMyCommunity

CommunityEndpoints_ListByCommunityResource

az mission community community-endpoint list --resource-group rgopenapi --community-name TestMyCommunity

Required Parameters

--community-name

The name of the communityResource 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
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 mission community community-endpoint show

Get a CommunityEndpointResource.

az mission community community-endpoint show [--community-endpoint-name --name]
                                             [--community-name]
                                             [--ids]
                                             [--resource-group]
                                             [--subscription]

Examples

CommunityEndpoints_Get

az mission community community-endpoint show --resource-group rgopenapi --community-name TestMyCommunity --community-endpoint-name TestMyCommunityEndpoint

Optional Parameters

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

--community-endpoint-name --name -n

The name of the Community Endpoint Resource.

Property Value
Parameter group: Resource Id Arguments
--community-name

The name of the communityResource Resource.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id 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.

--verbose

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

Property Value
Default value: False

az mission community community-endpoint update

Update a CommunityEndpointResource.

az mission community community-endpoint update [--acquire-policy-token]
                                               [--add]
                                               [--change-reference]
                                               [--community-endpoint-name --name]
                                               [--community-name]
                                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--ids]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--remove]
                                               [--resource-group]
                                               [--rule-collection]
                                               [--set]
                                               [--subscription]
                                               [--tags]
                                               [--update-mode {Automatic, Manual}]

Examples

CommunityEndpoints_CreateOrUpdate

az mission community community-endpoint update --resource-group rgopenapi --community-name TestMyCommunity --community-endpoint-name TestMyCommunityEndpoint

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
--community-endpoint-name --name -n

The name of the Community Endpoint Resource.

Property Value
Parameter group: Resource Id Arguments
--community-name

The name of the communityResource Resource.

Property Value
Parameter group: Resource Id 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
--ids

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.

Property Value
Parameter group: Resource Id 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
--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
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--rule-collection

Community Endpoint Rule Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
--update-mode

Whether update mode is automatic or manual.

Property Value
Parameter group: Properties Arguments
Accepted values: Automatic, Manual
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.

--verbose

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

Property Value
Default value: False

az mission community community-endpoint wait

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

az mission community community-endpoint wait [--acquire-policy-token]
                                             [--change-reference]
                                             [--community-endpoint-name --name]
                                             [--community-name]
                                             [--created]
                                             [--custom]
                                             [--deleted]
                                             [--exists]
                                             [--ids]
                                             [--interval]
                                             [--resource-group]
                                             [--subscription]
                                             [--timeout]
                                             [--updated]

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
--community-endpoint-name --name -n

The name of the Community Endpoint Resource.

Property Value
Parameter group: Resource Id Arguments
--community-name

The name of the communityResource Resource.

Property Value
Parameter group: Resource Id 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
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--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.

--verbose

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

Property Value
Default value: False