Share via

az sig in-vm-access-control-profile-version

Manage in VM access control profile version.

Commands

Name Description Type Status
az sig in-vm-access-control-profile-version create

Create a gallery in VM access control profile version.

 Core GA
az sig in-vm-access-control-profile-version delete

Delete a gallery in VM access control profile version.

 Core GA
az sig in-vm-access-control-profile-version list

List gallery in VM access control profile versions in a gallery in VM access control profile.

 Core GA
az sig in-vm-access-control-profile-version show

Get information about a gallery in VM access control profile version.

 Core GA
az sig in-vm-access-control-profile-version update

Update a gallery in VM access control profile version.

 Core GA
az sig in-vm-access-control-profile-version wait

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

 Core GA

az sig in-vm-access-control-profile-version create

Create a gallery in VM access control profile version.

az sig in-vm-access-control-profile-version create --default-access {Allow, Deny}
                                                   --gallery-name
                                                   --mode {Audit, Disabled, Enforce}
                                                   --profile-name
                                                   --profile-version --version-name
                                                   --resource-group
                                                   [--exclude-from-latest {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--location]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--rules]
                                                   [--target-regions]

Examples

Create or update a Gallery in VM access control profile version.

az sig in-vm-access-control-profile-version create --resource-group myResourceGroup --gallery-name myGalleryName --profile-name myInVMAccessControlProfileName --profile-version 1.0.0 --location WestUS

Required Parameters

--default-access

This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'.

Property Value
Parameter group: Properties Arguments
Accepted values: Allow, Deny
--gallery-name

The name of the Shared Image Gallery in which the in VM access control profile resides.

--mode

This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'.

Property Value
Parameter group: Properties Arguments
Accepted values: Audit, Disabled, Enforce
--profile-name

The name of the gallery in VM access control profile in which the in VM access control profile version is to be created.

--profile-version --version-name

The name of the gallery in VM access control profile version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: MajorVersion.MinorVersion.Patch.

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

--exclude-from-latest

If set to true, Virtual Machines deployed from the latest version of the Resource Profile won't use this Profile version.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--location -l

Resource location When not specified, the location of the resource group will be used.

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

This is the Access Control Rules specification for an in VM access control profile version. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--target-regions

The target regions where the Resource Profile version is going to be replicated to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 sig in-vm-access-control-profile-version delete

Delete a gallery in VM access control profile version.

az sig in-vm-access-control-profile-version delete [--gallery-name]
                                                   [--ids]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--profile-name]
                                                   [--profile-version --version-name]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--yes]

Examples

Delete a gallery in VM access control profile version.

az sig in-vm-access-control-profile-version delete --resource-group myResourceGroup --gallery-name myGalleryName --profile-name myInVMAccessControlProfileName --profile-version 1.0.0

Optional Parameters

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

--gallery-name

The name of the Shared Image Gallery in which the in VM access control profile resides.

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

The name of the gallery in VM access control profile in which the in VM access control profile version is to be created.

Property Value
Parameter group: Resource Id Arguments
--profile-version --version-name

The name of the gallery in VM access control profile version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: MajorVersion.MinorVersion.Patch.

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
--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 sig in-vm-access-control-profile-version list

List gallery in VM access control profile versions in a gallery in VM access control profile.

az sig in-vm-access-control-profile-version list --gallery-name
                                                 --profile-name
                                                 --resource-group
                                                 [--max-items]
                                                 [--next-token]

Examples

List gallery in VM access control profile versions in a gallery in VM access control profile.

az sig in-vm-access-control-profile-version list --resource-group myResourceGroup --gallery-name myGalleryName --profile-name myInVMAccessControlProfileName

Required Parameters

--gallery-name

The name of the Shared Image Gallery in which the in VM access control profile resides.

--profile-name

The name of the gallery in VM access control profile from which the in VM access control profile versions are to be listed.

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

--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 sig in-vm-access-control-profile-version show

Get information about a gallery in VM access control profile version.

az sig in-vm-access-control-profile-version show [--gallery-name]
                                                 [--ids]
                                                 [--profile-name]
                                                 [--profile-version --version-name]
                                                 [--resource-group]
                                                 [--subscription]

Examples

Get a gallery in VM access control profile version.

az sig in-vm-access-control-profile-version show --resource-group myResourceGroup --gallery-name myGalleryName --profile-name myInVMAccessControlProfileName --profile-version 1.0.0

Optional Parameters

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

--gallery-name

The name of the Shared Image Gallery in which the in VM access control profile resides.

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

The name of the gallery in VM access control profile in which the in VM access control profile version is to be created.

Property Value
Parameter group: Resource Id Arguments
--profile-version --version-name

The name of the gallery in VM access control profile version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: MajorVersion.MinorVersion.Patch.

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 sig in-vm-access-control-profile-version update

Update a gallery in VM access control profile version.

az sig in-vm-access-control-profile-version update [--add]
                                                   [--default-access {Allow, Deny}]
                                                   [--exclude-from-latest {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--gallery-name]
                                                   [--ids]
                                                   [--mode {Audit, Disabled, Enforce}]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--profile-name]
                                                   [--profile-version --version-name]
                                                   [--remove]
                                                   [--resource-group]
                                                   [--set]
                                                   [--subscription]
                                                   [--target-regions]

Examples

Update a Gallery in VM access control profile version.

az sig in-vm-access-control-profile-version update --resource-group myResourceGroup --gallery-name myGalleryName --profile-name myInVMAccessControlProfileName --profile-version 1.0.0 --exclude-from-latest true

Optional Parameters

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

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

This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'.

Property Value
Parameter group: Properties Arguments
Accepted values: Allow, Deny
--exclude-from-latest

If set to true, Virtual Machines deployed from the latest version of the Resource Profile won't use this Profile version.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--gallery-name

The name of the Shared Image Gallery in which the in VM access control profile resides.

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

This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'.

Property Value
Parameter group: Properties Arguments
Accepted values: Audit, Disabled, Enforce
--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
--profile-name

The name of the gallery in VM access control profile in which the in VM access control profile version is to be created.

Property Value
Parameter group: Resource Id Arguments
--profile-version --version-name

The name of the gallery in VM access control profile version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: MajorVersion.MinorVersion.Patch.

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

The target regions where the Resource Profile version is going to be replicated to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 sig in-vm-access-control-profile-version wait

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

az sig in-vm-access-control-profile-version wait [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--gallery-name]
                                                 [--ids]
                                                 [--interval]
                                                 [--profile-name]
                                                 [--profile-version --version-name]
                                                 [--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.

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

The name of the Shared Image Gallery in which the in VM access control profile resides.

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

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--profile-name

The name of the gallery in VM access control profile in which the in VM access control profile version is to be created.

Property Value
Parameter group: Resource Id Arguments
--profile-version --version-name

The name of the gallery in VM access control profile version to be created. Needs to follow semantic version name pattern: The allowed characters are digit and period. Digits must be within the range of a 32-bit integer. Format: MajorVersion.MinorVersion.Patch.

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