Menerapkan tag dengan Python

Artikel ini menjelaskan cara menggunakan Python untuk menandai sumber daya, grup sumber daya, dan langganan. Untuk rekomendasi dan batasan tag, lihat Menggunakan tag untuk mengatur sumber daya Azure dan hierarki manajemen Anda.

Prasyarat

• Python 3.8 atau yang lebih baru terinstal. Untuk menginstal yang terbaru, lihat Python.org

• Paket pustaka Azure berikut untuk Python yang diinstal di lingkungan virtual Anda. Untuk menginstal salah satu paket, gunakan pip install {package-name}

  • azure-identity
  • azure-mgmt-resource

  Jika Anda memiliki versi lama dari paket ini yang sudah diinstal di lingkungan virtual Anda, Anda mungkin perlu memperbaruinya dengan pip install --upgrade {package-name}

• Contoh dalam artikel ini menggunakan autentikasi berbasis CLI (AzureCliCredential). Bergantung pada lingkungan Anda, Anda mungkin perlu menjalankan az login terlebih dahulu untuk mengautentikasi.

• Variabel lingkungan dengan ID langganan Azure Anda. Untuk mendapatkan ID langganan Azure Anda, gunakan:

  az account show --name 'your subscription name' --query id -o tsv
  

  Untuk mengatur nilai, gunakan opsi untuk lingkungan Anda.

  Windows

  setx AZURE_SUBSCRIPTION_ID your-subscription-id
  

  Catatan

  Jika Anda hanya perlu mengakses variabel lingkungan di konsol yang sedang berjalan saat ini, Anda dapat mengatur variabel lingkungan dengan set alih-alih setx.

  Setelah menambahkan variabel lingkungan, Anda mungkin perlu memulai ulang program yang sedang berjalan yang perlu membaca variabel lingkungan, termasuk jendela konsol. Misalnya, jika Anda menggunakan Visual Studio sebagai editor, mulai ulang Visual Studio sebelum menjalankan contoh.

  Linux

  export AZURE_SUBSCRIPTION_ID=your-subscription-id
  

  Setelah Anda menambahkan variabel lingkungan, jalankan source ~/.bashrc dari jendela konsol Anda untuk membuat perubahan efektif.

  macOS

  Bash

  Edit .bash_profile Anda, dan tambahkan variabel lingkungan:

  export AZURE_SUBSCRIPTION_ID=your-subscription-id
  

  Setelah Anda menambahkan variabel lingkungan, jalankan source ~/.bash_profile dari jendela konsol Anda untuk membuat perubahan efektif.

Terapkan tag

Azure Python menawarkan metode ResourceManagementClient.tags.begin_create_or_update_at_scope untuk menerapkan tag. Ini menggantikan semua tag pada sumber daya, grup sumber daya, atau langganan. Saat Anda memanggil perintah, teruskan ID sumber daya entitas yang ingin Anda tandai.

Contoh berikut menerapkan sekumpulan tag ke akun penyimpanan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group_name = "demoGroup"
storage_account_name = "demostore"

tags = {
    "Dept": "Finance",
    "Status": "Normal"
}

tag_resource = TagsResource(
    properties={'tags': tags}
)

resource = resource_client.resources.get_by_id(
    f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Storage/storageAccounts/{storage_account_name}",
    "2022-09-01"
)

resource_client.tags.begin_create_or_update_at_scope(resource.id, tag_resource)

print(f"Tags {tag_resource.properties.tags} were added to resource with ID: {resource.id}")

Jika Anda menjalankan perintah lagi tetapi kali ini dengan tag yang berbeda, perhatikan apakah tag sebelumnya menghilang.

tags = {
    "Team": "Compliance",
    "Environment": "Production"
}

Untuk menambahkan tag ke sumber daya yang sudah memiliki tag, gunakan ResourceManagementClient.tags.begin_update_at_scope. Pada objek TagsPatchResource, atur operation parameter ke Merge.

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsPatchResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group_name = "demoGroup"
storage_account_name = "demostore"

tags = {
    "Dept": "Finance",
    "Status": "Normal"
}

tag_patch_resource = TagsPatchResource(
    operation="Merge",
    properties={'tags': tags}
)

resource = resource_client.resources.get_by_id(
    f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Storage/storageAccounts/{storage_account_name}",
    "2022-09-01"
)

resource_client.tags.begin_update_at_scope(resource.id, tag_patch_resource)

print(f"Tags {tag_patch_resource.properties.tags} were added to existing tags on resource with ID: {resource.id}")

Perhatikan bahwa tag yang ada tumbuh dengan penambahan dua tag baru.

Setiap nama tag hanya dapat memiliki satu nilai. Jika Anda memberikan nilai baru untuk tag, nilai tersebut akan mengganti nilai lama meskipun Anda menggunakan operasi penggabungan. Contoh berikut mengubah Status tag dari Normal ke Hijau.

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsPatchResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group_name = "demoGroup"
storage_account_name = "demostore"

tags = {
    "Status": "Green"
}

tag_patch_resource = TagsPatchResource(
    operation="Merge",
    properties={'tags': tags}
)

resource = resource_client.resources.get_by_id(
    f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Storage/storageAccounts/{storage_account_name}",
    "2022-09-01"
)

resource_client.tags.begin_update_at_scope(resource.id, tag_patch_resource)

print(f"Tags {tag_patch_resource.properties.tags} were added to existing tags on resource with ID: {resource.id}")

Ketika Anda mengatur parameter operation ke Replace, set tag yang baru akan menggantikan tag-tag yang ada.

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsPatchResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group_name = "demoGroup"
storage_account_name = "demostore"

tags = {
    "Project": "ECommerce",
    "CostCenter": "00123",
    "Team": "Web"
}

tag_patch_resource = TagsPatchResource(
    operation="Replace",
    properties={'tags': tags}
)

resource = resource_client.resources.get_by_id(
    f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Storage/storageAccounts/{storage_account_name}",
    "2022-09-01"
)

resource_client.tags.begin_update_at_scope(resource.id, tag_patch_resource)

print(f"Tags {tag_patch_resource.properties.tags} replaced tags on resource with ID: {resource.id}")

Hanya tag baru yang tersisa di sumber daya.

Perintah yang sama juga berfungsi dengan grup sumber daya atau langganan. Teruskan pengidentifikasi untuk grup sumber daya atau langganan yang ingin Anda tandai. Untuk menambahkan sekumpulan tag baru ke grup sumber daya, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group_name = "demoGroup"

tags = {
    "Dept": "Finance",
    "Status": "Normal"
}

tag_resource = TagsResource(
    properties={'tags': tags}
)

resource_group = resource_client.resource_groups.get(resource_group_name)

resource_client.tags.begin_create_or_update_at_scope(resource_group.id, tag_resource)

print(f"Tags {tag_resource.properties.tags} were added to resource group: {resource_group.id}")

Untuk perbarui tag untuk grup sumber daya, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsPatchResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group_name = "demoGroup"

tags = {
    "CostCenter": "00123",
    "Environment": "Production"
}

tag_patch_resource = TagsPatchResource(
    operation="Merge",
    properties={'tags': tags}
)

resource_group = resource_client.resource_groups.get(resource_group_name)

resource_client.tags.begin_update_at_scope(resource_group.id, tag_patch_resource)

print(f"Tags {tag_patch_resource.properties.tags} were added to existing tags on resource group: {resource_group.id}")

Untuk perbarui tag untuk langganan, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsPatchResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

tags = {
    "Team": "Web Apps"
}

tag_patch_resource = TagsPatchResource(
    operation="Merge",
    properties={'tags': tags}
)

resource_client.tags.begin_update_at_scope(f"/subscriptions/{subscription_id}", tag_patch_resource)

print(f"Tags {tag_patch_resource.properties.tags} were added to subscription: {subscription_id}")

Anda mungkin memiliki lebih dari satu sumber daya dengan nama yang sama dalam grup sumber daya. Dalam hal ini, Anda dapat mengatur setiap sumber daya dengan perintah berikut:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsPatchResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group_name = "demoGroup"

tags = {
    "Dept": "IT",
    "Environment": "Test"
}

tag_patch_resource = TagsPatchResource(
    operation="Merge",
    properties={'tags': tags}
)

resources = resource_client.resources.list_by_resource_group(resource_group_name, filter="name eq 'sqlDatabase1'")

for resource in resources:
    resource_client.tags.begin_update_at_scope(resource.id, tag_patch_resource)
    print(f"Tags {tag_patch_resource.properties.tags} were added to resource: {resource.id}")

Daftar tag

Untuk mendapatkan tag untuk sumber daya, grup sumber daya, atau langganan, gunakan metode ResourceManagementClient.tags.get_at_scope dan berikan ID sumber daya entitas.

Untuk melihat tag untuk sumber daya, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_group_name = "demoGroup"
storage_account_name = "demostorage"

resource_client = ResourceManagementClient(credential, subscription_id)

resource = resource_client.resources.get_by_id(
    f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Storage/storageAccounts/{storage_account_name}",
    "2022-09-01"
)

resource_tags = resource_client.tags.get_at_scope(resource.id)
print (resource_tags.properties.tags)

Untuk melihat tag untuk grup sumber daya, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group = resource_client.resource_groups.get("demoGroup")

resource_group_tags = resource_client.tags.get_at_scope(resource_group.id)
print (resource_group_tags.properties.tags)

Untuk melihat tag untuk langganan, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

subscription_tags = resource_client.tags.get_at_scope(f"/subscriptions/{subscription_id}")
print (subscription_tags.properties.tags)

Daftar menurut tag

Untuk mendapatkan sumber daya yang memiliki nama dan nilai tag tertentu, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resources = resource_client.resources.list(filter="tagName eq 'CostCenter' and tagValue eq '00123'")

for resource in resources:
    print(resource.name)

Untuk mendapatkan sumber daya yang memiliki nama dengan nilai tag tertentu, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resources = resource_client.resources.list(filter="tagName eq 'Dept'")

for resource in resources:
    print(resource.name)

Untuk mendapatkan grup sumber daya yang memiliki nama dan nilai tag tertentu, gunakan:

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_groups = resource_client.resource_groups.list(filter="tagName eq 'CostCenter' and tagValue eq '00123'")

for resource_group in resource_groups:
    print(resource_group.name)

Hapus tag

Untuk menghapus tag tertentu, atur operation ke Delete. Berikan ID sumber daya tag yang ingin Anda hapus.

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.resource.resources.models import TagsPatchResource

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

resource_group_name = "demoGroup"
storage_account_name = "demostore"

tags = {
    "Dept": "IT",
    "Environment": "Test"
}

tag_patch_resource = TagsPatchResource(
    operation="Delete",
    properties={'tags': tags}
)

resource = resource_client.resources.get_by_id(
    f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Storage/storageAccounts/{storage_account_name}",
    "2022-09-01"
)

resource_client.tags.begin_update_at_scope(resource.id, tag_patch_resource)

print(f"Tags {tag_patch_resource.properties.tags} were removed from resource: {resource.id}")

Tag tertentu akan dihapus.

Untuk menghapus semua tag, gunakan metode ResourceManagementClient.tags.begin_delete_at_scope .

import os
from azure.identity import AzureCliCredential
from azure.mgmt.resource import ResourceManagementClient

credential = AzureCliCredential()
subscription_id = os.environ["AZURE_SUBSCRIPTION_ID"]

resource_client = ResourceManagementClient(credential, subscription_id)

subscription = resource_client.subscriptions.get(subscription_id)

resource_client.tags.begin_delete_at_scope(subscription.id)

Langkah berikutnya

• Tidak semua jenis sumber daya mendukung tag. Untuk menentukan apakah Anda bisa menerapkan tag ke suatu jenis sumber daya, lihat Dukungan tag untuk sumber daya Azure.
• Untuk rekomendasi tentang cara menerapkan strategi penandaan, lihat Panduan keputusan penandaan dan penamaan sumber daya.
• Untuk rekomendasi dan batasan tag, lihat Menggunakan tag untuk mengatur sumber daya Azure dan hierarki manajemen Anda.