Microsoft.ConnectedCache (preview:2024-11-30)

2025/06/02 • 31 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ConnectedCache/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCustomers_ListBySubscription (new)
Description :  This api gets information about all enterpriseMccCustomer resources under the given subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnterpriseMccCustomerResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCustomers_ListBySubscription (new)
Description :  This api gets information about all ispCustomer resources under the given subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ConnectedCache/ispCustomers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IspCustomerResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCustomers_ListByResourceGroup (new)
Description :  This api gets the information about all enterprise mcc customer resources under the given subscription and resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnterpriseMccCustomerResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCustomers_Get (new)
Description :  Gets the enterprise mcc customer resource information using this get call
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCustomers_CreateOrUpdate (new)
Description :  This api creates an enterprise mcc customer with the specified create parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents the high level Nodes needed to provision customer resources ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCustomers_Update (new)
Description :  This api updates an existing enterprise mcc customer resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCustomers_Delete (new)
Description :  This api deletes an existing enterprise mcc customer resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_ListByEnterpriseMccCustomerResource (new)
Description :  This api retrieves information about all ispCacheNode resources under the given subscription and resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnterpriseMccCacheNodeResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_Get (new)
Description :  This api gets ispCacheNode resource information
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_CreateOrUpdate (new)
Description :  This api creates an ispCacheNode with the specified create parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents the high level Nodes needed to provision cache node resources ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_Update (new)
Description :  This api updates an existing ispCacheNode resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_Delete (new)
Description :  This api deletes an existing ispCacheNode resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_GetCacheNodeAutoUpdateHistory (new)
Description :  This api gets ispCacheNode resource auto update histrory information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}/getCacheNodeAutoUpdateHistory
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mcc cache node resource auto update history properties. ,
Required: False ,
}
{
customerId:
{
Description: Mcc customer resource Id. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Mcc cache node resource Id. ,
Required: False ,
}
string ,
autoUpdateHistory:
{
Description: Cache node resource auto update history information. ,
Required: False ,
}
[
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_GetCacheNodeInstallDetails (new)
Description :  This api gets secrets of the ispCacheNode resource install details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}/getCacheNodeInstallDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mcc cache node resource install script details. ,
Required: False ,
}
{
customerId:
{
Description: Mcc customer resource Id. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Mcc cache node resource Id. ,
Required: False ,
}
string ,
primaryAccountKey:
{
Description: Mcc primary account key. Internal to Mcc. ,
Format: password ,
Required: False ,
}
string ,
secondaryAccountKey:
{
Description: Mcc secondary account key. Internal to Mcc. ,
Format: password ,
Required: False ,
}
string ,
registrationKey:
{
Description: Mcc Iot Central temporary device registration key, used once. ,
Format: password ,
Required: False ,
}
string ,
tlsCertificateProvisioningKey:
{
Description: Mcc Tls certificate provisioning key. ,
Format: password ,
Required: False ,
}
string ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_GetCacheNodeMccIssueDetailsHistory (new)
Description :  This api gets ispCacheNode resource issues details histrory information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}/getCacheNodeMccIssueDetailsHistory
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mcc cache node resource issue history properties. ,
Required: False ,
}
{
customerId:
{
Description: Mcc customer resource Id. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Mcc cache node resource Id. ,
Required: False ,
}
string ,
mccIssueHistory:
{
Description: Cache node resource issue details history. ,
Required: False ,
}
[
{
mccIssueType:
{
Description: Mcc cache node issue type. ,
Required: False ,
}
string ,
toastString:
{
Description: Mcc cache node issues toastString. ,
Required: False ,
}
string ,
detailString:
{
Description: Mcc cache node issue detail string. ,
Required: False ,
}
string ,
helpLink:
{
Description: Mcc cache node issue related help link. ,
Required: False ,
}
string ,
issueStartDate:
{
Description: Mcc cache node issue start date. ,
Format: date-time ,
Required: False ,
}
string ,
issueEndDate:
{
Description: Mcc cache node issue end date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EnterpriseMccCacheNodesOperations_GetCacheNodeTlsCertificateHistory (new)
Description :  This api gets ispCacheNode resource tls certificate histrory information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/enterpriseMccCustomers/{customerResourceName}/enterpriseMccCacheNodes/{cacheNodeResourceName}/getCacheNodeTlsCertificateHistory
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mcc cache node resource Tls certificate details. ,
Required: False ,
}
{
customerId:
{
Description: Mcc customer resource Id. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Mcc cache node resource Id. ,
Required: False ,
}
string ,
tlsCertificateHistory:
{
Description: Cache node resource tls certificate history details. ,
Required: False ,
}
[
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCustomers_ListByResourceGroup (new)
Description :  This api gets the information about all ispCustomer resources under the given subscription and resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IspCustomerResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCustomers_Get (new)
Description :  Gets the ispCustomer resource information using this get call
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCustomers_CreateOrUpdate (new)
Description :  This api creates an ispCustomer with the specified create parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents the high level Nodes needed to provision isp customer resources ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCustomers_Update (new)
Description :  This api updates an existing ispCustomer resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
customer:
{
Description: Mcc customer resource (customer entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Customer resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Customer resource Guid Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Customer resource name. ,
Required: False ,
}
string ,
contactEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
contactPhone:
{
Description: Customer resource contact phone. ,
Required: False ,
}
string ,
contactName:
{
Description: Customer resource contact full name. ,
Required: False ,
}
string ,
isEntitled:
{
Description: Customer resource entitlement flag as boolean. ,
Required: False ,
}
boolean ,
releaseVersion:
{
Description: Customer resource Mcc release version. ,
Format: int32 ,
Required: False ,
}
integer ,
createAsyncOperationId:
{
Description: Customer resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Customer resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Customer resource sync attempts. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Customer resource last Azure sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Customer resource flag for enterprise management as boolean. ,
Required: False ,
}
boolean ,
shouldMigrate:
{
Description: Customer resource flag for migration. ,
Required: False ,
}
boolean ,
resendSignupCode:
{
Description: Customer resource flag for resending signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupCode:
{
Description: Customer resource flag for requiring verification of signup code as boolean. ,
Required: False ,
}
boolean ,
verifySignupPhrase:
{
Description: Customer resource phrase for verifying signup. ,
Format: password ,
Required: False ,
}
string ,
}
,
additionalCustomerProperties:
{
Description: Mcc customer resource additional properties. ,
Required: False ,
}
{
customerPropertiesOverviewCacheEfficiency:
{
Description: Customer resource cache efficiency. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageEgressMbps:
{
Description: Customer resource average egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewAverageMissMbps:
{
Description: Customer resource average cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMax:
{
Description: Customer resource maximum egress in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewEgressMbpsMaxDateTime:
{
Description: Customer resource peak egress timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewMissMbpsMax:
{
Description: Customer resource maximum cache miss throughput in Mbps. ,
Format: float ,
Required: False ,
}
number ,
customerPropertiesOverviewMissMbpsMaxDateTime:
{
Description: Customer resource peak cache miss throughput timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerPropertiesOverviewCacheNodesHealthyCount:
{
Description: Customer resource total healthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
customerPropertiesOverviewCacheNodesUnhealthyCount:
{
Description: Customer resource total unhealthy cache nodes. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatus:
{
Description: Customer resource signup status as boolean. ,
Required: False ,
}
boolean ,
signupStatusCode:
{
Description: Customer resource signup status as integer code. ,
Format: int32 ,
Required: False ,
}
integer ,
signupStatusText:
{
Description: Customer resource signup status as string text. ,
Required: False ,
}
string ,
signupPhaseStatusCode:
{
Description: Customer resource signup phase status code as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
signupPhaseStatusText:
{
Description: Customer resource signup phase status as string text. ,
Required: False ,
}
string ,
peeringDbLastUpdateDate:
{
Description: Customer resource last PeeringDB update timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
customerOrgName:
{
Description: Customer resource owner organization name. ,
Required: False ,
}
string ,
customerEmail:
{
Description: Customer resource contact email. ,
Required: False ,
}
string ,
customerTransitAsn:
{
Description: Customer resource transit Asn (autonomous system number). ,
Required: False ,
}
string ,
customerTransitState:
{
Description: Customer resource transit state. ,
Enum:
{
NoTransit: do not have transit ,
CombinedTransit: transit provider and have own subscribers ,
TransitOnly: pure transit provider or network service provider ,
}
,
Required: False ,
}
enum ,
customerAsn:
{
Description: Customer resource Asn (autonomous system number). ,
Required: False ,
}
string ,
customerAsnEstimatedEgressPeekGbps:
{
Description: Customer resource estimated Asn peering peak in Gbps. ,
Format: float ,
Required: False ,
}
number ,
customerEntitlementSkuId:
{
Description: Customer resource entitlement Sku Id. ,
Required: False ,
}
string ,
customerEntitlementSkuGuid:
{
Description: Customer resource entitlement Sku Guid. ,
Required: False ,
}
string ,
customerEntitlementSkuName:
{
Description: Customer resource entitlement Sku name. ,
Required: False ,
}
string ,
customerEntitlementExpiration:
{
Description: Customer resource entitlement expiration date string. ,
Format: date-time ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object. ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object. ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCustomers_Delete (new)
Description :  This api deletes an existing ispCustomer resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_ListByIspCustomerResource (new)
Description :  This api retrieves information about all ispCacheNode resources under the given subscription and resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IspCacheNodeResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_Get (new)
Description :  This api gets ispCacheNode resource information
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_CreateOrUpdate (new)
Description :  This api creates an ispCacheNode with the specified create parameters
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents the high level Nodes needed to provision cache node resources ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_Update (new)
Description :  This api updates an existing ispCacheNode resource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Unknown: unknown state of the provisioning state ,
Accepted: Accepted state of the provisioning state during the Async Operations ,
Upgrading: Upgrading state of the provisioning state ,
Deleting: Deleting state of the provisioning state ,
}
,
Required: False ,
}
enum ,
cacheNode:
{
Description: Mcc cache node resource (cache node entity). ,
Required: False ,
}
{
fullyQualifiedResourceId:
{
Description: Cache node resource Azure fully qualified resource Id. ,
Required: False ,
}
string ,
customerId:
{
Description: Cache node resource customer resource GUID Id. ,
Required: False ,
}
string ,
customerName:
{
Description: Cache node resource customer resource name. ,
Required: False ,
}
string ,
ipAddress:
{
Description: Cache node resource Ip address. ,
Required: False ,
}
string ,
customerIndex:
{
Description: Cache node resource customer index as string. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Cache node resource identifier of the cache node ,
Required: False ,
}
string ,
cacheNodeName:
{
Description: Cache node resource name. ,
Required: False ,
}
string ,
customerAsn:
{
Description: Cache node resource customer resource Asn (autonomous system number) ,
Format: int32 ,
Required: False ,
}
integer ,
isEnabled:
{
Description: Cache node resource flag for indicating if cache node is enabled. ,
Required: False ,
}
boolean ,
maxAllowableEgressInMbps:
{
Description: Cache node resource maximum allowed egress in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
maxAllowableProbability:
{
Description: Cache node resource maximum allowed probability of egress. ,
Format: float ,
Required: False ,
}
number ,
xCid:
{
Description: Cache node resource Azure XCid. ,
Required: False ,
}
string ,
isEnterpriseManaged:
{
Description: Cache node resource flag for determining if managed by enterprise as boolean. ,
Required: False ,
}
boolean ,
createAsyncOperationId:
{
Description: Cache node resource create async operation Id. ,
Required: False ,
}
string ,
deleteAsyncOperationId:
{
Description: Cache node resource deletion async operation Id. ,
Required: False ,
}
string ,
clientTenantId:
{
Description: Cache node resource customer resource client tenant Id of subscription. ,
Required: False ,
}
string ,
category:
{
Description: Cache node resource category. ,
Required: False ,
}
string ,
releaseVersion:
{
Description: Cache node resource release version. ,
Format: int32 ,
Required: False ,
}
integer ,
lastSyncWithAzureTimestamp:
{
Description: Cache node resource last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Cache node resource last backend updated timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
synchWithAzureAttemptsCount:
{
Description: Cache node resource attempts to sync with Azure. ,
Format: int32 ,
Required: False ,
}
integer ,
containerConfigurations:
{
Description: Cache node resource container configuration details. ,
Required: False ,
}
string ,
cidrCsv:
{
Description: Cache node resource comma separated values of Cidrs. ,
Required: False ,
}
[
string ,
]
,
cidrCsvLastUpdateTime:
{
Description: Cache node resource last Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpCidrCsvLastUpdateTime:
{
Description: Cache node resource last Bgp Cidr Csv update timestamp ,
Format: date-time ,
Required: False ,
}
string ,
bgpLastReportedTime:
{
Description: Cache node resource last Bgp report timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
bgpReviewStateText:
{
Description: Cache node resource Bgp review state string text in detail. ,
Required: False ,
}
string ,
bgpReviewState:
{
Description: Cache node resource Bgp review state string text. ,
Enum:
{
NotConfigured: bgp not configured ,
InReview: bgp is in review state ,
Approved: bgp is in Approved state ,
AttentionRequired: bgp is setup need an attention for more troubleshoot ,
}
,
Required: False ,
}
enum ,
bgpReviewFeedback:
{
Description: Cache node resource Bgp review feedback text. ,
Required: False ,
}
string ,
bgpNumberOfTimesUpdated:
{
Description: Cache node resource Bgp update count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpNumberOfRecords:
{
Description: Cache node resource Bgp record count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpCidrBlocksCount:
{
Description: Cache node resource Bgp block count. ,
Format: int32 ,
Required: False ,
}
integer ,
bgpAddressSpace:
{
Description: Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. ,
Format: int32 ,
Required: False ,
}
integer ,
shouldMigrate:
{
Description: Cache node resource flag for determining if customer will be migrated. ,
Required: False ,
}
boolean ,
bgpFileBytesTruncated:
{
Description: Cache node resource bytes truncated from Bgp output file. ,
Format: int32 ,
Required: False ,
}
integer ,
cidrSelectionType:
{
Description: Cache node resource current Cidr range precedence selection type. ,
Format: int32 ,
Required: False ,
}
integer ,
isFrozen:
{
Description: Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). ,
Required: False ,
}
boolean ,
reviewState:
{
Description: Cache node resource review process state as integer ,
Format: int32 ,
Required: False ,
}
integer ,
reviewStateText:
{
Description: Cache node resource review state text. ,
Required: False ,
}
string ,
reviewFeedback:
{
Description: Cache node resource review feedback text. ,
Required: False ,
}
string ,
configurationState:
{
Description: Cache node resource configuration state. ,
Enum:
{
Configured: connected cache setup configured ,
NotConfigured_Ip: connected cache setup not configured ,
}
,
Required: False ,
}
enum ,
configurationStateText:
{
Description: Cache node resource configuration state text. ,
Required: False ,
}
string ,
addressSpace:
{
Description: Cache node resource total addressable space defined by the Cidr Csv block. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnections:
{
Description: Cache node resource Mcc container deployment worker connection count. ,
Format: int32 ,
Required: False ,
}
integer ,
workerConnectionsLastUpdatedDateTime:
{
Description: Cache node resource last updated Mcc container deployment worker connection count timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
containerResyncTrigger:
{
Description: Cache node resource Mcc container configuration details re-sync trigger. ,
Format: int32 ,
Required: False ,
}
integer ,
imageUri:
{
Description: Cache node resource Mcc Container Id Uri. ,
Required: False ,
}
string ,
fullyQualifiedDomainName:
{
Description: FQDN(fully qualified domain name) value of the mcc cache node ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto Update Ring Type which is slow or fast etc. ,
Enum:
{
Preview: customer selection of preview update install mcc on their physical vm ,
Slow: customer selection of slow update to install mcc on their physical vm ,
Fast: customer selection of fast / auto update to install mcc on their physical vm ,
}
,
Required: False ,
}
enum ,
autoUpdateRequestedWeek:
{
Description: Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedDay:
{
Description: Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateRequestedTime:
{
Description: Customer requested time of the day for mcc install of auto update cycle, should be hh:mm ,
Required: False ,
}
string ,
}
,
additionalCacheNodeProperties:
{
Description: Mcc cache node resource additional properties. ,
Required: False ,
}
{
cacheNodePropertiesDetailsIssuesList:
{
Description: issues list to return the issues as part of the additional cache node properties ,
Required: False ,
}
[
string ,
]
,
issuesList:
{
Description: current cache node issue list. ,
Required: False ,
}
[
string ,
]
,
issuesCount:
{
Description: Number of cache node issues. ,
Format: int32 ,
Required: False ,
}
integer ,
currentTlsCertificate:
{
Description: cache node current tls certificate. ,
Required: False ,
}
{
actionRequired:
{
Description: Mcc cache node Tls certificate status. ,
Required: False ,
}
string ,
certificateFileName:
{
Description: Mcc cache node Tls certificate file name. ,
Required: False ,
}
string ,
thumbprint:
{
Description: Mcc cache node Tls certificate thumbprint. ,
Required: False ,
}
string ,
expiryDate:
{
Description: Mcc cache node Tls certificate expiry date. ,
Format: date-time ,
Required: False ,
}
string ,
notBeforeDate:
{
Description: Mcc cache node Tls certificate not before date. ,
Format: date-time ,
Required: False ,
}
string ,
subject:
{
Description: Mcc cache node Tls certificate subject name. ,
Required: False ,
}
string ,
subjectAltName:
{
Description: Mcc cache node Tls certificate subject alternate name. ,
Required: False ,
}
string ,
}
,
lastAutoUpdateInfo:
{
Description: cache node last auto update information. ,
Required: False ,
}
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
aggregatedStatusDetails:
{
Description: Cache node resource aggregated status details. ,
Required: False ,
}
string ,
aggregatedStatusText:
{
Description: Cache node resource aggregated status text. ,
Required: False ,
}
string ,
aggregatedStatusCode:
{
Description: Cache node resource aggregated status code. ,
Format: int32 ,
Required: False ,
}
integer ,
productVersion:
{
Description: Cache node resource Mcc product version. ,
Required: False ,
}
string ,
isProvisioned:
{
Description: Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. ,
Required: False ,
}
boolean ,
cacheNodeStateDetailedText:
{
Description: Cache node resource detailed state text. ,
Required: False ,
}
string ,
cacheNodeStateShortText:
{
Description: Cache node resource short state text. ,
Required: False ,
}
string ,
cacheNodeState:
{
Description: Cache node resource state as integer. ,
Format: int32 ,
Required: False ,
}
integer ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
bgpConfiguration:
{
Description: Cache node resource Bgp configuration. ,
Required: False ,
}
{
asnToIpAddressMapping:
{
Description: Asn to ip address mapping ,
Required: False ,
}
string ,
}
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
isProxyRequired:
{
Description: Cache node resource requires a proxy ,
Enum:
{
None: Proxy is not required in setup ,
Required: proxy is required in setup ,
}
,
Required: False ,
}
enum ,
osType:
{
Description: Operating system of the cache node ,
Enum:
{
Windows: cache node installs on windows operating system ,
Linux: cache node installs on Linux Operating system ,
Eflow: cache node installs on Azure Eflow ,
}
,
Required: False ,
}
enum ,
autoUpdateVersion:
{
Description: Auto update or fast update version ,
Required: False ,
}
string ,
updateInfoDetails:
{
Description: Update related information details ,
Required: False ,
}
string ,
updateRequestedDateTime:
{
Description: customer requested date time for mcc install of update cycle ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateNextAvailableVersion:
{
Description: Auto update version that is the Next available version to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateNextAvailableDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateAppliedVersion:
{
Description: Auto update version that is the applied to update on mcc cache node ,
Required: False ,
}
string ,
autoUpdateLastAppliedDetails:
{
Description: Auto Update status details from the backend after applying the new version details ,
Required: False ,
}
string ,
autoUpdateLastAppliedState:
{
Description: Last applied auto update state for mcc install of auto update cycle ,
Required: False ,
}
string ,
autoUpdateLastAppliedDateTime:
{
Description: Auto update last applied date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
autoUpdateLastTriggeredDateTime:
{
Description: Auto update last triggered date time of mcc install ,
Format: date-time ,
Required: False ,
}
string ,
creationMethod:
{
Description: Resource creation method of mcc cache node resource, cli or portal ,
Format: int32 ,
Required: False ,
}
integer ,
tlsStatus:
{
Description: Cache node tls certificate status. ,
Required: False ,
}
string ,
optionalProperty1:
{
Description: Optional property #1 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty2:
{
Description: Optional property #2 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty3:
{
Description: Optional property #3 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty4:
{
Description: Optional property #4 of Mcc response object ,
Required: False ,
}
string ,
optionalProperty5:
{
Description: Optional property #5 of Mcc response object ,
Required: False ,
}
string ,
}
,
statusCode:
{
Description: Mcc response status code. ,
Required: False ,
}
string ,
statusText:
{
Description: Mcc response status text as string for retrieving status details. ,
Required: False ,
}
string ,
statusDetails:
{
Description: Mcc response status details for retrieving response inner details. ,
Required: False ,
}
string ,
status:
{
Description: HTTP error status code. ,
Required: False ,
}
string ,
error:
{
Description: Mcc response error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_Delete (new)
Description :  This api deletes an existing ispCacheNode resource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_GetBgpCidrs (new)
Description :  This api gets ispCacheNode resource information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}/getBgpCidrs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mcc cache node resource Bgp Cidr properties. ,
Required: False ,
}
{
bgpCidrs:
{
Description: Mcc cache node Bgp Cidr details. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_GetCacheNodeAutoUpdateHistory (new)
Description :  This api gets ispCacheNode resource auto update histrory information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}/getCacheNodeAutoUpdateHistory
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mcc cache node resource auto update history properties. ,
Required: False ,
}
{
customerId:
{
Description: Mcc customer resource Id. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Mcc cache node resource Id. ,
Required: False ,
}
string ,
autoUpdateHistory:
{
Description: Cache node resource auto update history information. ,
Required: False ,
}
[
{
imageUriBeforeUpdate:
{
Description: Auto update image uri before update. ,
Required: False ,
}
string ,
imageUriTargeted:
{
Description: Auto update image uri targetted to update. ,
Required: False ,
}
string ,
imageUriTerminal:
{
Description: Auto update image uri at Terminal. ,
Required: False ,
}
string ,
autoUpdateRingType:
{
Description: Auto update Ring Type. ,
Format: int32 ,
Required: False ,
}
integer ,
movedToTerminalStateDateTime:
{
Description: Auto update image uri after update. ,
Format: date-time ,
Required: False ,
}
string ,
ruleRequestedWeek:
{
Description: Auto update image uri before update. ,
Format: int32 ,
Required: False ,
}
integer ,
ruleRequestedDay:
{
Description: Auto update image uri after update. ,
Format: int32 ,
Required: False ,
}
integer ,
createdDateTimeUtc:
{
Description: Auto update entity created datetime. ,
Format: date-time ,
Required: False ,
}
string ,
updatedRegistryDateTimeUtc:
{
Description: Auto update entity last updated datetime. ,
Format: date-time ,
Required: False ,
}
string ,
planChangeLogText:
{
Description: This text describing the purpose of the plan of auto update. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatus:
{
Description: Auto update last applied status. ,
Format: int32 ,
Required: False ,
}
integer ,
autoUpdateLastAppliedStatusText:
{
Description: Auto update last applied status text. ,
Required: False ,
}
string ,
autoUpdateLastAppliedStatusDetailedText:
{
Description: Auto update last applied detailed status text. ,
Required: False ,
}
string ,
planId:
{
Description: Auto update planId. ,
Format: int64 ,
Required: False ,
}
integer ,
timeToGoLiveDateTime:
{
Description: Auto update time to go live date time. ,
Required: False ,
}
string ,
ruleRequestedMinute:
{
Description: Auto update rule requested minute. ,
Required: False ,
}
string ,
ruleRequestedHour:
{
Description: Auto update rule requested hour. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_GetCacheNodeInstallDetails (new)
Description :  This api gets secrets of the ispCacheNode resource install details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}/getCacheNodeInstallDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mcc cache node resource install script details. ,
Required: False ,
}
{
customerId:
{
Description: Mcc customer resource Id. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Mcc cache node resource Id. ,
Required: False ,
}
string ,
primaryAccountKey:
{
Description: Mcc primary account key. Internal to Mcc. ,
Format: password ,
Required: False ,
}
string ,
secondaryAccountKey:
{
Description: Mcc secondary account key. Internal to Mcc. ,
Format: password ,
Required: False ,
}
string ,
registrationKey:
{
Description: Mcc Iot Central temporary device registration key, used once. ,
Format: password ,
Required: False ,
}
string ,
tlsCertificateProvisioningKey:
{
Description: Mcc Tls certificate provisioning key. ,
Format: password ,
Required: False ,
}
string ,
driveConfiguration:
{
Description: Cache node resource drive configurations. ,
Required: False ,
}
[
{
physicalPath:
{
Description: physical path location of the folder used for caching content ,
Required: False ,
}
string ,
sizeInGb:
{
Description: physical size of the drive used for caching content ,
Format: int32 ,
Required: False ,
}
integer ,
cacheNumber:
{
Description: corresponding nginx cache number. Valid cache numbers are 1 - 20 ,
Format: int32 ,
Required: False ,
}
integer ,
nginxMapping:
{
Description: full binding for corresponding nginx cache drive ,
Required: False ,
}
string ,
}
,
]
,
proxyUrlConfiguration:
{
Description: proxyUrl configuration of the cache node ,
Required: False ,
}
{
proxyUrl:
{
Description: Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IspCacheNodesOperations_GetCacheNodeMccIssueDetailsHistory (new)
Description :  This api gets ispCacheNode resource issues details histrory information
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedCache/ispCustomers/{customerResourceName}/ispCacheNodes/{cacheNodeResourceName}/getCacheNodeMccIssueDetailsHistory
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
customerResourceName:
{
Description: Name of the Customer resource ,
Required: True ,
}
string ,
cacheNodeResourceName:
{
Description: Name of the ConnectedCache resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Mcc cache node resource issue history properties. ,
Required: False ,
}
{
customerId:
{
Description: Mcc customer resource Id. ,
Required: False ,
}
string ,
cacheNodeId:
{
Description: Mcc cache node resource Id. ,
Required: False ,
}
string ,
mccIssueHistory:
{
Description: Cache node resource issue details history. ,
Required: False ,
}
[
{
mccIssueType:
{
Description: Mcc cache node issue type. ,
Required: False ,
}
string ,
toastString:
{
Description: Mcc cache node issues toastString. ,
Required: False ,
}
string ,
detailString:
{
Description: Mcc cache node issue detail string. ,
Required: False ,
}
string ,
helpLink:
{
Description: Mcc cache node issue related help link. ,
Required: False ,
}
string ,
issueStartDate:
{
Description: Mcc cache node issue start date. ,
Format: date-time ,
Required: False ,
}
string ,
issueEndDate:
{
Description: Mcc cache node issue end date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}