Správa přiřazení pomocí PowerShellu

  • Článek
  • 9 min ke čtení

přiřazení podrobného plánu je možné spravovat pomocí modulu Az. detail Azure PowerShell module. Modul podporuje načítání, vytváření, aktualizaci a odebírání přiřazení. Modul může také načíst podrobnosti o stávajících definicích podrobného plánu. Tento článek popisuje, jak nainstalovat modul a začít ho používat.

Přidání modulu AZ. detail Module

aby bylo možné Azure PowerShell spravovat přiřazení podrobných plánů, modul musí být přidán. tento modul se dá použít s místně nainstalovaným powershellem, s Azure Cloud Shell, nebo s imagí Azure PowerShell docker.

Základní požadavky

Modul Azure modrotisky vyžaduje následující software:

  • Azure PowerShell 1.5.0 nebo vyšší. Pokud ještě není nainstalovaný, postupujte podle těchto pokynů.
  • PowerShellGet 2.0.1 nebo novější. Pokud není nainstalovaný nebo aktualizovaný, postupujte podle těchto pokynů.

Nainstalovat modul

Modul Azure modrotisky pro PowerShell je AZ. detail.

  1. Na příkazovém řádku PowerShellu pro správu spusťte následující příkaz:

    # Install the Azure Blueprints module from PowerShell Gallery
Install-Module -Name Az.Blueprint

    Poznámka

    Pokud je už nainstalovaná AZ. Accounts , může být nutné použít -AllowClobber k vynucení instalace.

  2. Ověřte, že je modul naimportovaný a má správnou verzi (0.2.6):

    # Get a list of commands for the imported Az.Blueprint module
Get-Command -Module 'Az.Blueprint' -CommandType 'Cmdlet'

Získat definice podrobného plánu

Prvním krokem pro práci s přiřazením je často získání odkazu na definici podrobného plánu. Get-AzBlueprintRutina získá jednu nebo více definic podrobného plánu. Rutina může získat definice podrobného plánu ze skupiny pro správu s -ManagementGroupId {mgId} nebo s předplatným -SubscriptionId {subId} . Parametr Name získá definici podrobného plánu, ale musí být použit s ManagementGroupId nebo SubscriptionId. Verzi lze použít s názvem , aby byla lépe explicitní o tom, která definice podrobného plánu se vrátí. Místo verze se v přepínači přesměruje -LatestPublished naposledy publikovaná verze.

Následující příklad používá Get-AzBlueprint k získání všech verzí definice podrobného plánu s názvem "101-modrotisky-definition-Subscription" z konkrétního předplatného reprezentovaného jako {subId} :

# Login first with Connect-AzAccount if not using Cloud Shell

# Get all versions of the blueprint definition in the specified subscription
$blueprints = Get-AzBlueprint -SubscriptionId '{subId}' -Name '101-blueprints-definition-subscription'

# Display the blueprint definition object
$blueprints

Ukázkový výstup pro definici podrobného plánu s více verzemi vypadá takto:

Name                 : 101-blueprints-definition-subscription
Id                   : /subscriptions/{subId}/providers/Microsoft.Blueprint/blueprints/101
                       -blueprints-definition-subscription
DefinitionLocationId : {subId}
Versions             : {1.0, 1.1}
TimeCreated          : 2019-02-25
TargetScope          : Subscription
Parameters           : {storageAccount_storageAccountType, storageAccount_location,
                       allowedlocations_listOfAllowedLocations, [Usergrouporapplicationname]:Reader_RoleAssignmentName}
ResourceGroups       : ResourceGroup

Parametry podrobného plánu v definici podrobného plánu lze rozšířit tak, aby poskytovaly Další informace.

$blueprints.Parameters

Key                                                    Value
---                                                    -----
storageAccount_storageAccountType                      Microsoft.Azure.Commands.Blueprint.Models.PSParameterDefinition
storageAccount_location                                Microsoft.Azure.Commands.Blueprint.Models.PSParameterDefinition
allowedlocations_listOfAllowedLocations                Microsoft.Azure.Commands.Blueprint.Models.PSParameterDefinition
[Usergrouporapplicationname]:Reader_RoleAssignmentName Microsoft.Azure.Commands.Blueprint.Models.PSParameterDefinition

Získat přiřazení podrobného plánu

Pokud přiřazení podrobného plánu už existuje, můžete na něj získat odkaz pomocí Get-AzBlueprintAssignment rutiny. Rutina přijímá SubscriptionId a název jako volitelné parametry. Pokud není zadané SubscriptionId , použije se aktuální kontext předplatného.

Následující příklad používá Get-AzBlueprintAssignment k získání jednoho přiřazení podrobného plánu s názvem "přiřazení-zámek-Resource-Groups" z konkrétního předplatného reprezentovaného jako {subId} :

# Login first with Connect-AzAccount if not using Cloud Shell

# Get the blueprint assignment in the specified subscription
$blueprintAssignment = Get-AzBlueprintAssignment -SubscriptionId '{subId}' -Name 'Assignment-lock-resource-groups'

# Display the blueprint assignment object
$blueprintAssignment

Ukázkový výstup přiřazení podrobného plánu vypadá takto:

Name              : Assignment-lock-resource-groups
Id                : /subscriptions/{subId}/providers/Microsoft.Blueprint/blueprintAssignme
                    nts/Assignment-lock-resource-groups
Scope             : /subscriptions/{subId}
LastModified      : 2019-02-19
LockMode          : AllResourcesReadOnly
ProvisioningState : Succeeded
Parameters        :
ResourceGroups    : ResourceGroup

Vytvořit přiřazení podrobného plánu

Pokud přiřazení podrobného plánu ještě neexistuje, můžete ho vytvořit pomocí New-AzBlueprintAssignment rutiny. Tato rutina používá následující parametry:

  • Název [povinné]

    • Určuje název přiřazení podrobného plánu.
    • Musí být jedinečné a v SubscriptionId již neexistují.

  • Podrobný plán [povinné]

    • Určuje definici podrobného plánu, která se má přiřadit.
    • Slouží Get-AzBlueprint k získání referenčního objektu.

  • Umístění [povinné]

    • Určuje oblast pro objekt nasazení spravované identity a předplatného přiřazený systémem, který se má vytvořit v.

  • Předplatné (volitelné)

    • Určuje předplatné, na které se přiřazení nasazuje.
    • Pokud není zadaný, použije se výchozí kontext aktuálního předplatného.

  • Zamknout (volitelné)

    • Definuje uzamykání prostředků podrobného plánu, které se má použít pro nasazené prostředky.
    • Podporované možnosti: none, AllResourcesReadOnly, AllResourcesDoNotDelete
    • Pokud není zadaný, použije se výchozí hodnota none .

  • SystemAssignedIdentity (volitelné)

    • Tuto možnost vyberte, pokud chcete vytvořit spravovanou identitu přiřazenou systémem pro přiřazení a nasadit prostředky.
    • Výchozí hodnota pro sadu parametrů identity
    • Nejde použít s UserAssignedIdentity

  • UserAssignedIdentity (volitelné)

    • Určuje uživatelem přiřazenou identitu, která se má použít pro přiřazení a nasazení prostředků.
    • Část sady parametrů identity
    • Nejde použít s SystemAssignedIdentity

  • Parametr (volitelné)

    • Zatřiďovací tabulka párů klíč/hodnota pro nastavení dynamických parametrů u přiřazení podrobného plánu

    • Výchozí hodnota pro dynamický parametr je vlastnost DefaultValue v definici.

    • Pokud parametr není zadaný a nemá hodnotu DefaultValue, parametr není nepovinný.

      Poznámka

      Parametr nepodporuje secureStrings.

  • ResourceGroupParameter (volitelné)

    • Zatřiďovací tabulka artefaktů skupiny prostředků
    • Zástupný symbol pro všechny skupiny prostředků má páry klíč/hodnota pro dynamické nastavování názvu a umístění pro tento artefakt skupiny prostředků.
    • Pokud není zadaný parametr skupiny prostředků a nemá žádnou hodnotu DefaultValue, parametr skupiny prostředků není nepovinný.

  • AssignmentFile (volitelné)

    • Cesta k reprezentaci souboru JSON přiřazení podrobného plánu
    • Tento parametr je součástí sady parametrů prostředí PowerShell, která obsahuje pouze název, podrobný plán a SubscriptionId a navíc společné parametry.

Příklad 1: zadání parametrů

Následující příklad vytvoří nové přiřazení verze "1,1" v definici podrobného plánu "My-detailed" Get-AzBlueprint , nastaví spravované umístění objektu identity a přiřazení na hodnotu "westus2", zamkne prostředky pomocí AllResourcesReadOnly a nastaví zatřiďovací tabulky pro parametr i ResourceGroupParameter v konkrétním předplatném reprezentované jako {subId} :

# Login first with Connect-AzAccount if not using Cloud Shell

# Get version '1.1' of the blueprint definition in the specified subscription
$bpDefinition = Get-AzBlueprint -SubscriptionId '{subId}' -Name 'my-blueprint' -Version '1.1'

# Create the hash table for Parameters
$bpParameters = @{storageAccount_storageAccountType='Standard_GRS'}

# Create the hash table for ResourceGroupParameters
# ResourceGroup is the resource group artifact placeholder name
$bpRGParameters = @{ResourceGroup=@{name='storage_rg';location='westus2'}}

# Create the new blueprint assignment
$bpAssignment = New-AzBlueprintAssignment -Name 'my-blueprint-assignment' -Blueprint $bpDefinition `
    -SubscriptionId '{subId}' -Location 'westus2' -Lock AllResourcesReadOnly `
    -Parameter $bpParameters -ResourceGroupParameter $bpRGParameters

Ukázkový výstup pro vytvoření přiřazení podrobného plánu vypadá takto:

Name              : my-blueprint-assignment
Id                : /subscriptions/{subId}/providers/Microsoft.Blueprint/blueprintAssi
                    gnments/my-blueprint-assignment
Scope             : /subscriptions/{subId}
LastModified      : 2019-03-13
LockMode          : AllResourcesReadOnly
ProvisioningState : Creating
Parameters        : {storageAccount_storageAccountType}
ResourceGroups    : ResourceGroup

Příklad 2: použití definičního souboru přiřazení JSON

Následující příklad vytvoří téměř stejné přiřazení jako Příklad 1. Místo předání parametrů rutině v příkladu se zobrazuje použití definičního souboru přiřazení JSON a parametru AssignmentFile . Kromě toho je vlastnost excludedPrincipals nakonfigurována jako součást zámků. Pro excludedPrincipals není k dispozici parametr PowerShellu a vlastnost lze nakonfigurovat pouze její nastavením prostřednictvím definičního souboru přiřazení JSON.

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "westus2",
  "properties": {
    "description": "Assignment of the 101-blueprint-definition-subscription",
    "blueprintId": "/subscriptions/{subId}/providers/Microsoft.Blueprint/blueprints/101-blueprints-definition-subscription",
    "locks": {
      "mode": "AllResourcesReadOnly",
      "excludedPrincipals": [
          "7be2f100-3af5-4c15-bcb7-27ee43784a1f",
          "38833b56-194d-420b-90ce-cff578296714"
      ]
    },
    "parameters": {
      "storageAccount_storageAccountType": {
        "value": "Standard_GRS"
      }
    },
    "resourceGroups": {
      "ResourceGroup": {
        "name": "storage_rg",
        "location": "westus2"
      }
    }
  }
}

# Login first with Connect-AzAccount if not using Cloud Shell

# Create the new blueprint assignment
$bpAssignment = New-AzBlueprintAssignment -Name 'my-blueprint-assignment' -SubscriptionId '{subId}' `
    -AssignmentFile '.\assignment.json'

Příklad souboru definice přiřazení JSON pro uživatelem přiřazenou spravovanou identitu najdete v textu žádosti v příkladu: přiřazení s uživatelem přiřazenou spravovanou identitou pro REST API.

Aktualizovat přiřazení podrobného plánu

Někdy je potřeba aktualizovat přiřazení podrobného plánu, který už je vytvořený. Set-AzBlueprintAssignmentRutina tuto akci zpracuje. Rutina přebírá většinu stejných parametrů, které New-AzBlueprintAssignment provádí rutina, a umožňuje tak, aby se aktualizovala veškerá nastavení na přiřazení. Výjimkou jsou název, podrobný plán a SubscriptionId. Aktualizují se jenom zadané hodnoty.

Informace o tom, co se stane při aktualizaci přiřazení podrobného plánu, najdete v tématu pravidla pro aktualizaci přiřazení.

  • Název [povinné]

    • Určuje název přiřazení podrobného plánu, který se má aktualizovat.
    • Slouží k vyhledání přiřazení, které se má aktualizovat, nikoli Změna přiřazení.

  • Podrobný plán [povinné]

    • Určuje definici podrobného plánu přiřazení podrobného plánu.
    • Slouží Get-AzBlueprint k získání referenčního objektu.
    • Slouží k vyhledání přiřazení, které se má aktualizovat, nikoli Změna přiřazení.

  • Umístění (volitelné)

    • Určuje oblast pro objekt nasazení spravované identity a předplatného přiřazený systémem, který se má vytvořit v.

  • Předplatné (volitelné)

    • Určuje předplatné, do které se přiřazení nasadí.
    • Pokud se nezadá, výchozí hodnota je kontext aktuálního předplatného.
    • Slouží k vyhledání přiřazení k aktualizaci, nikoli ke změně přiřazení.

  • Zámek (volitelné)

  • SystemAssignedIdentity (volitelné)

    • Výběrem této možnosti vytvoříte spravovanou identitu přiřazenou systémem pro přiřazení a nasadíte prostředky.
    • Výchozí hodnota pro sadu parametrů identity
    • Nelze použít s identitou UserAssignedIdentity

  • UserAssignedIdentity (volitelné)

    • Určuje spravovanou identitu přiřazenou uživatelem, která se má použít pro přiřazení a nasazení prostředků.
    • Část sady parametrů identity
    • Nelze použít se SystemAssignedIdentity

  • Parametr (volitelné)

    • Tabulka hash párů klíč/hodnota pro nastavení dynamických parametrů v přiřazení podrobného plánu

    • Výchozí hodnota dynamického parametru je defaultValue v definici.

    • Pokud parametr není zadán a nemá žádnou hodnotu defaultValue, není parametr volitelný.

      Poznámka

      Parametr nepodporuje secureStrings.

  • ResourceGroupParameter (volitelné)

    • Tabulka hash artefaktů skupiny prostředků
    • Každý zástupný symbol artefaktu skupiny prostředků má páry klíč/hodnota pro dynamické nastavení Názvu a Umístění v artefaktu této skupiny prostředků.
    • Pokud parametr skupiny prostředků není zadán a nemá žádnou hodnotu defaultValue, není parametr skupiny prostředků volitelný.

Následující příklad aktualizuje přiřazení verze 1.1 definice podrobného plánu my-blueprint načtené příkazem změnou Get-AzBlueprint režimu uzamčení:

# Login first with Connect-AzAccount if not using Cloud Shell

# Get version '1.1' of the blueprint definition in the specified subscription
$bpDefinition = Get-AzBlueprint -SubscriptionId '{subId}' -Name 'my-blueprint' -Version '1.1'

# Update the existing blueprint assignment
$bpAssignment = Set-AzBlueprintAssignment -Name 'my-blueprint-assignment' -Blueprint $bpDefinition `
    -SubscriptionId '{subId}' -Lock AllResourcesDoNotDelete

Příklad výstupu pro vytvoření přiřazení podrobného plánu vypadá takhle:

Name              : my-blueprint-assignment
Id                : /subscriptions/{subId}/providers/Microsoft.Blueprint/blueprintAssi
                    gnments/my-blueprint-assignment
Scope             : /subscriptions/{subId}
LastModified      : 2019-03-13
LockMode          : AllResourcesDoNotDelete
ProvisioningState : Updating
Parameters        : {storageAccount_storageAccountType}
ResourceGroups    : ResourceGroup

Odebrání přiřazení podrobného plánu

Když je čas odebrat přiřazení podrobného plánu, rutina Remove-AzBlueprintAssignment tuto akci zpracuje. Rutina určí přiřazení podrobného plánu, které se má odebrat, buď Name, nebo InputObject. Id předplatného je povinné a musí být uvedené ve všech případech.

Následující příklad načte existující přiřazení podrobného plánu pomocí a pak ho odebere Get-AzBlueprintAssignment z konkrétního předplatného, které je reprezentované jako {subId} :

# Login first with Connect-AzAccount if not using Cloud Shell

# Get the blueprint assignment in the specified subscription
$blueprintAssignment = Get-AzBlueprintAssignment -Name 'Assignment-lock-resource-groups'

# Remove the existing blueprint assignment
Remove-AzBlueprintAssignment -InputObject $blueprintAssignment -SubscriptionId '{subId}'

Příklad kódu

Když všechny kroky sdružíte, následující příklad získá definici podrobného plánu, pak vytvoří, aktualizuje a odebere přiřazení podrobného plánu v konkrétním předplatném reprezentované jako {subId} :

# Login first with Connect-AzAccount if not using Cloud Shell

#region GetBlueprint
# Get version '1.1' of the blueprint definition in the specified subscription
$bpDefinition = Get-AzBlueprint -SubscriptionId '{subId}' -Name 'my-blueprint' -Version '1.1'
#endregion

#region CreateAssignment
# Create the hash table for Parameters
$bpParameters = @{storageAccount_storageAccountType='Standard_GRS'}

# Create the hash table for ResourceGroupParameters
# ResourceGroup is the resource group artifact placeholder name
$bpRGParameters = @{ResourceGroup=@{name='storage_rg';location='westus2'}}

# Create the new blueprint assignment
$bpAssignment = New-AzBlueprintAssignment -Name 'my-blueprint-assignment' -Blueprint $bpDefinition `
    -SubscriptionId '{subId}' -Location 'westus2' -Lock AllResourcesReadOnly `
    -Parameter $bpParameters -ResourceGroupParameter $bpRGParameters
#endregion CreateAssignment

# Wait for the blueprint assignment to finish deployment prior to the next steps

#region UpdateAssignment
# Update the existing blueprint assignment
$bpAssignment = Set-AzBlueprintAssignment -Name 'my-blueprint-assignment' -Blueprint $bpDefinition `
    -SubscriptionId '{subId}' -Lock AllResourcesDoNotDelete
#endregion UpdateAssignment

# Wait for the blueprint assignment to finish deployment prior to the next steps

#region RemoveAssignment
# Remove the existing blueprint assignment
Remove-AzBlueprintAssignment -InputObject $bpAssignment -SubscriptionId '{subId}'
#endregion

Další kroky