Festlegen von Name und Typ für untergeordnete Ressourcen in Bicep

  • Artikel

Untergeordnete Ressourcen sind Ressourcen, die nur im Kontext einer anderen Ressource verfügbar sind. Beispielsweise kann eine Erweiterung des virtuellen Computers nicht ohne einen virtuellen Computer vorhanden sein. Die Erweiterungsressource ist ein untergeordnetes Element des virtuellen Computers.

Jede übergeordnete Ressource akzeptiert nur bestimmte Ressourcentypen als untergeordnete Ressourcen. Die Hierarchie der Ressourcentypen ist in der Bicep Ressourcenreferenz verfügbar.

In diesem Artikel werden verschiedene Möglichkeiten zum Deklarieren einer untergeordneten Ressource beschrieben.

Schulungsressourcen

Wenn Sie sich lieber anhand einer Schritt-für-Schritt-Anleitung über untergeordnete Ressourcen informieren möchten, lesen Sie Bereitstellen von untergeordneten Ressourcen und Erweiterungsressourcen mithilfe von Bicep.

Name und Typmuster

In Bicep können Sie die untergeordnete Ressource entweder innerhalb oder außerhalb der übergeordneten Ressource angeben. Die Werte, die Sie für Ressourcennamen und Ressourcentyp angeben, ändern sich, je nachdem, wie Sie die untergeordnete Ressource deklarieren. Der vollständige Name und Typ werden jedoch immer in das gleiche Muster auflösen.

Der vollständige Name der untergeordneten Ressource verwendet das Muster:

{parent-resource-name}/{child-resource-name}

Wenn sie über mehr als zwei Ebenen in der Hierarchie verfügen, wiederholen Sie die übergeordneten Namen:

{parent-resource-name}/{child-level1-resource-name}/{child-level2-resource-name}

Der vollständige Typ der untergeordneten Ressource verwendet das Muster:

{resource-provider-namespace}/{parent-resource-type}/{child-resource-type}

Wenn sie über mehr als zwei Ebenen in der Hierarchie verfügen, wiederholen Sie die übergeordneten Namen:

{resource-provider-namespace}/{parent-resource-type}/{child-level1-resource-type}/{child-level2-resource-type}

Wenn Sie die Segmente zwischen / Zeichen zählen, ist die Anzahl der Segmente im Typ immer eines mehr als die Anzahl der Segmente im Namen.

Innerhalb der übergeordneten Ressource

Im folgenden Beispiel ist die untergeordnete Ressource in der Eigenschaft „resources“ der übergeordneten Ressource enthalten.

resource <parent-resource-symbolic-name> '<resource-type>@<api-version>' = {
  <parent-resource-properties>

  resource <child-resource-symbolic-name> '<child-resource-type>' = {
    <child-resource-properties>
  }
}

Eine verschachtelte Ressourcendeklaration muss auf der obersten Ebene der Syntax der übergeordneten Ressource erscheinen. Deklarationen können beliebig tief verschachtelt werden, solange jede Ebene ein untergeordneter Typ seiner übergeordneten Ressource ist.

Wenn sie innerhalb des übergeordneten Ressourcentyps definiert sind, formatieren Sie die Werte für Typ und Name als ein einziges Segment ohne Schrägstriche. Das folgende Beispiel zeigt ein Speicherkonto mit einer untergeordneten Ressource für den Dateidienst, und der Dateidienst verfügt über eine untergeordnete Ressource für die Dateifreigabe. Der Name des Dateidienstes ist auf default festgelegt, und sein Typ ist auf fileServices festgelegt. Der Name der Dateifreigabe ist auf exampleshare festgelegt, und ihr Typ ist auf shares festgelegt.

resource storage 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: 'examplestorage'
  location: resourceGroup().location
  kind: 'StorageV2'
  sku: {
    name: 'Standard_LRS'
  }

  resource service 'fileServices' = {
    name: 'default'

    resource share 'shares' = {
      name: 'exampleshare'
    }
  }
}

Die vollständigen Ressourcentypen sind immer noch Microsoft.Storage/storageAccounts/fileServices und Microsoft.Storage/storageAccounts/fileServices/shares. Sie geben Microsoft.Storage/storageAccounts/ nicht an, weil es vom übergeordneten Ressourcentyp und der Version angenommen wird. Die geschachtelte Ressource kann fakultativ eine API-Version mit der Syntax <segment>@<version> deklarieren. Wenn die geschachtelte Ressource die API-Version auslässt, wird die API-Version der übergeordneten Ressource verwendet. Wenn die geschachtelte Ressource eine API-Version angibt, wird die angegebene API-Version verwendet.

Die Namen der untergeordneten Ressourcen sind auf default und exampleshare festgelegt, die vollständigen Namen enthalten jedoch die übergeordneten Namen. examplestorage oder default wird nicht angegeben, da dieser Teil von der übergeordneten Ressource übernommen wird.

Eine geschachtelte Ressource kann auf Eigenschaften ihrer übergeordneten Ressource zugreifen. Andere Ressourcen, die innerhalb des Textkörpers derselben übergeordneten Ressource deklariert sind, können aufeinander verweisen, indem die symbolischen Namen verwendet werden. Eine übergeordnete Ressource greift möglicherweise nicht auf die Eigenschaften der darin enthaltenen Ressourcen zu. Dieser Versuch würde zu einer zyklischen Abhängigkeit führen.

Um auf eine geschachtelte Ressource außerhalb der übergeordneten Ressource zu verweisen, muss sie mit dem enthaltenden Ressourcennamen und dem ::-Operator qualifiziert werden. So können Sie beispielsweise eine Eigenschaft von einer untergeordneten Ressource ausgeben:

output childAddressPrefix string = VNet1::VNet1_Subnet1.properties.addressPrefix

Außerhalb der übergeordneten Ressource

Das folgende Beispiel zeigt die untergeordnete Ressource außerhalb der übergeordneten Ressource an. So können Sie vorgehen, wenn die übergeordnete Ressource nicht in derselben Vorlage bereitgestellt wird oder wenn Sie eine Schleife verwenden möchten, um mehrere untergeordnete Ressourcen zu erstellen. Geben Sie die übergeordnete Eigenschaft für das untergeordnete Element an, wobei der Wert auf den symbolischen Namen des übergeordneten Elements festgelegt ist. Mit dieser Syntax müssen Sie weiterhin den vollständigen Ressourcentyp deklarieren, aber der Name der untergeordneten Ressource ist nur der Name des untergeordneten Elements.

resource <parent-resource-symbolic-name> '<resource-type>@<api-version>' = {
  name: 'myParent'
  <parent-resource-properties>
}

resource <child-resource-symbolic-name> '<child-resource-type>@<api-version>' = {
  parent: <parent-resource-symbolic-name>
  name: 'myChild'
  <child-resource-properties>
}

Bei Definition außerhalb der übergeordneten Ressource formatieren Sie den Typ und Namen mit Schrägstrichen, um den übergeordneten Typ und Namen einzuschließen.

Das folgende Beispiel zeigt ein Speicherkonto, einen Dateidienst und eine Dateifreigabe, die alle auf Stammebene definiert sind.

resource storage 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: 'examplestorage'
  location: resourceGroup().location
  kind: 'StorageV2'
  sku: {
    name: 'Standard_LRS'
  }
}

resource service 'Microsoft.Storage/storageAccounts/fileServices@2022-09-01' = {
  name: 'default'
  parent: storage
}

resource share 'Microsoft.Storage/storageAccounts/fileServices/shares@2022-09-01' = {
  name: 'exampleshare'
  parent: service
}

Das Verweisen auf den symbolischen Namen der untergeordneten Ressource funktioniert genauso wie das Verweisen auf das übergeordnete Element.

Vollständiger Ressourcenname außerhalb des übergeordneten Elements

Sie können auch den vollständigen Ressourcennamen und -typ verwenden, wenn Sie die untergeordnete Ressource außerhalb des übergeordneten Elements deklarieren. Sie legen die Eigenschaft für das übergeordnete Element nicht an der untergeordneten Ressource fest. Da die Abhängigkeit nicht abgeleitet werden kann, müssen Sie diese explizit festlegen.

resource storage 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: 'examplestorage'
  location: resourceGroup().location
  kind: 'StorageV2'
  sku: {
    name: 'Standard_LRS'
  }
}

resource service 'Microsoft.Storage/storageAccounts/fileServices@2022-09-01' = {
  name: 'examplestorage/default'
  dependsOn: [
    storage
  ]
}

resource share 'Microsoft.Storage/storageAccounts/fileServices/shares@2022-09-01' = {
  name: 'examplestorage/default/exampleshare'
  dependsOn: [
    service
  ]
}

Wichtig

Das Festlegen des vollständigen Ressourcennamens und -typs ist nicht die empfohlene Vorgehensweise. Sie ist nicht so typsicher wie einer der anderen Ansätze. Weitere Informationen finden Sie unter Linter-Regel: Verwenden der übergeordneten Eigenschaft.

Nächste Schritte