制图额外资源
您可能已经浏览过Examples 页面，注意到 Azure 输出程序支持许多 Azure 资源，但并非所有资源都在示例页面中进行了记录。
本页面将帮助您了解 Azure 集成支持哪些 Azure 资源，以及如何将这些资源映射到 Port。
Azure 导出器是否支持该资源？
Azure 导出器依赖于基础 Azure 资源通过 subscription 拥有的 List API 来获取 特定类型的所有资源。 如果是示例页面中没有记录的资源，可以通过以下步骤将其映射到 Port:
- 在Azure REST API reference 中查找资源。
- 如果是基础资源(格式为
Microsoft.<Provider>/<resourceName>)，可以在类型示例响应和 API URL 中找到！Storage Account Type- 如果它有订阅的列表 API，Azure 输出程序将支持它。
3.如果是扩展资源(格式为 Microsoft.<Provider>/<resourceName>/<extensionName>)，如Microsoft.Storage/storageAccounts/blobServices/containers。 - 然后，如果 Azure 导出器支持基础资源，则也将支持扩展资源。
- 如果它有订阅的列表 API，Azure 输出程序将支持它。
将资源映射到Port
在 Azure REST API 参考中找到资源并确认 Azure 输出程序支持该资源后，就可以按照以下步骤将其映射到 Port:
蓝图
为资源创建 Port 蓝图定义。 该蓝图定义基于 Azure REST API 参考中的资源 API 响应。
Azure Storage Account Rest API Response Example
{
"value": [
{
"id": "/subscriptions/{subscription-id}/resourceGroups/res2627/providers/Microsoft.Storage/storageAccounts/sto1125",
"kind": "Storage",
"location": "eastus",
"name": "sto1125",
"properties": {
"isHnsEnabled": true,
"creationTime": "2017-05-24T13:28:53.4540398Z",
"primaryEndpoints": {
"web": "https://sto1125.web.core.windows.net/",
"dfs": "https://sto1125.dfs.core.windows.net/",
"blob": "https://sto1125.blob.core.windows.net/",
"file": "https://sto1125.file.core.windows.net/",
"queue": "https://sto1125.queue.core.windows.net/",
"table": "https://sto1125.table.core.windows.net/",
"microsoftEndpoints": {
"web": "https://sto1125-microsoftrouting.web.core.windows.net/",
"dfs": "https://sto1125-microsoftrouting.dfs.core.windows.net/",
"blob": "https://sto1125-microsoftrouting.blob.core.windows.net/",
"file": "https://sto1125-microsoftrouting.file.core.windows.net/",
"queue": "https://sto1125-microsoftrouting.queue.core.windows.net/",
"table": "https://sto1125-microsoftrouting.table.core.windows.net/"
},
"internetEndpoints": {
"web": "https://sto1125-internetrouting.web.core.windows.net/",
"dfs": "https://sto1125-internetrouting.dfs.core.windows.net/",
"blob": "https://sto1125-internetrouting.blob.core.windows.net/",
"file": "https://sto1125-internetrouting.file.core.windows.net/"
}
},
"primaryLocation": "eastus",
"provisioningState": "Succeeded",
"routingPreference": {
"routingChoice": "MicrosoftRouting",
"publishMicrosoftEndpoints": true,
"publishInternetEndpoints": true
},
"encryption": {
"services": {
"file": {
"keyType": "Account",
"enabled": true,
"lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
},
"blob": {
"keyType": "Account",
"enabled": true,
"lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
}
},
"keySource": "Microsoft.Storage"
},
"secondaryLocation": "centraluseuap",
"statusOfPrimary": "available",
"statusOfSecondary": "available",
"supportsHttpsTrafficOnly": false
},
"sku": {
"name": "Standard_GRS",
"tier": "Standard"
},
"tags": {
"key1": "value1",
"key2": "value2"
},
"type": "Microsoft.Storage/storageAccounts"
}
]
}
根据 API 响应，可以为资源创建 Port 蓝图定义。
Storage Account Blueprint
{
"identifier": "azureStorageAccount",
"description": "This blueprint represents an Azure Storage Account in our software catalog",
"title": "Storage Account",
"icon": "Azure",
"schema": {
"properties": {
"location": {
"title": "Location",
"type": "string"
},
"provisioningState": {
"title": "Provisioning State",
"type": "string",
"enum": ["Creating", "ResolvingDNS", "Succeeded"]
},
"creationTime": {
"title": "Creation Time",
"type": "string",
"format": "date-time"
},
"isHnsEnabled": {
"title": "Is HNS Enabled",
"type": "boolean",
"default": false
},
"fileEncryptionEnabled": {
"title": "File Encryption Enabled",
"type": "boolean"
},
"blobEncryptionEnabled": {
"title": "Blob Encryption Enabled",
"type": "boolean"
},
"primaryLocation": {
"title": "Primary Location",
"type": "string"
},
"secondaryLocation": {
"title": "Secondary Location",
"type": "string"
},
"statusOfPrimary": {
"title": "Status of Primary",
"type": "string",
"enum": ["available", "unavailable"],
"enumColors": {
"unavailable": "red",
"available": "green"
}
},
"statusOfSecondary": {
"title": "Status of Secondary",
"type": "string",
"enum": ["available", "unavailable"],
"enumColors": {
"unavailable": "red",
"available": "green"
}
},
"tags": {
"title": "Tags",
"type": "object"
},
"allowBlobPublicAccess": {
"title": "Allow Blob Public Access",
"type": "boolean"
}
},
"required": []
},
"mirrorProperties": {},
"calculationProperties": {},
"relations": {
"resourceGroup": {
"target": "azureResourceGroup",
"title": "Resource Group",
"required": false,
"many": false
}
}
}
整合配置
为资源创建集成配置。 集成配置是一个 YAML 文件，描述了将数据加载到开发者门户的 ETL 流程。
Mapping configuration for Storage Account and Storage Container
resources:
- kind: Microsoft.Storage/storageAccounts
selector:
query: "true"
# azure resource api version to query
apiVersion: "2023-01-01"
port:
entity:
mappings:
# lowercase only the resourceGroups namespace and name to align how azure API returns the resource group reference
identifier: '.id | split("/") | .[3] |= ascii_downcase |.[4] |= ascii_downcase | join("/")'
title: .name
blueprint: '"azureStorageAccount"'
properties:
location: .location
provisioningState: .properties.provisioningState
creationTime: .properties.creationTime
isHnsEnabled: .properties.isHnsEnabled
fileEncryptionEnabled: .properties.encryption.services.file.enabled
blobEncryptionEnabled: .properties.encryption.services.blob.enabled
primaryLocation: .properties.primaryLocation
secondaryLocation: .properties.secondaryLocation
statusOfPrimary: .properties.statusOfPrimary
statusOfSecondary: .properties.statusOfSecondary
allowBlobPublicAccess: .properties.allowBlobPublicAccess
tags: .tags
relations:
# resolve resource group id from storage account id
resourceGroup: '.id | split("/") | .[3] |= ascii_downcase |.[4] |= ascii_downcase | .[:5] |join("/")'
- kind: Microsoft.Storage/storageAccounts/blobServices/containers
selector:
query: "true"
# azure resource api version to query
apiVersion: "2023-01-01"
port:
entity:
mappings:
identifier: '.id | split("/") | .[3] |= ascii_downcase |.[4] |= ascii_downcase | join("/")'
title: .name
blueprint: '"azureStorageContainer"'
properties:
publicAccess: .properties.publicAccess
hasImmutabilityPolicy: .properties.hasImmutabilityPolicy
hasLegalHold: .properties.hasLegalHold
deleted: .properties.deleted
deletedTime: .properties.deletedTime
remainingRetentionDays: .properties.remainingRetentionDays
leaseStatus: .properties.leaseStatus
leaseState: .properties.leaseState
defaultEncryptionScope: .properties.defaultEncryptionScope
version: .properties.version
relations:
# resolve storage account id from container id
storageAccount: '.id | split("/") | .[3] |= ascii_downcase | .[4] |= ascii_downcase | .[:-4] | join("/")'
集成配置结构
-
类型 "字段描述了要摄入 Port 的 Azure 资源类型。类型 "字段应设置为resource guide 中显示的 Azure 资源类型。例如，"存储帐户 "的资源类型可通过here 以及资源对象结构找到。
resources:
- kind: Microsoft.Storage/storageAccounts
selector:
... -
选择器 "字段描述了 Azure 资源选择标准。
resources:
- kind: Microsoft.Storage/storageAccounts
selector:
query: "true" # JQ boolean expression. If evaluated to false - this object will be skipped.
apiVersion: "2023-01-01" # Azure API version to use to fetch the resource
port: -
查询 "字段是JQ boolean query ，如果评估结果为 "false"，则将跳过该资源。被用于示例 - 跳过同步不在特定区域的资源。
query: .location == "eastus2"-
The
apiVersionfield is the Azure API version to use to fetch the resource. This field is required for all resources. For example, the API versions for thestorageAccountresource was found in the Storage Account Rest APIapiVersion: "2023-01-01"
-
-
Port` 字段描述了要从 Azure 资源中创建的Port实体。
resources:
- kind: Microsoft.Storage/storageAccounts
selector:
query: "true" # JQ boolean query. If evaluated to false - skip syncing the object.
apiVersion: "2023-01-01" # Azure API version to use to fetch the resource
port:
entity:
mappings: # Mappings between one Azure object to a Port entity. Each value is a JQ query.
identifier: .id
title: .name
blueprint: '"azureStorageAccount"'
properties:
location: .location
provisioningState: .properties.provisioningState -
实体 "字段描述从 Azure 资源创建的 Port 实体。
-
映射 "字段描述了 Azure 资源与Port实体之间的映射。
identifier字段描述 Azure 资源标识符。所有资源都需要此字段。
mappings:
identifier: .id-
The
titlefield describes the Azure resource title. This field is required for all resources.mappings:
title: .name -
The
blueprintfield describes the Port blueprint to be used to create the Port entity. This field is required for all resources.mappings:
blueprint: '"azureStorageAccount"'
-
- The `properties` field describes the Azure resource properties to be mapped to the Port
mappings:
identifier: .id
title: .name
blueprint: '"azureStorageAccount"'
properties:
location: .location
provisioningState: .properties.provisioningState