az mission community
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 command. Learn more about extensions.
Manage Community.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az mission community check-address-space-availability |
Checks that the IP Address Space to be allocated for this Community is available. |
Extension | GA |
| az mission community community-endpoint |
Manage Community Endpoint. |
Extension | GA |
| 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 create |
Create a CommunityResource. |
Extension | GA |
| az mission community dedicated-hub |
Manage Dedicated Hub. |
Extension | GA |
| az mission community dedicated-hub create |
Create a DedicatedHubResource. |
Extension | GA |
| az mission community dedicated-hub delete |
Delete a DedicatedHubResource. |
Extension | GA |
| az mission community dedicated-hub list |
List DedicatedHubResource resources by subscription ID. |
Extension | GA |
| az mission community dedicated-hub show |
Get a DedicatedHubResource. |
Extension | GA |
| az mission community dedicated-hub update |
Update a DedicatedHubResource. |
Extension | GA |
| az mission community dedicated-hub wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az mission community delete |
Delete a CommunityResource. |
Extension | GA |
| az mission community identity |
Manage Identity. |
Extension | GA |
| az mission community identity assign |
Assign the user or system managed identities. |
Extension | GA |
| az mission community identity remove |
Remove the user or system managed identities. |
Extension | GA |
| az mission community identity show |
Show the details of managed identities. |
Extension | GA |
| az mission community identity wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az mission community list |
List CommunityResource resources by subscription ID. |
Extension | GA |
| az mission community show |
Get a CommunityResource. |
Extension | GA |
| az mission community transit-hub |
Manage Transit Hub. |
Extension | GA |
| az mission community transit-hub create |
Create a TransitHubResource. |
Extension | GA |
| az mission community transit-hub delete |
Delete a TransitHubResource. |
Extension | GA |
| az mission community transit-hub list |
List TransitHubResource resources by subscription ID. |
Extension | GA |
| az mission community transit-hub show |
Get a TransitHubResource. |
Extension | GA |
| az mission community transit-hub update |
Update a TransitHubResource. |
Extension | GA |
| az mission community transit-hub wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az mission community update |
Update a CommunityResource. |
Extension | GA |
| az mission community wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az mission community check-address-space-availability
Checks that the IP Address Space to be allocated for this Community is available.
az mission community check-address-space-availability --community-resource-id
--enclave-virtual-network
[--acquire-policy-token]
[--change-reference]
[--community-name]
[--ids]
[--resource-group]
[--subscription]
Examples
Community_CheckAddressSpaceAvailability
az mission community check-address-space-availability --resource-group rgopenapi --community-name TestMyCommunity --community-resource-id /subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/Microsoft.Mission/communities/TestMyCommunity --enclave-virtual-network "{network-size:small,custom-cidr-range:10.0.0.0/24,subnet-configurations:[{subnet-name:test,network-prefix-size:26}],allow-subnet-communication:True}"
Required Parameters
Resource Id of the Community.
| Property | Value |
|---|---|
| Parameter group: | CheckAddressSpaceAvailabilityRequest Arguments |
Information about the enclave virtual network Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | CheckAddressSpaceAvailabilityRequest 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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The name of the communityResource Resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az mission community create
Create a CommunityResource.
az mission community create --community-name --name
--resource-group
[--acquire-policy-token]
[--address-space]
[--address-spaces]
[--approval-settings]
[--change-reference]
[--community-role-assignments]
[--dns-servers]
[--firewall-sku {Basic, Premium, Standard}]
[--governed-service-list]
[--location]
[--maintenance-mode-configuration]
[--mi-system-assigned --system-assigned]
[--mi-user-assigned --user-assigned]
[--monitoring-settings]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--policy-override {Enclave, None}]
[--tags]
Examples
Community_CreateOrUpdate
az mission community create --resource-group rgopenapi --community-name TestMyCommunity --type SystemAssigned,UserAssigned --user-assigned-identities "{/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1:{}}" --address-space --dns-servers "[azure.net]" --governed-service-list "[{service-id:AKS,option:Allow,enforcement:Enabled,policy-action:None},{service-id:AppService,option:Allow,enforcement:Enabled,policy-action:None},{service-id:ContainerRegistry,option:Allow,enforcement:Enabled,policy-action:None},{service-id:CosmosDB,option:Allow,enforcement:Enabled,policy-action:None},{service-id:KeyVault,option:Allow,enforcement:Enabled,policy-action:None},{service-id:MicrosoftSQL,option:Allow,enforcement:Enabled,policy-action:None},{service-id:Monitoring,option:'Not Applicable',enforcement:Enabled,policy-action:None},{service-id:PostgreSQL,option:Allow,enforcement:Enabled,policy-action:None},{service-id:ServiceBus,option:Allow,enforcement:Enabled,policy-action:None},{service-id:Storage,option:Allow,enforcement:Enabled,policy-action:None},{service-id:AzureFirewalls,option:Allow,enforcement:Enabled,policy-action:None},{service-id:Insights,option:Allow,enforcement:Enabled,policy-action:None},{service-id:Logic,option:Allow,enforcement:Enabled,policy-action:None},{service-id:PrivateDNSZones,option:Allow,enforcement:Enabled,policy-action:None},{service-id:DataConnectors,option:Allow,enforcement:Enabled,policy-action:None}]" --community-role-assignments "[{role-definition-id:b24988ac-6180-42a0-ab88-20f7382dd24c,principals:[{id:01234567-89ab-ef01-2345-0123456789ab,type:Group},{id:355a6bb0-abc0-4cba-000d-12a345b678c0,type:User}],condition:'@RoleDefinition.Name StringNotEquals '/Owner'/'},{role-definition-id:18d7d88d-d35e-4fb5-a5c3-7773c20a72d9,principals:[{id:355a6bb0-abc0-4cba-000d-12a345b678c9,type:User}]}]" --approval-settings "{community-endpoint-update:{approvalPolicy:Required,minimumApproversRequired:2,mandatoryApprovers:[{approverEntraId:00000000-0000-0000-0000-000000000001}]},enclave-endpoint-update:{approvalPolicy:Required,minimumApproversRequired:1},enclave-creation:{approvalPolicy:NotRequired},connection-creation:{approvalPolicy:Required,minimumApproversRequired:1,mandatoryApprovers:[{approverEntraId:00000000-0000-0000-0000-000000000002}]},connection-update:{approvalPolicy:Required,minimumApproversRequired:1},community-maintenance-mode:{approvalPolicy:Required,minimumApproversRequired:2,mandatoryApprovers:[{approverEntraId:00000000-0000-0000-0000-000000000003},{approverEntraId:00000000-0000-0000-0000-000000000004}]},enclave-maintenance-mode:{approvalPolicy:NotRequired}}" --maintenance-mode-configuration "{mode:Off,principals:[{id:355a6bb0-abc0-4cba-000d-12a345b678c9,type:User}],justification:Off}" --firewall-sku Standard --monitoring-settings "{diagnostic-destinations:[{destinationType:CommunityWorkspace},{destinationType:EnclaveWorkspace,diagnosticSettingsName:customName},{destinationType:CustomWorkspace,customWorkspaceResourceId:/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/rgopenapi/providers/Microsoft.OperationalInsights/workspaces/CustomWorkspace,diagnosticSettingsName:customName},{destinationType:CustomWorkspace,customWorkspaceResourceId:/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/rgopenapi/providers/Microsoft.OperationalInsights/workspaces/CustomWorkspace,diagnosticSettingsName:customName}],flow-log-destination:{destinationType:CustomWorkspace,customWorkspaceResourceId:/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/rgopenapi/providers/Microsoft.OperationalInsights/workspaces/CustomWorkspace,diagnosticSettingsName:customName}}" --address-spaces "[10.0.0.0/16,10.1.0.0/16]" --tags "{sampletag:samplevalue}" --location westcentralus
Required Parameters
The name of the communityResource Resource.
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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Address Space.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Address spaces list Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Granular approval requirements for various actions on the community's resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Community role assignments Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
DNS Servers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Default value: | Standard |
| Accepted values: | Basic, Premium, Standard |
List of services governed by a community. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
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 |
Maintenance Mode configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Set the system managed identity.
| Property | Value |
|---|---|
| Parameter group: | Identity Arguments |
Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Identity Arguments |
Community Monitoring Settings for diagnostic and virtual network flow logs Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Enclave, None |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Resource Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az mission community delete
Delete a CommunityResource.
az mission community delete [--acquire-policy-token]
[--change-reference]
[--community-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Community_Delete
az mission community delete --resource-group rgopenapi --community-name TestMyCommunity
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The name of the communityResource Resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az mission community list
List CommunityResource resources by subscription ID.
az mission community list [--max-items]
[--next-token]
[--resource-group]
Examples
Community_ListBySubscription
az mission community list
Community_ListByResourceGroup
az mission community list --resource-group rgopenapi
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az mission community show
Get a CommunityResource.
az mission community show [--community-name --name]
[--ids]
[--resource-group]
[--subscription]
Examples
Community_Get
az mission community show --resource-group rgopenapi --community-name TestMyCommunity
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the communityResource Resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az mission community update
Update a CommunityResource.
az mission community update [--acquire-policy-token]
[--add]
[--address-spaces]
[--approval-settings]
[--change-reference]
[--community-name --name]
[--community-role-assignments]
[--dns-servers]
[--firewall-sku {Basic, Premium, Standard}]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--governed-service-list]
[--ids]
[--maintenance-mode-configuration]
[--monitoring-settings]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--policy-override {Enclave, None}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
Examples
Community_CreateOrUpdate
az mission community update --resource-group rgopenapi --community-name TestMyCommunity
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
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 |
Address spaces list Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Granular approval requirements for various actions on the community's resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The name of the communityResource Resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Community role assignments Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
DNS Servers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Basic, Premium, Standard |
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 |
List of services governed by a community. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
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 |
Maintenance Mode configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Community Monitoring Settings for diagnostic and virtual network flow logs Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Enclave, None |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.
| Property | Value |
|---|---|
| Parameter group: | Generic Update Arguments |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Resource Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az mission community wait
Place the CLI in a waiting state until a condition is met.
az mission community wait [--acquire-policy-token]
[--change-reference]
[--community-name --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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The name of the communityResource Resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Wait until created with 'provisioningState' at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Wait until deleted.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Wait until the resource exists.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Polling interval in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |