Published Artifacts - List
A közzétett tervdefiníció egy verziójához tartozó összetevők listázása.
GET https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}/artifacts?api-version=2018-11-01-preview
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
blueprint
|
path | True |
string |
A tervdefiníció neve. |
resource
|
path | True |
string |
Az erőforrás hatóköre. Érvényes hatókörök: felügyeleti csoport (formátum: "/providers/Microsoft.Management/managementGroups/{managementGroup}"), előfizetés (formátum: "/subscriptions/{subscriptionId}"). |
version
|
path | True |
string |
A közzétett tervdefiníció verziója. |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK – a lekért közzétett tervdefiníció egy verziójának összetevői. |
|
Other Status Codes |
Tervekkel kapcsolatos hibaválasz. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | a felhasználói fiók megszemélyesítése |
Példák
MG-Artifact |
Sub-Artifact |
MG-ArtifactList
Mintakérelem
Mintaválasz
{
"value": [
{
"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/versions/V2/artifacts/ownerAssignment",
"type": "Microsoft.Blueprint/blueprints/versions/artifacts",
"name": "ownerAssignment"
},
{
"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/versions/V2/artifacts/costCenterPolicy",
"type": "Microsoft.Blueprint/blueprints/versions/artifacts",
"name": "costCenterPolicy"
},
{
"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/versions/V2/artifacts/storageTemplate",
"type": "Microsoft.Blueprint/blueprints/versions/artifacts",
"name": "storageTemplate"
}
]
}
Sub-ArtifactList
Mintakérelem
Mintaválasz
{
"value": [
{
"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/versions/V2/artifacts/ownerAssignment",
"type": "Microsoft.Blueprint/blueprints/versions/artifacts",
"name": "ownerAssignment"
},
{
"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/versions/V2/artifacts/costCenterPolicy",
"type": "Microsoft.Blueprint/blueprints/versions/artifacts",
"name": "costCenterPolicy"
},
{
"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/versions/V2/artifacts/storageTemplate",
"type": "Microsoft.Blueprint/blueprints/versions/artifacts",
"name": "storageTemplate"
}
]
}
Definíciók
Name | Description |
---|---|
Artifact |
Tervösszetevők listája. |
Cloud |
|
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
Hibaválasz |
key |
A Key Vaultra mutató hivatkozást adja meg. |
Parameter |
A megadott paraméter értéke. Lehet "érték" vagy "hivatkozás", de mindkettő nem. |
Policy |
Szabályzat-hozzárendelést alkalmazó tervösszetevő. |
Role |
Egy szerepkör-hozzárendelést alkalmazó tervösszetevő. |
Secret |
Hivatkozás Key Vault-titkos kódra. |
Template |
Resource Manager-sablont üzembe helyező tervösszetevő. |
ArtifactList
Tervösszetevők listája.
Name | Típus | Description |
---|---|---|
nextLink |
string |
A találatok következő oldalára mutató hivatkozás. |
value | Artifact[]: |
Tervösszetevők listája. |
CloudError
Name | Típus | Description |
---|---|---|
error |
Hibaválasz |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további információtípus. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
additionalInfo |
A hiba további információi. |
|
code |
string |
A hibakód. |
details |
A hiba részletei. |
|
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
keyVaultReference
A Key Vaultra mutató hivatkozást adja meg.
Name | Típus | Description |
---|---|---|
id |
string |
A Key Vault Azure-erőforrás-azonosítója. |
ParameterValue
A megadott paraméter értéke. Lehet "érték" vagy "hivatkozás", de mindkettő nem.
Name | Típus | Description |
---|---|---|
reference |
Paraméterérték referenciatípusként. |
|
value |
object |
Paraméterérték. Bármely érvényes JSON-érték megengedett, beleértve az objektumokat, tömböket, sztringeket, számokat és logikai értékeket. |
PolicyAssignmentArtifact
Szabályzat-hozzárendelést alkalmazó tervösszetevő.
Name | Típus | Description |
---|---|---|
id |
string |
Az Azure-ban található erőforrások megkereséséhez használt karakterlánc-azonosító. |
kind |
string:
policy |
Megadja a tervösszetevő típusát. |
name |
string |
Az erőforrás neve. |
properties.dependsOn |
string[] |
A megadott összetevő előtt üzembe helyezendő összetevők. |
properties.description |
string maxLength: 500 |
Többsoros magyarázat az erőforrásra. |
properties.displayName |
string maxLength: 256 |
Egysoros sztring ismerteti ezt az erőforrást. |
properties.parameters |
<string,
Parameter |
A szabályzatdefiníció paraméterértékei. |
properties.policyDefinitionId |
string |
A szabályzatdefiníció Azure-erőforrás-azonosítója. |
properties.resourceGroup |
string |
Annak az erőforráscsoportnak a helyőrzője, amelyhez a szabályzat hozzá lesz rendelve. |
type |
string |
Az erőforrás típusa. |
RoleAssignmentArtifact
Egy szerepkör-hozzárendelést alkalmazó tervösszetevő.
Name | Típus | Description |
---|---|---|
id |
string |
Az Azure-ban található erőforrások megkereséséhez használt karakterlánc-azonosító. |
kind |
string:
role |
Megadja a tervösszetevő típusát. |
name |
string |
Az erőforrás neve. |
properties.dependsOn |
string[] |
A megadott összetevő előtt üzembe helyezendő összetevők. |
properties.description |
string maxLength: 500 |
Többsoros magyarázat az erőforrásra. |
properties.displayName |
string maxLength: 256 |
Egysoros sztring ismerteti ezt az erőforrást. |
properties.principalIds |
Felhasználói vagy csoportidentitások tömbje az Azure Active Directoryban. A roleDefinition minden identitásra érvényes lesz. |
|
properties.resourceGroup |
string |
A RoleAssignment a resourceGroup hatóköre lesz. Ha üres, az előfizetésre terjed ki. |
properties.roleDefinitionId |
string |
A RoleDefinition Azure-erőforrás-azonosítója. |
type |
string |
Az erőforrás típusa. |
SecretValueReference
Hivatkozás Key Vault-titkos kódra.
Name | Típus | Description |
---|---|---|
keyVault |
Egy adott Azure Key Vaultra mutató hivatkozást ad meg. |
|
secretName |
string |
A titkos kód neve. |
secretVersion |
string |
A használni kívánt titkos kód verziója. Ha üresen hagyja, a titkos kód legújabb verzióját használja a rendszer. |
TemplateArtifact
Resource Manager-sablont üzembe helyező tervösszetevő.
Name | Típus | Description |
---|---|---|
id |
string |
Az Azure-ban található erőforrások megkereséséhez használt karakterlánc-azonosító. |
kind |
string:
template |
Megadja a tervösszetevő típusát. |
name |
string |
Az erőforrás neve. |
properties.dependsOn |
string[] |
A megadott összetevő előtt üzembe helyezendő összetevők. |
properties.description |
string maxLength: 500 |
Többsoros magyarázat az erőforrásra. |
properties.displayName |
string maxLength: 256 |
Egysoros sztring ismerteti ezt az erőforrást. |
properties.parameters |
<string,
Parameter |
A Resource Manager-sablon tervösszetevőjének paraméterértékei. |
properties.resourceGroup |
string |
Adott esetben annak az erőforráscsoportnak a helyőrzőjének a neve, amelyre a Resource Manager-sablon tervösszetevőjét telepíteni fogja. |
properties.template |
object |
A Resource Manager-sablon tervösszetevőjének törzse. |
type |
string |
Az erőforrás típusa. |