Api Management Service - Get
取得 API 管理 服務資源描述。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}?api-version=2022-08-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
service
|
path | True |
string |
API 管理 服務的名稱。 Regex 模式: |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
已成功取得 API 管理 服務資源。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Api |
Api |
Api |
ApiManagementServiceGetMultiRegionInternalVnet
範例要求
範例回覆
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
"name": "apimservice1",
"type": "Microsoft.ApiManagement/service",
"tags": {},
"location": "West US",
"etag": "AAAAAADqC0c=",
"properties": {
"publisherEmail": "abcs@contoso.com",
"publisherName": "contoso publisher",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2019-12-02T01:42:09.1268424Z",
"gatewayUrl": "https://apimservice1.azure-api.net",
"gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
"portalUrl": "https://apimservice1.portal.azure-api.net",
"developerPortalUrl": "https://apimService1.developer.azure-api.net",
"managementApiUrl": "https://apimservice1.management.azure-api.net",
"scmUrl": "https://apimservice1.scm.azure-api.net",
"hostnameConfigurations": [
{
"type": "Proxy",
"hostName": "apimService1.azure-api.net",
"negotiateClientCertificate": false,
"defaultSslBinding": false,
"certificateSource": "BuiltIn"
},
{
"type": "Proxy",
"hostName": "apimgatewaytest.preview.net",
"negotiateClientCertificate": false,
"certificate": {
"expiry": "2019-08-16T16:51:34+00:00",
"thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
"subject": "CN=*.preview.net"
},
"defaultSslBinding": true,
"certificateSource": "Custom"
}
],
"publicIPAddresses": [
"137.XXX.11.74"
],
"privateIPAddresses": [
"172.XX.0.5"
],
"additionalLocations": [
{
"location": "West US 2",
"sku": {
"name": "Premium",
"capacity": 1
},
"publicIPAddresses": [
"40.XXX.79.187"
],
"privateIPAddresses": [
"10.0.X.6"
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
},
"gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
"disableGateway": false
}
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
},
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
},
"virtualNetworkType": "Internal",
"disableGateway": false,
"apiVersionConstraint": {}
},
"sku": {
"name": "Premium",
"capacity": 1
}
}
ApiManagementServiceGetService
範例要求
範例回覆
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/OGF-Z3-06162021-Premium",
"name": "OGF-Z3-06162021-Premium",
"type": "Microsoft.ApiManagement/service",
"tags": {
"owner": "v-aswmoh",
"ReleaseName": "Z3"
},
"location": "East US",
"etag": "AAAAAAAWN/4=",
"properties": {
"publisherEmail": "string",
"publisherName": "Test Premium",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2021-06-16T09:40:00.9453556Z",
"gatewayUrl": "https://ogf-z3-06162021-premium.azure-api.net",
"gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus-01.regional.azure-api.net",
"portalUrl": "https://ogf-z3-06162021-premium.portal.azure-api.net",
"developerPortalUrl": "https://ogf-z3-06162021-premium.developer.azure-api.net",
"managementApiUrl": "https://ogf-z3-06162021-premium.management.azure-api.net",
"scmUrl": "https://ogf-z3-06162021-premium.scm.azure-api.net",
"hostnameConfigurations": [
{
"type": "Proxy",
"hostName": "ogf-z3-06162021-premium.azure-api.net",
"negotiateClientCertificate": false,
"defaultSslBinding": false,
"certificateSource": "BuiltIn"
},
{
"type": "Proxy",
"hostName": "gateway.current.int-azure-api.net",
"keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
"negotiateClientCertificate": true,
"certificate": {
"expiry": "2022-01-08T22:32:32+00:00",
"thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
"subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
},
"defaultSslBinding": true,
"certificateSource": "Custom"
},
{
"type": "DeveloperPortal",
"hostName": "developer.current.int-azure-api.net",
"keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
"negotiateClientCertificate": false,
"certificate": {
"expiry": "2022-01-08T22:32:32+00:00",
"thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
"subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
},
"defaultSslBinding": false,
"certificateSource": "Custom"
},
{
"type": "Management",
"hostName": "mgmt.current.int-azure-api.net",
"keyVaultId": "https://ogf-testing.vault.azure.net/secrets/current-ssl",
"negotiateClientCertificate": false,
"certificate": {
"expiry": "2022-01-08T22:32:32+00:00",
"thumbprint": "BA0C286XXXXXXXX58A4A507E3DBD51",
"subject": "CN=*.current.int-azure-api.net, O=Microsoft Corporation, L=Redmond, S=WA, C=US"
},
"defaultSslBinding": false,
"certificateSource": "Custom"
}
],
"publicIPAddresses": [
"13.92.130.49"
],
"additionalLocations": [
{
"location": "East US 2",
"sku": {
"name": "Premium",
"capacity": 1
},
"zones": [],
"publicIPAddresses": [
"40.70.24.106"
],
"gatewayRegionalUrl": "https://ogf-z3-06162021-premium-eastus2-01.regional.azure-api.net",
"disableGateway": false,
"platformVersion": "stv2"
}
],
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "false",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "false"
},
"virtualNetworkType": "None",
"certificates": [],
"disableGateway": false,
"apiVersionConstraint": {
"minApiVersion": "2019-12-01"
},
"publicNetworkAccess": "Enabled",
"privateEndpointConnections": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointProxyName",
"type": "Microsoft.ApiManagement/service/privateEndpointConnections",
"name": "privateEndpointProxyName",
"properties": {
"provisioningState": "Pending",
"privateEndpoint": {
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
},
"privateLinkServiceConnectionState": {
"status": "Pending",
"description": "Please approve my request, thanks",
"actionsRequired": "None"
},
"groupIds": [
"Gateway"
]
}
}
],
"platformVersion": "stv2"
},
"sku": {
"name": "Premium",
"capacity": 1
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"principalId": "306205e7-b21a-41bf-92e2-3e28af30041e",
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
"userAssignedIdentities": {
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ogf-identity": {
"principalId": "713784d2-ee37-412a-95f0-3768f397f82d",
"clientId": "8d9791f2-0cdf-41f4-9e66-cdc39b496789"
}
}
},
"systemData": {
"createdBy": "string",
"createdByType": "User",
"createdAt": "2021-06-16T09:40:00.7106733Z",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-06-20T06:33:09.6159006Z"
}
}
ApiManagementServiceGetServiceHavingMsi
範例要求
範例回覆
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
"name": "apimService1",
"type": "Microsoft.ApiManagement/service",
"tags": {},
"location": "West Europe",
"etag": "AAAAAAAENfI=",
"properties": {
"publisherEmail": "foo@contoso.com",
"publisherName": "Contoso",
"notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
"provisioningState": "Succeeded",
"targetProvisioningState": "",
"createdAtUtc": "2016-04-12T00:20:15.6018952Z",
"gatewayUrl": "https://apimService1.azure-api.net",
"gatewayRegionalUrl": "https://apimService1-westeurope-01.regional.azure-api.net",
"portalUrl": "https://apimService1.portal.azure-api.net",
"developerPortalUrl": "https://apimService1.developer.azure-api.net",
"managementApiUrl": "https://apimService1.management.azure-api.net",
"scmUrl": "https://apimService1.scm.azure-api.net",
"hostnameConfigurations": [
{
"type": "Proxy",
"hostName": "apimService1.azure-api.net",
"negotiateClientCertificate": false,
"defaultSslBinding": false,
"certificateSource": "BuiltIn"
},
{
"type": "Proxy",
"hostName": "proxy.msitesting.net",
"keyVaultId": "https://samir-msi-keyvault.vault.azure.net/secrets/msicertificate",
"negotiateClientCertificate": false,
"certificate": {
"expiry": "2020-12-18T11:11:47+00:00",
"thumbprint": "9833D531D7A45XXXXXA85908BD3692E0BD3F",
"subject": "CN=*.msitesting.net"
},
"defaultSslBinding": true,
"certificateSource": "KeyVault"
}
],
"publicIPAddresses": [
"13.94.xxx.188"
],
"virtualNetworkConfiguration": {
"subnetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
},
"customProperties": {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
"Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
},
"virtualNetworkType": "External",
"disableGateway": false
},
"sku": {
"name": "Premium",
"capacity": 1
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"principalId": "ca1d33f7-0000-42ec-0000-d526a1ee953a",
"tenantId": "72f988bf-0000-41af-0000-2d7cd011db47",
"userAssignedIdentities": {
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {
"principalId": "95194df2-9208-0000-0000-a10d2af9b5a3",
"clientId": "aaff9c7d-0000-4db2-0000-ab0e3e7806cf"
}
}
}
}
定義
名稱 | Description |
---|---|
Additional |
其他 API 管理 資源位置的描述。 |
Api |
Api 管理服務資源的識別屬性。 |
Api |
清單或取得回應中的單一 API 管理 服務資源。 |
Api |
API 管理 服務資源 SKU 屬性。 |
Apim |
用於資源的身分識別類型。 「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別,和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 |
Api |
API 管理 服務的控制平面 Api 版本條件約束。 |
Arm |
ARM 資源標識碼的包裝函式 |
Certificate |
憑證組態,其中包含不受信任的中繼和跟證書。 |
Certificate |
SSL 憑證資訊。 |
Certificate |
憑證來源。 |
Certificate |
憑證狀態。 |
created |
建立資源的身分識別類型。 |
Error |
錯誤欄位合約。 |
Error |
錯誤回應。 |
Hostname |
自定義主機名組態。 |
Hostname |
主機名類型。 |
Nat |
屬性可用來啟用此 API 管理 服務的 NAT 閘道。 |
Platform |
執行服務的計算平臺版本。 |
Private |
私人端點連線狀態。 |
Private |
服務取用者與提供者之間連線狀態的相關信息集合。 |
Public |
此 API 管理 服務是否允許公用端點存取。 值是選擇性的,但如果傳入,則必須是 『Enabled』 或 'Disabled'。 如果 'Disabled',私人端點是獨佔存取方法。 預設值為 'Enabled' |
Remote |
遠端私人端點連線資源。 |
Sku |
Sku 的名稱。 |
system |
與建立和上次修改資源相關的元數據。 |
User |
|
Virtual |
部署 API 管理 服務的虛擬網路組態。 |
Virtual |
需要在其中設定 API 管理 服務的 VPN 類型。 無 (預設值) 表示 API 管理 服務不屬於任何 虛擬網路,外部表示 API 管理 部署是在具有因特網面向端點的 虛擬網路 內設定,而內部表示 API 管理 部署只會在具有內部網路面向端點的 虛擬網路 內設定. |
AdditionalLocation
其他 API 管理 資源位置的描述。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
disableGateway |
boolean |
False |
屬性僅適用於部署在多個位置的 Api 管理服務。 這可用來停用這個額外位置的閘道。 |
gatewayRegionalUrl |
string |
區域中 API 管理 服務的閘道 URL。 |
|
location |
string |
Azure 資料中心區域之間的其他區域位置名稱。 |
|
natGatewayState | Disabled |
屬性可用來啟用此 API 管理 服務的 NAT 閘道。 |
|
outboundPublicIPAddresses |
string[] |
與 NAT 閘道部署服務相關聯的輸出公用 IPV4 位址前置詞。 僅適用於 stv2 平臺上的進階 SKU。 |
|
platformVersion |
執行服務的計算平臺版本。 |
||
privateIPAddresses |
string[] |
API 管理 服務的私人靜態負載平衡 IP 位址,此位址會部署在特定額外位置的內部 虛擬網路。 僅適用於基本、標準、進階和隔離 SKU。 |
|
publicIPAddresses |
string[] |
其他位置中 API 管理 服務的公用靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。 |
|
publicIpAddressId |
string |
公用標準 SKU IP V4 型 IP 位址,要與位置中 虛擬網路 部署的服務相關聯。 僅支援在 虛擬網路 中部署進階 SKU。 |
|
sku |
API 管理 服務的 SKU 屬性。 |
||
virtualNetworkConfiguration |
位置的虛擬網路組態。 |
||
zones |
string[] |
可用性區域清單,指出資源需要來自何處。 |
ApiManagementServiceIdentity
Api 管理服務資源的識別屬性。
名稱 | 類型 | Description |
---|---|---|
principalId |
string |
身分識別的主體標識碼。 |
tenantId |
string |
身分識別的用戶端租用戶標識碼。 |
type |
用於資源的身分識別類型。 「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別,和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 |
|
userAssignedIdentities |
<string,
User |
與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
ApiManagementServiceResource
清單或取得回應中的單一 API 管理 服務資源。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
etag |
string |
資源的 ETag。 |
|
id |
string |
資源識別碼。 |
|
identity |
Api 管理服務的受控服務識別。 |
||
location |
string |
資源位置。 |
|
name |
string |
資源名稱。 |
|
properties.additionalLocations |
API 管理 服務的其他數據中心位置。 |
||
properties.apiVersionConstraint |
API 管理 服務的控制平面 Api 版本條件約束。 |
||
properties.certificates |
需要安裝在 API 管理 服務中的憑證清單。 可安裝的憑證上限為10。 |
||
properties.createdAtUtc |
string |
建立 API 管理 服務的UTC日期。日期符合下列格式: |
|
properties.customProperties |
object |
API 管理 服務的自定義屬性。 |
|
properties.developerPortalUrl |
string |
API 管理 服務的 DEveloper 入口網站端點 URL。 |
|
properties.disableGateway |
boolean |
False |
屬性僅適用於部署在多個位置的 Api 管理服務。 這可用來停用主要區域中的閘道。 |
properties.enableClientCertificate |
boolean |
False |
屬性僅供取用 SKU 服務使用。 這會強制執行客戶端憑證,以針對閘道的每個要求呈現。 這也可讓您在閘道的原則中驗證憑證。 |
properties.gatewayRegionalUrl |
string |
默認區域中 API 管理 服務的閘道 URL。 |
|
properties.gatewayUrl |
string |
API 管理 服務的閘道 URL。 |
|
properties.hostnameConfigurations |
API 管理 服務的自定義主機名組態。 |
||
properties.managementApiUrl |
string |
API 管理 服務的管理 API 端點 URL。 |
|
properties.natGatewayState | Disabled |
屬性可用來啟用此 API 管理 服務的 NAT 閘道。 |
|
properties.notificationSenderEmail |
string |
Email將傳送通知的位址。 |
|
properties.outboundPublicIPAddresses |
string[] |
與 NAT 閘道部署服務相關聯的輸出公用 IPV4 位址前置詞。 僅適用於 stv2 平臺上的進階 SKU。 |
|
properties.platformVersion |
在此位置執行服務的計算平臺版本。 |
||
properties.portalUrl |
string |
API 管理 服務的發行者入口網站端點 URL。 |
|
properties.privateEndpointConnections |
此服務的私人端點連線清單。 |
||
properties.privateIPAddresses |
string[] |
主要區域中部署於內部 虛擬網路 中之 API 管理 服務的私人靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。 |
|
properties.provisioningState |
string |
API 管理 服務的目前布建狀態,可以是下列其中一項:Created/Activating/Succeeded/Updateing/Failed/Stopped/Terminating/TerminationingFailed/Deleted。 |
|
properties.publicIPAddresses |
string[] |
主要區域中 API 管理 服務的公用靜態負載平衡 IP 位址。 僅適用於基本、標準、進階和隔離 SKU。 |
|
properties.publicIpAddressId |
string |
要與區域中已部署服務 虛擬網路 相關聯的公用標準 SKU IP V4 型 IP 位址。 僅支援部署在 虛擬網路 中的開發人員和進階 SKU。 |
|
properties.publicNetworkAccess |
此 API 管理 服務是否允許公用端點存取。 值是選擇性的,但如果傳入,則必須是 『Enabled』 或 'Disabled'。 如果 'Disabled',私人端點是獨佔存取方法。 預設值為 'Enabled' |
||
properties.publisherEmail |
string |
發行者電子郵件。 |
|
properties.publisherName |
string |
發行者名稱。 |
|
properties.restore |
boolean |
False |
如果先前已虛刪除 Api Management Service,請將其取消刪除。 如果指定此旗標,並將 設定為 True,則會忽略所有其他屬性。 |
properties.scmUrl |
string |
API 管理 服務的 SCM 端點 URL。 |
|
properties.targetProvisioningState |
string |
API 管理 服務的布建狀態,這是服務上啟動長時間執行作業的目標。 |
|
properties.virtualNetworkConfiguration |
API 管理 服務的虛擬網路組態。 |
||
properties.virtualNetworkType | None |
需要在其中設定 API 管理 服務的 VPN 類型。 無 (預設值) 表示 API 管理 服務不屬於任何 虛擬網路,外部表示 API 管理 部署是在具有因特網面向端點的 虛擬網路 內設定,而內部表示 API 管理 部署只會在具有內部網路面向端點的 虛擬網路 內設定. |
|
sku |
API 管理 服務的 SKU 屬性。 |
||
systemData |
與建立和上次修改資源相關的元數據。 |
||
tags |
object |
資源標籤。 |
|
type |
string |
API 管理 資源的資源類型會設定為 Microsoft.ApiManagement。 |
|
zones |
string[] |
可用性區域清單,指出資源需要來自何處。 |
ApiManagementServiceSkuProperties
API 管理 服務資源 SKU 屬性。
名稱 | 類型 | Description |
---|---|---|
capacity |
integer |
SKU 的容量 (SKU) 的已部署單位數目。 針對 [使用量 SKU 容量] 必須指定為 0。 |
name |
Sku 的名稱。 |
ApimIdentityType
用於資源的身分識別類型。 「SystemAssigned、UserAssigned」類型同時包含隱含建立的身分識別,和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。
名稱 | 類型 | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
string |
ApiVersionConstraint
API 管理 服務的控制平面 Api 版本條件約束。
名稱 | 類型 | Description |
---|---|---|
minApiVersion |
string |
將控制平面 API 呼叫限制為 API 管理 版本等於或大於此值的服務。 |
ArmIdWrapper
ARM 資源標識碼的包裝函式
名稱 | 類型 | Description |
---|---|---|
id |
string |
CertificateConfiguration
憑證組態,其中包含不受信任的中繼和跟證書。
名稱 | 類型 | Description |
---|---|---|
certificate |
憑證資訊。 |
|
certificatePassword |
string |
憑證密碼。 |
encodedCertificate |
string |
Base64 編碼的憑證。 |
storeName |
enum:
|
System.Security.Cryptography.x509certificates.StoreName 證書存儲位置。 只有 Root 和 CertificateAuthority 是有效的位置。 |
CertificateInformation
SSL 憑證資訊。
名稱 | 類型 | Description |
---|---|---|
expiry |
string |
憑證的到期日。 日期符合下列格式: |
subject |
string |
憑證的主體。 |
thumbprint |
string |
憑證的指紋。 |
CertificateSource
憑證來源。
名稱 | 類型 | Description |
---|---|---|
BuiltIn |
string |
|
Custom |
string |
|
KeyVault |
string |
|
Managed |
string |
CertificateStatus
憑證狀態。
名稱 | 類型 | Description |
---|---|---|
Completed |
string |
|
Failed |
string |
|
InProgress |
string |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorFieldContract
錯誤欄位合約。
名稱 | 類型 | Description |
---|---|---|
code |
string |
屬性層級錯誤碼。 |
message |
string |
人類可讀取的屬性層級錯誤表示法。 |
target |
string |
屬性名稱。 |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error.code |
string |
服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。 |
error.details |
要求中傳送無效欄位的清單,以防發生驗證錯誤。 |
|
error.message |
string |
人類可閱讀的錯誤表示法。 |
HostnameConfiguration
自定義主機名組態。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
certificate |
憑證資訊。 |
||
certificatePassword |
string |
憑證密碼。 |
|
certificateSource |
憑證來源。 |
||
certificateStatus |
憑證狀態。 |
||
defaultSslBinding |
boolean |
False |
指定 true,將與此主機名相關聯的憑證設定為預設 SSL 憑證。 如果用戶端未傳送 SNI 標頭,則這會是將會受到挑戰的憑證。 如果服務已啟用多個自定義主機名,而且必須決定預設 SSL 憑證,則此屬性很有用。 僅套用至閘道主機名稱類型的設定。 |
encodedCertificate |
string |
Base64 編碼的憑證。 |
|
hostName |
string |
在 Api 管理服務上設定的主機名。 |
|
identityClientId |
string |
系統或使用者指派的受控識別 clientId,由 Azure AD 產生,可存取包含 SSL 憑證的 keyVault。 |
|
keyVaultId |
string |
包含 Ssl 憑證的 KeyVault 秘密 URL。 如果提供包含版本的絕對 URL,則 SSL 憑證的自動更新將無法運作。 這需要使用 aka.ms/apimmsi 來設定 Api 管理服務。 秘密的類型應該是 application/x-pkcs12 |
|
negotiateClientCertificate |
boolean |
False |
指定 true 以一律在主機名上交涉客戶端憑證。 默認值為 false。 |
type |
主機名類型。 |
HostnameType
主機名類型。
名稱 | 類型 | Description |
---|---|---|
DeveloperPortal |
string |
|
Management |
string |
|
Portal |
string |
|
Proxy |
string |
|
Scm |
string |
NatGatewayState
屬性可用來啟用此 API 管理 服務的 NAT 閘道。
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
服務的 Nat 閘道已停用。 |
Enabled |
string |
已啟用服務的 Nat 閘道。 |
PlatformVersion
執行服務的計算平臺版本。
名稱 | 類型 | Description |
---|---|---|
mtv1 |
string |
在多租使用者 V1 平台上執行服務的平臺。 |
stv1 |
string |
在單一租使用者 V1 平台上執行服務的平臺。 |
stv2 |
string |
在單一租使用者 V2 平台上執行服務的平臺。 |
undetermined |
string |
無法判斷平臺版本,因為未部署計算平臺。 |
PrivateEndpointServiceConnectionStatus
私人端點連線狀態。
名稱 | 類型 | Description |
---|---|---|
Approved |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
服務取用者與提供者之間連線狀態的相關信息集合。
名稱 | 類型 | Description |
---|---|---|
actionsRequired |
string |
訊息,指出服務提供者上的變更是否需要取用者的任何更新。 |
description |
string |
核准/拒絕連線的原因。 |
status |
指出連線是否已由服務的擁有者核准/拒絕/移除。 |
PublicNetworkAccess
此 API 管理 服務是否允許公用端點存取。 值是選擇性的,但如果傳入,則必須是 『Enabled』 或 'Disabled'。 如果 'Disabled',私人端點是獨佔存取方法。 預設值為 'Enabled'
名稱 | 類型 | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
RemotePrivateEndpointConnectionWrapper
遠端私人端點連線資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
私人端點聯機資源標識碼 |
name |
string |
私人端點連線名稱 |
properties.groupIds |
string[] |
所有群組標識碼。 |
properties.privateEndpoint |
私人端點的資源。 |
|
properties.privateLinkServiceConnectionState |
服務取用者與提供者之間連線狀態的相關信息集合。 |
|
properties.provisioningState |
string |
私人端點聯機資源的布建狀態。 |
type |
string |
私人端點連線資源類型 |
SkuType
Sku 的名稱。
名稱 | 類型 | Description |
---|---|---|
Basic |
string |
Api 管理的基本 SKU。 |
Consumption |
string |
Api 管理的取用 SKU。 |
Developer |
string |
Api 管理的開發人員 SKU。 |
Isolated |
string |
Api 管理的隔離 SKU。 |
Premium |
string |
Api 管理的進階 SKU。 |
Standard |
string |
Api 管理的標準 SKU。 |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |
UserIdentityProperties
名稱 | 類型 | Description |
---|---|---|
clientId |
string |
使用者指派身分識別的用戶端標識碼。 |
principalId |
string |
使用者指派身分識別的主體標識碼。 |
VirtualNetworkConfiguration
部署 API 管理 服務的虛擬網路組態。
名稱 | 類型 | Description |
---|---|---|
subnetResourceId |
string |
虛擬網路中要部署 API 管理 服務之子網的完整資源標識符。 |
subnetname |
string |
子網路的名稱。 |
vnetid |
string |
虛擬網路識別碼。 這通常是 GUID。 預設會預期 Null GUID。 |
VirtualNetworkType
需要在其中設定 API 管理 服務的 VPN 類型。 無 (預設值) 表示 API 管理 服務不屬於任何 虛擬網路,外部表示 API 管理 部署是在具有因特網面向端點的 虛擬網路 內設定,而內部表示 API 管理 部署只會在具有內部網路面向端點的 虛擬網路 內設定.
名稱 | 類型 | Description |
---|---|---|
External |
string |
此服務是 虛擬網路的一部分,可從因特網存取。 |
Internal |
string |
此服務是 虛擬網路的一部分,它只能從虛擬網路記憶體取。 |
None |
string |
服務不屬於任何 虛擬網路。 |