다음을 통해 공유


Azure CLI 별칭 확장을 사용하는 방법

별칭 확장을 사용하면 사용자가 기존 명령을 사용하여 Azure CLI에 대한 사용자 지정 명령을 정의할 수 있습니다. 별칭은 바로 가기를 허용하여 워크플로를 단순하게 유지하는 데 도움이 됩니다. Jinja2 템플릿 엔진은 Azure CLI 별칭을 구동하고 고급 인수 처리를 제공합니다.

참고 항목

별칭 확장은 공개 미리 보기로 제공됩니다. 기능 및 구성 파일 형식이 변경 될 수 있습니다.

별칭 확장 설치

별칭 확장을 사용하는 데 필요한 최소 Azure CLI 버전은 2.0.28입니다. CLI 버전을 검사 실행az --version합니다. 설치를 업데이트해야 하는 경우 Azure CLI 설치의 지침을 따릅니다.

az extension add 명령을 사용하여 별칭 확장을 설치 합니다.

az extension add --name alias

az extension list를 사용하여 확장 설치를 확인합니다. 별칭 확장이 제대로 설치된 경우 명령 출력에 나열됩니다.

az extension list --output table --query '[].{Name:name}'
Name
------
alias

별칭 확장을 최신 상태로 유지

별칭 확장은 현재 개발 중이며 새 버전은 정기적으로 릴리스됩니다. CLI를 업데이트할 때는 새 버전이 설치되지 않습니다. az extension update를 사용하여 확장 에 대한 업데이트를 설치합니다.

az extension update --name alias

Azure CLI의 별칭 관리

별칭 확장을 사용하면 다른 CLI 명령에 대한 별칭을 만들고 관리할 수 있습니다. 모든 사용 가능한 명령 및 매개 변수 세부 정보를 보려면 --help을 사용하여 별칭 명령을 실행합니다.

az alias --help

간단한 별칭 명령 만들기

별칭의 한 가지 사용은 기존 명령 그룹 또는 명령 이름을 줄이는 것입니다. 예를 들어 명령 그룹을 줄이 group 면 명령 그룹을 rg 짧게 하고 명령을 list 로 줄일 ls수 있습니다.

az alias create --name rg --command group
az alias create --name ls --command list

이러한 새로 정의된 별칭은 이제 정의가 있는 모든 곳에서 사용할 수 있습니다.

az rg list
az rg ls
az vm ls

별칭 명령의 일부로 포함하지 az 마세요.

별칭은 전체 명령의 바로 가기일 수도 있습니다. 다음 예는 사용 가능한 리소스 그룹과 해당 위치를 테이블로 출력하여 나열합니다.

az alias create --name ls-groups --command "group list --query '[].{Name:name, Location:location}' --output table"

이제 ls-groups 다른 CLI 명령처럼 실행할 수 있습니다.

az ls-groups

인수를 사용하여 별칭 명령 만들기

별칭 이름에 위치 인수를 {{ arg_name }}으로 포함하여 별칭 명령에 추가할 수도 있습니다. 중괄호 안의 공백이 필요합니다.

az alias create --name "alias_name {{ arg1 }} {{ arg2 }} ..." --command "invoke_including_args"

다음 예제 별칭은 위치 인수를 사용하여 VM의 공용 IP 주소를 얻는 방법을 보여줍니다.

az alias create \
    --name "get-vm-ip {{ resourceGroup }} {{ vmName }}" \
    --command "vm list-ip-addresses --resource-group {{ resourceGroup }} --name {{ vmName }}
        --query [0].virtualMachine.network.publicIpAddresses[0].ipAddress"

이 명령을 실행할 때 위치 인수에 값을 제공합니다.

az get-vm-ip MyResourceGroup MyVM

런타임에 평가되는 별칭이 지정된 명령에서 환경 변수를 사용할 수도 있습니다. 다음 예는 eastus에 리소스 그룹을 만들고 owner 태그를 추가하는 create-rg 별칭을 추가합니다. 이 태그에는 로컬 환경 변수 USER의 값이 할당됩니다.

az alias create \
    --name "create-rg {{ groupName }}" \
    --command "group create --name {{ groupName }} --location eastus --tags owner=\$USER"

별칭 명령 내에 환경 변수를 등록하려면 달러 기호 $ 를 이스케이프해야 합니다.

Jinja2 템플릿을 사용하여 인수 처리

Jinja2 는 별칭 확장에서 인수 대체를 수행합니다. Jinja2 템플릿을 사용하면 인수를 조작할 수 있습니다.

Jinja2 템플릿을 사용하면 기본 명령과 다른 인수 유형을 사용하는 별칭을 작성할 수 있습니다. 예를 들어 스토리지 URL을 사용하는 별칭을 만들 수 있습니다. 그런 다음 이 URL을 구문 분석하여 계정 및 컨테이너 이름을 스토리지 명령에 전달합니다.

az alias create \
    --name 'storage-ls {{ url }}' \
    --command "storage blob list
        --account-name {{ url.replace('https://', '').split('.')[0] }}
        --container-name {{ url.replace('https://', '').split('/')[1] }}"

Jinja2 템플릿 엔진에 대한 자세한 내용은 Jinja2 설명서를 참조 하세요.

별칭 구성 파일

별칭을 만들고 수정하는 또 다른 방법은 별칭 구성 파일을 변경하는 것입니다. 별칭 명령 정의는 $AZURE_CONFIG_DIR/alias에있는 구성 파일에 작성됩니다. 기본값 AZURE_CONFIG_DIR$HOME/.azure macOS 및 Linux 및 %USERPROFILE%\.azure Windows에 있습니다. 별칭 구성 파일은 INI 구성 파일 형식으로 작성됩니다. 별칭 명령의 형식은 다음과 같습니다.

[alias_name]
command = invoked_commands

위치 인수가 있는 별칭의 경우, 별칭 명령에 대한 형식은 다음과 같습니다.

[alias_name {{ arg1 }} {{ arg2 }} ...]
command = invoked_commands_including_args

별칭 구성 파일을 통해 인수를 사용하여 별칭 명령 만들기

다음 예제에서는 인수가 있는 명령에 대한 별칭을 보여 줍니다. 이 명령은 VM에 대한 공용 IP 주소를 가져옵니다. 별칭이 지정된 명령은 모두 한 줄에 있어야 하며 별칭 이름에 모든 인수를 사용해야 합니다.

[get-vm-ip {{ resourceGroup }} {{ vmName }}]
command = vm list-ip-addresses --resource-group {{ resourceGroup }} --name {{ vmName }} --query [0].virtualMachine.network.publicIpAddresses[0].ipAddress

별칭 확장 제거

확장을 설치 제거하려면 az extension remove 명령을 사용합니다.

az extension remove --name alias

확장 에 대한 버그 또는 기타 문제로 인해 제거한 경우 픽스를 제공할 수 있도록 GitHub 문제를 제출합니다.