Artifacts - Create Or Update

Služba:
Blueprints
Verze rozhraní API:
2018-11-01-preview

Vytvoření nebo aktualizace artefaktu podrobného plánu

PUT https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}?api-version=2018-11-01-preview

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
artifactName
 path True

string

Název artefaktu podrobného plánu
blueprintName
 path True

string

Název definice podrobného plánu
resourceScope
 path True

string

Rozsah prostředku. Platné obory jsou: skupina pro správu (formát: /providers/Microsoft.Management/managementGroups/{managementGroup}), předplatné (formát: /subscriptions/{subscriptionId}).
api-version
 query True

string

Verze rozhraní API klienta.

Text požadavku

Text žádosti může tvořit:

Name Description
PolicyAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení zásad.
RoleAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení role.
TemplateArtifact

Artefakt podrobného plánu, který nasadí šablonu Resource Manageru.

PolicyAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení zásad.

Name Vyžadováno Typ Description
kind True string:

policyAssignment

Určuje druh artefaktu podrobného plánu.
properties.parameters True

<string,  ParameterValue>

Hodnoty parametrů pro definici zásady.
properties.policyDefinitionId True

string

ID prostředku Azure definice zásady
properties.dependsOn

string[]

Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description

string

maxLength: 500

Víceřádkové vysvětlení tohoto prostředku
properties.displayName

string

maxLength: 256

Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.resourceGroup

string

Název zástupného symbolu skupiny prostředků, ke které se zásada přiřadí.

RoleAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení role.

Name Vyžadováno Typ Description
kind True string:

roleAssignment

Určuje druh artefaktu podrobného plánu.
properties.principalIds True

Pole identit uživatelů nebo skupin v Azure Active Directory Definice role se použije pro každou identitu.
properties.roleDefinitionId True

string

ID prostředku Azure roleDefinition.
properties.dependsOn

string[]

Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description

string

maxLength: 500

Víceřádkové vysvětlení tohoto prostředku
properties.displayName

string

maxLength: 256

Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.resourceGroup

string

RoleAssignment bude oborem pro tuto skupinu prostředků. Pokud je prázdný, rozsah se vztahuje na předplatné.

TemplateArtifact

Artefakt podrobného plánu, který nasadí šablonu Resource Manageru.

Name Vyžadováno Typ Description
kind True string:

template

Určuje druh artefaktu podrobného plánu.
properties.parameters True

<string,  ParameterValue>

Hodnoty parametrů artefaktů šablony Resource Manageru
properties.template True

object

Tělo artefaktu podrobného plánu šablony Resource Manageru
properties.dependsOn

string[]

Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description

string

maxLength: 500

Víceřádkové vysvětlení tohoto prostředku
properties.displayName

string

maxLength: 256

Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.resourceGroup

string

Pokud je to možné, název zástupného symbolu skupiny prostředků, do kterého se nasadí artefakt podrobného plánu šablony Resource Manageru.

Odpovědi

Name Typ Description
201 Created Artifact:

Vytvořeno – artefakt podrobného plánu byl vytvořen nebo aktualizován.
Other Status Codes

CloudError

Odpověď na chybu podrobných plánů

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

MG-ARMTemplateArtifact
MG-PolicyAssignmentArtifact
MG-RoleAssignmentArtifact
Sub-ARMTemplateArtifact
Sub-PolicyAssignmentArtifact
Sub-RoleAssignmentArtifact

MG-ARMTemplateArtifact

Ukázkový požadavek

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate?api-version=2018-11-01-preview

{
  "kind": "template",
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  }
}

Ukázková odpověď

Stavový kód:
201 
{
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  },
  "kind": "template",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "storageTemplate"
}

MG-PolicyAssignmentArtifact

Ukázkový požadavek

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment"
}

Ukázková odpověď

Stavový kód:
201 
{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "costCenterPolicy"
}

MG-RoleAssignmentArtifact

Ukázkový požadavek

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment"
}

Ukázková odpověď

Stavový kód:
201 
{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment",
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "ownerAssignment"
}

Sub-ARMTemplateArtifact

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate?api-version=2018-11-01-preview

{
  "kind": "template",
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  }
}

Ukázková odpověď

Stavový kód:
201 
{
  "properties": {
    "template": {
      "contentVersion": "1.0.0.0",
      "parameters": {
        "storageAccountType": {
          "type": "string",
          "defaultValue": "Standard_LRS",
          "allowedValues": [
            "Standard_LRS",
            "Standard_GRS",
            "Standard_ZRS",
            "Premium_LRS"
          ],
          "metadata": {
            "description": "Storage Account type"
          }
        }
      },
      "variables": {
        "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]"
      },
      "resources": [
        {
          "type": "Microsoft.Storage/storageAccounts",
          "name": "[variables('storageAccountName')]",
          "apiVersion": "2016-01-01",
          "location": "[resourceGroup().location]",
          "sku": {
            "name": "[parameters('storageAccountType')]"
          },
          "kind": "Storage",
          "properties": {}
        }
      ],
      "outputs": {
        "storageAccountName": {
          "type": "string",
          "value": "[variables('storageAccountName')]"
        }
      }
    },
    "resourceGroup": "storageRG",
    "parameters": {
      "storageAccountType": {
        "value": "[parameters('storageAccountType')]"
      }
    }
  },
  "kind": "template",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "storageTemplate"
}

Sub-PolicyAssignmentArtifact

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment"
}

Ukázková odpověď

Stavový kód:
201 
{
  "properties": {
    "displayName": "force costCenter tag on all resources",
    "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62",
    "parameters": {
      "tagName": {
        "value": "costCenter"
      },
      "tagValue": {
        "value": "[parameter('costCenter')]"
      }
    }
  },
  "kind": "policyAssignment",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "costCenterPolicy"
}

Sub-RoleAssignmentArtifact

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment?api-version=2018-11-01-preview

{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment"
}

Ukázková odpověď

Stavový kód:
201 
{
  "properties": {
    "displayName": "enforce owners of given subscription",
    "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7",
    "principalIds": "[parameters('owners')]"
  },
  "kind": "roleAssignment",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment",
  "type": "Microsoft.Blueprint/blueprints/artifacts",
  "name": "ownerAssignment"
}

Definice

Name Description
CloudError
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorResponse

Odpověď na chybu
keyVaultReference

Určuje propojení se službou Key Vault.
ParameterValue

Hodnota pro zadaný parametr. Může to být buď hodnota, nebo odkaz, ale ne obojí.
PolicyAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení zásad.
RoleAssignmentArtifact

Artefakt podrobného plánu, který použije přiřazení role.
SecretValueReference

Odkaz na tajný klíč služby Key Vault
TemplateArtifact

Artefakt podrobného plánu, který nasadí šablonu Resource Manageru.

CloudError

Objekt
Name Typ Description
error

ErrorResponse

Odpověď na chybu
Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorResponse

Objekt

Odpověď na chybu

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.
code

string

Kód chyby.
details

ErrorResponse[]

Podrobnosti o chybě.
message

string

Chybová zpráva.
target

string

Cíl chyby.

keyVaultReference

Objekt

Určuje propojení se službou Key Vault.

Name Typ Description
id

string

ID prostředku Azure služby Key Vault.

ParameterValue

Objekt

Hodnota pro zadaný parametr. Může to být buď hodnota, nebo odkaz, ale ne obojí.

Name Typ Description
reference

SecretValueReference

Hodnota parametru jako typ odkazu
value

object

Hodnota parametru. Všechna platná hodnota JSON je povolená, včetně objektů, polí, řetězců, čísel a logických hodnot.

PolicyAssignmentArtifact

Objekt

Artefakt podrobného plánu, který použije přiřazení zásad.

Name Typ Description
id

string

ID řetězce použité k vyhledání libovolného prostředku v Azure.
kind string:

policyAssignment

Určuje druh artefaktu podrobného plánu.
name

string

Název tohoto prostředku
properties.dependsOn

string[]

Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description

string

maxLength: 500

Víceřádkové vysvětlení tohoto prostředku
properties.displayName

string

maxLength: 256

Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.parameters

<string,  ParameterValue>

Hodnoty parametrů pro definici zásady.
properties.policyDefinitionId

string

ID prostředku Azure definice zásady
properties.resourceGroup

string

Název zástupného symbolu skupiny prostředků, ke které se zásada přiřadí.
type

string

Typ tohoto prostředku

RoleAssignmentArtifact

Objekt

Artefakt podrobného plánu, který použije přiřazení role.

Name Typ Description
id

string

ID řetězce použité k vyhledání libovolného prostředku v Azure.
kind string:

roleAssignment

Určuje druh artefaktu podrobného plánu.
name

string

Název tohoto prostředku
properties.dependsOn

string[]

Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description

string

maxLength: 500

Víceřádkové vysvětlení tohoto prostředku
properties.displayName

string

maxLength: 256

Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.principalIds

Pole identit uživatelů nebo skupin v Azure Active Directory Definice role se použije pro každou identitu.
properties.resourceGroup

string

RoleAssignment bude oborem pro tuto skupinu prostředků. Pokud je prázdný, rozsah se vztahuje na předplatné.
properties.roleDefinitionId

string

ID prostředku Azure roleDefinition.
type

string

Typ tohoto prostředku

SecretValueReference

Objekt

Odkaz na tajný klíč služby Key Vault

Name Typ Description
keyVault

keyVaultReference

Určuje odkaz na danou službu Azure Key Vault.
secretName

string

Název tajného klíče.
secretVersion

string

Verze tajného kódu, který se má použít. Pokud necháte prázdné, použije se nejnovější verze tajného kódu.

TemplateArtifact

Objekt

Artefakt podrobného plánu, který nasadí šablonu Resource Manageru.

Name Typ Description
id

string

ID řetězce použité k vyhledání libovolného prostředku v Azure.
kind string:

template

Určuje druh artefaktu podrobného plánu.
name

string

Název tohoto prostředku
properties.dependsOn

string[]

Artefakty, které je potřeba nasadit před zadaným artefaktem.
properties.description

string

maxLength: 500

Víceřádkové vysvětlení tohoto prostředku
properties.displayName

string

maxLength: 256

Řetězec s jednou vložkou vysvětluje tento prostředek.
properties.parameters

<string,  ParameterValue>

Hodnoty parametrů artefaktů šablony Resource Manageru
properties.resourceGroup

string

Pokud je to možné, název zástupného symbolu skupiny prostředků, do kterého se nasadí artefakt podrobného plánu šablony Resource Manageru.
properties.template

object

Tělo artefaktu podrobného plánu šablony Resource Manageru
type

string

Typ tohoto prostředku