Microsoft.Mission (preview:2025-05-01)

2025/07/24 • 58 new methods

Approval_ListByParent (new)
Description :  List ApprovalResource resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Mission/approvals
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ApprovalResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
parentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
grandparentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
approvers:
{
Description: List of approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: Entra ObjectID of the approver ,
Required: True ,
}
string ,
actionPerformed:
{
Description: Action Performed by approver ,
Enum:
{
Approved: Action was Approved ,
Rejected: Action was Rejected ,
}
,
Required: False ,
}
enum ,
lastUpdatedAt:
{
Description: approval request last updated at ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
ticketId:
{
Description: Ticket ID for the approval request ,
Required: False ,
}
string ,
createdAt:
{
Description: Approval request creation time ,
Format: date-time ,
Required: False ,
}
string ,
stateChangedAt:
{
Description: Approval request state change time, time at which approval request state changed from pending to approved or rejected. ,
Format: date-time ,
Required: False ,
}
string ,
requestMetadata:
{
Description: Request metadata for the approval request. ,
Required: True ,
}
{
resourceAction:
{
Description: Resource Action of the item being approved or declined. ,
Required: True ,
}
string ,
approvalCallbackRoute:
{
Description: Route name for the approval callback ,
Required: False ,
}
string ,
approvalCallbackPayload:
{
Description: Payload to be sent upon any action on approval request ,
Required: False ,
}
string ,
approvalStatus:
{
Description: Status of the approval. Uses ApprovalStatus enum. ,
Enum:
{
Approved: ApprovalStatus Type Approved ,
Rejected: ApprovalStatus Type Rejected ,
Pending: ApprovalStatus Type Pending ,
Deleted: ApprovalStatus Type Deleted ,
Expired: ApprovalStatus Type Expired ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Approval_Get (new)
Description :  Get a ApprovalResource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
approvalName:
{
Description: The name of the approvals resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
parentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
grandparentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
approvers:
{
Description: List of approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: Entra ObjectID of the approver ,
Required: True ,
}
string ,
actionPerformed:
{
Description: Action Performed by approver ,
Enum:
{
Approved: Action was Approved ,
Rejected: Action was Rejected ,
}
,
Required: False ,
}
enum ,
lastUpdatedAt:
{
Description: approval request last updated at ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
ticketId:
{
Description: Ticket ID for the approval request ,
Required: False ,
}
string ,
createdAt:
{
Description: Approval request creation time ,
Format: date-time ,
Required: False ,
}
string ,
stateChangedAt:
{
Description: Approval request state change time, time at which approval request state changed from pending to approved or rejected. ,
Format: date-time ,
Required: False ,
}
string ,
requestMetadata:
{
Description: Request metadata for the approval request. ,
Required: True ,
}
{
resourceAction:
{
Description: Resource Action of the item being approved or declined. ,
Required: True ,
}
string ,
approvalCallbackRoute:
{
Description: Route name for the approval callback ,
Required: False ,
}
string ,
approvalCallbackPayload:
{
Description: Payload to be sent upon any action on approval request ,
Required: False ,
}
string ,
approvalStatus:
{
Description: Status of the approval. Uses ApprovalStatus enum. ,
Enum:
{
Approved: ApprovalStatus Type Approved ,
Rejected: ApprovalStatus Type Rejected ,
Pending: ApprovalStatus Type Pending ,
Deleted: ApprovalStatus Type Deleted ,
Expired: ApprovalStatus Type Expired ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Approval_CreateOrUpdate (new)
Description :  Create a ApprovalResource
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
approvalName:
{
Description: The name of the approvals resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
parentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
grandparentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
approvers:
{
Description: List of approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: Entra ObjectID of the approver ,
Required: True ,
}
string ,
actionPerformed:
{
Description: Action Performed by approver ,
Enum:
{
Approved: Action was Approved ,
Rejected: Action was Rejected ,
}
,
Required: False ,
}
enum ,
lastUpdatedAt:
{
Description: approval request last updated at ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
ticketId:
{
Description: Ticket ID for the approval request ,
Required: False ,
}
string ,
createdAt:
{
Description: Approval request creation time ,
Format: date-time ,
Required: False ,
}
string ,
stateChangedAt:
{
Description: Approval request state change time, time at which approval request state changed from pending to approved or rejected. ,
Format: date-time ,
Required: False ,
}
string ,
requestMetadata:
{
Description: Request metadata for the approval request. ,
Required: True ,
}
{
resourceAction:
{
Description: Resource Action of the item being approved or declined. ,
Required: True ,
}
string ,
approvalCallbackRoute:
{
Description: Route name for the approval callback ,
Required: False ,
}
string ,
approvalCallbackPayload:
{
Description: Payload to be sent upon any action on approval request ,
Required: False ,
}
string ,
approvalStatus:
{
Description: Status of the approval. Uses ApprovalStatus enum. ,
Enum:
{
Approved: ApprovalStatus Type Approved ,
Rejected: ApprovalStatus Type Rejected ,
Pending: ApprovalStatus Type Pending ,
Deleted: ApprovalStatus Type Deleted ,
Expired: ApprovalStatus Type Expired ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
parentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
grandparentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
approvers:
{
Description: List of approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: Entra ObjectID of the approver ,
Required: True ,
}
string ,
actionPerformed:
{
Description: Action Performed by approver ,
Enum:
{
Approved: Action was Approved ,
Rejected: Action was Rejected ,
}
,
Required: False ,
}
enum ,
lastUpdatedAt:
{
Description: approval request last updated at ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
ticketId:
{
Description: Ticket ID for the approval request ,
Required: False ,
}
string ,
createdAt:
{
Description: Approval request creation time ,
Format: date-time ,
Required: False ,
}
string ,
stateChangedAt:
{
Description: Approval request state change time, time at which approval request state changed from pending to approved or rejected. ,
Format: date-time ,
Required: False ,
}
string ,
requestMetadata:
{
Description: Request metadata for the approval request. ,
Required: True ,
}
{
resourceAction:
{
Description: Resource Action of the item being approved or declined. ,
Required: True ,
}
string ,
approvalCallbackRoute:
{
Description: Route name for the approval callback ,
Required: False ,
}
string ,
approvalCallbackPayload:
{
Description: Payload to be sent upon any action on approval request ,
Required: False ,
}
string ,
approvalStatus:
{
Description: Status of the approval. Uses ApprovalStatus enum. ,
Enum:
{
Approved: ApprovalStatus Type Approved ,
Rejected: ApprovalStatus Type Rejected ,
Pending: ApprovalStatus Type Pending ,
Deleted: ApprovalStatus Type Deleted ,
Expired: ApprovalStatus Type Expired ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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: Approval Model Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
parentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
grandparentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
approvers:
{
Description: List of approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: Entra ObjectID of the approver ,
Required: True ,
}
string ,
actionPerformed:
{
Description: Action Performed by approver ,
Enum:
{
Approved: Action was Approved ,
Rejected: Action was Rejected ,
}
,
Required: False ,
}
enum ,
lastUpdatedAt:
{
Description: approval request last updated at ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
ticketId:
{
Description: Ticket ID for the approval request ,
Required: False ,
}
string ,
createdAt:
{
Description: Approval request creation time ,
Format: date-time ,
Required: False ,
}
string ,
stateChangedAt:
{
Description: Approval request state change time, time at which approval request state changed from pending to approved or rejected. ,
Format: date-time ,
Required: False ,
}
string ,
requestMetadata:
{
Description: Request metadata for the approval request. ,
Required: True ,
}
{
resourceAction:
{
Description: Resource Action of the item being approved or declined. ,
Required: True ,
}
string ,
approvalCallbackRoute:
{
Description: Route name for the approval callback ,
Required: False ,
}
string ,
approvalCallbackPayload:
{
Description: Payload to be sent upon any action on approval request ,
Required: False ,
}
string ,
approvalStatus:
{
Description: Status of the approval. Uses ApprovalStatus enum. ,
Enum:
{
Approved: ApprovalStatus Type Approved ,
Rejected: ApprovalStatus Type Rejected ,
Pending: ApprovalStatus Type Pending ,
Deleted: ApprovalStatus Type Deleted ,
Expired: ApprovalStatus Type Expired ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Approval_Update (new)
Description :  Update a ApprovalResource
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
approvalName:
{
Description: The name of the approvals resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Approval Patch properties ,
Required: False ,
}
{
parentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
grandparentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
approvers:
{
Description: List of approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: Entra ObjectID of the approver ,
Required: True ,
}
string ,
actionPerformed:
{
Description: Action Performed by approver ,
Enum:
{
Approved: Action was Approved ,
Rejected: Action was Rejected ,
}
,
Required: False ,
}
enum ,
lastUpdatedAt:
{
Description: approval request last updated at ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
ticketId:
{
Description: Ticket ID for the approval request ,
Required: False ,
}
string ,
createdAt:
{
Description: Approval request creation time ,
Format: date-time ,
Required: False ,
}
string ,
stateChangedAt:
{
Description: Approval request state change time, time at which approval request state changed from pending to approved or rejected. ,
Format: date-time ,
Required: False ,
}
string ,
requestMetadata:
{
Description: Request metadata for the approval request. ,
Required: False ,
}
{
resourceAction:
{
Description: Resource Action of the item being approved or declined. ,
Required: False ,
}
string ,
approvalCallbackRoute:
{
Description: Route name for the approval callback ,
Required: False ,
}
string ,
approvalCallbackPayload:
{
Description: Payload to be sent upon any action on approval request ,
Required: False ,
}
string ,
approvalStatus:
{
Description: Status of the approval. Uses ApprovalStatus enum. ,
Enum:
{
Approved: ApprovalStatus Type Approved ,
Rejected: ApprovalStatus Type Rejected ,
Pending: ApprovalStatus Type Pending ,
Deleted: ApprovalStatus Type Deleted ,
Expired: ApprovalStatus Type Expired ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
parentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
grandparentResourceId:
{
Description: Parameter for optimizing query results ,
Format: arm-id ,
Required: False ,
}
string ,
approvers:
{
Description: List of approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: Entra ObjectID of the approver ,
Required: True ,
}
string ,
actionPerformed:
{
Description: Action Performed by approver ,
Enum:
{
Approved: Action was Approved ,
Rejected: Action was Rejected ,
}
,
Required: False ,
}
enum ,
lastUpdatedAt:
{
Description: approval request last updated at ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
ticketId:
{
Description: Ticket ID for the approval request ,
Required: False ,
}
string ,
createdAt:
{
Description: Approval request creation time ,
Format: date-time ,
Required: False ,
}
string ,
stateChangedAt:
{
Description: Approval request state change time, time at which approval request state changed from pending to approved or rejected. ,
Format: date-time ,
Required: False ,
}
string ,
requestMetadata:
{
Description: Request metadata for the approval request. ,
Required: True ,
}
{
resourceAction:
{
Description: Resource Action of the item being approved or declined. ,
Required: True ,
}
string ,
approvalCallbackRoute:
{
Description: Route name for the approval callback ,
Required: False ,
}
string ,
approvalCallbackPayload:
{
Description: Payload to be sent upon any action on approval request ,
Required: False ,
}
string ,
approvalStatus:
{
Description: Status of the approval. Uses ApprovalStatus enum. ,
Enum:
{
Approved: ApprovalStatus Type Approved ,
Rejected: ApprovalStatus Type Rejected ,
Pending: ApprovalStatus Type Pending ,
Deleted: ApprovalStatus Type Deleted ,
Expired: ApprovalStatus Type Expired ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 (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 ,
}
,
]
,
}
,
}
Approval_Delete (new)
Description :  Delete a ApprovalResource
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
approvalName:
{
Description: The name of the approvals 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 ,
}
,
]
,
}
,
}
Approval_NotifyInitiator (new)
Description :  Upon receiving approval or rejection from approver, this facilitates actions on approval resource
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.Mission/approvals/{approvalName}/notifyInitiator
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
approvalName:
{
Description: The name of the approvals resource. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
approvalStatus:
{
Description: Approval status indicating 'Approved' or 'Rejected' ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Mission/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 ,
}
,
]
,
}
,
}
Community_ListBySubscription (new)
Description :  List CommunityResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities
{
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 CommunityResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addressSpace:
{
Description: Address Space. ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids created by communities. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
governedServiceList:
{
Description: List of services governed by a community. ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyOverride:
{
Description: Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement. ,
Enum:
{
Enclave: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
communityRoleAssignments:
{
Description: Community role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
firewallSku:
{
Description: SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default ,
Enum:
{
Basic: FirewallSKU Basic ,
Standard: FirwallSKU Standard ,
Premium: FirewallSKU Premium ,
}
,
Required: False ,
}
enum ,
approvalSettings:
{
Description: Approval requirements for various actions on the community's resources. ,
Required: False ,
}
{
endpointCreation:
{
Description: Approval required for endpoint creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointUpdate:
{
Description: Approval required for endpoint update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointDeletion:
{
Description: Approval required for endpoint deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionCreation:
{
Description: Approval required for enclave connection creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionUpdate:
{
Description: Approval required for enclave connection update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionDeletion:
{
Description: Approval required for enclave connection deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveCreation:
{
Description: Approval required for virtual enclave creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveDeletion:
{
Description: Approval required for virtual enclave deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
maintenanceMode:
{
Description: Approval required for toggling maintenance mode (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
serviceCatalogDeployment:
{
Description: Approval required for deploying service catalog templates (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalCreation:
{
Description: Notification will be sent on creation of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalAction:
{
Description: Notification will be sent on any action taken (Approve/Reject) on an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalDeletion:
{
Description: Notification will be sent on deletion of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
mandatoryApprovers:
{
Description: List of mandatory approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: EntraId of the approver ,
Required: True ,
}
string ,
}
,
]
,
minimumApproversRequired:
{
Description: Minimum number of approvers required for the approval request ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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 ,
}
,
]
,
}
,
}
CommunityEndpoints_ListBySubscription (new)
Description :  List CommunityEndpointResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CommunityEndpointResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Community Endpoint Rule Collection. ,
Required: True ,
}
[
{
destinationType:
{
Description: Destination Type. ,
Enum:
{
FQDN: DestinationType Type FQDN ,
FQDNTag: DestinationType Type FQDNTag ,
IPAddress: DestinationType Type IPAddress ,
PrivateNetwork: DestinationType Type PrivateNetwork ,
}
,
Required: False ,
}
enum ,
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
transitHubResourceId:
{
Description: Transit Hub Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
TransitHub_ListBySubscription (new)
Description :  List TransitHubResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Mission/communities/{communityName}/transitHubs
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TransitHubResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the transitHub. ,
Enum:
{
PendingApproval: TransitHubState Type PendingApproval ,
Approved: TransitHubState Type Approved ,
PendingUpdate: TransitHubState Type PendingUpdate ,
Active: TransitHubState Type Active ,
Failed: TransitHubState Type Failed ,
}
,
Required: False ,
}
enum ,
transitOption:
{
Description: The TransitOption of the transitHub. ,
Required: False ,
}
{
type:
{
Description: Transit Option Type. ,
Enum:
{
ExpressRoute: TransitOptionType ExpressRoute ,
Gateway: TransitOptionType Gateway ,
Peering: TransitOptionType Peering ,
}
,
Required: False ,
}
enum ,
params:
{
Description: Transit Option Params ,
Required: False ,
}
{
scaleUnits:
{
Description: Transit Option Params scaleUnits. ,
Format: int64 ,
Required: False ,
}
integer ,
remoteVirtualNetworkId:
{
Description: Transit Option Params remoteVirtualNetworkId. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
resourceCollection:
{
Description: List of resource ids modified by transitHubs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
EnclaveConnection_ListBySubscription (new)
Description :  List EnclaveConnectionResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Mission/enclaveConnections
{
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 EnclaveConnectionResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
state:
{
Description: The state of the enclaveConnection. ,
Enum:
{
PendingApproval: EnclaveConnectionState Type Pending Approval ,
PendingUpdate: EnclaveConnectionState Type Pending Update ,
Approved: EnclaveConnectionState Type Approved ,
Active: EnclaveConnectionState Type Active ,
Failed: EnclaveConnectionState Type Failed ,
Connected: EnclaveConnectionState Type Connected ,
Disconnected: EnclaveConnectionState Type Disconnected ,
}
,
Required: False ,
}
enum ,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Source Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceCidr:
{
Description: Source CIDR. ,
Required: False ,
}
string ,
destinationEndpointId:
{
Description: Destination Endpoint Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids modified by enclave Connections. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
VirtualEnclave_ListBySubscription (new)
Description :  List EnclaveResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves
{
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 EnclaveResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
enclaveVirtualNetwork:
{
Description: Virtual Network. ,
Required: True ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
enclaveAddressSpaces:
{
Description: Enclave Address Spaces ,
Required: False ,
}
{
enclaveAddressSpace:
{
Description: Enclave Address Space ,
Required: False ,
}
string ,
managedAddressSpace:
{
Description: Managed Address Space ,
Required: False ,
}
string ,
}
,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
resourceCollection:
{
Description: List of resource ids created by Virtual Enclave. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
bastionEnabled:
{
Description: Deploy Bastion service (True or False). ,
Required: False ,
}
boolean ,
enclaveRoleAssignments:
{
Description: Enclave role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
workloadRoleAssignments:
{
Description: Workload role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
governedServiceList:
{
Description: Enclave specific policies ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
enclaveDefaultSettings:
{
Description: Enclave default settings. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Key Vault Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage Account Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsResourceIdCollection:
{
Description: Log Analytics Resource Ids. ,
Required: False ,
}
[
string ,
]
,
diagnosticDestination:
{
Description: Diagnostic Destination. ,
Enum:
{
CommunityOnly: DiagnosticDestination Type CommunityOnly ,
EnclaveOnly: DiagnosticDestination Type EnclaveOnly ,
Both: DiagnosticDestination Type Both ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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 ,
}
,
]
,
}
,
}
EnclaveEndpoints_ListBySubscription (new)
Description :  List EnclaveEndpointResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnclaveEndpointResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Enclave Endpoint Rule Collection. ,
Required: True ,
}
[
{
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Workload_ListBySubscription (new)
Description :  List WorkloadResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceGroupCollection:
{
Description: List of resource group ids. ,
Required: False ,
}
[
string ,
]
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Community_ListByResourceGroup (new)
Description :  List CommunityResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities
{
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 CommunityResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addressSpace:
{
Description: Address Space. ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids created by communities. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
governedServiceList:
{
Description: List of services governed by a community. ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyOverride:
{
Description: Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement. ,
Enum:
{
Enclave: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
communityRoleAssignments:
{
Description: Community role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
firewallSku:
{
Description: SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default ,
Enum:
{
Basic: FirewallSKU Basic ,
Standard: FirwallSKU Standard ,
Premium: FirewallSKU Premium ,
}
,
Required: False ,
}
enum ,
approvalSettings:
{
Description: Approval requirements for various actions on the community's resources. ,
Required: False ,
}
{
endpointCreation:
{
Description: Approval required for endpoint creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointUpdate:
{
Description: Approval required for endpoint update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointDeletion:
{
Description: Approval required for endpoint deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionCreation:
{
Description: Approval required for enclave connection creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionUpdate:
{
Description: Approval required for enclave connection update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionDeletion:
{
Description: Approval required for enclave connection deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveCreation:
{
Description: Approval required for virtual enclave creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveDeletion:
{
Description: Approval required for virtual enclave deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
maintenanceMode:
{
Description: Approval required for toggling maintenance mode (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
serviceCatalogDeployment:
{
Description: Approval required for deploying service catalog templates (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalCreation:
{
Description: Notification will be sent on creation of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalAction:
{
Description: Notification will be sent on any action taken (Approve/Reject) on an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalDeletion:
{
Description: Notification will be sent on deletion of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
mandatoryApprovers:
{
Description: List of mandatory approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: EntraId of the approver ,
Required: True ,
}
string ,
}
,
]
,
minimumApproversRequired:
{
Description: Minimum number of approvers required for the approval request ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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 ,
}
,
]
,
}
,
}
Community_Get (new)
Description :  Get a CommunityResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addressSpace:
{
Description: Address Space. ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids created by communities. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
governedServiceList:
{
Description: List of services governed by a community. ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyOverride:
{
Description: Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement. ,
Enum:
{
Enclave: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
communityRoleAssignments:
{
Description: Community role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
firewallSku:
{
Description: SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default ,
Enum:
{
Basic: FirewallSKU Basic ,
Standard: FirwallSKU Standard ,
Premium: FirewallSKU Premium ,
}
,
Required: False ,
}
enum ,
approvalSettings:
{
Description: Approval requirements for various actions on the community's resources. ,
Required: False ,
}
{
endpointCreation:
{
Description: Approval required for endpoint creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointUpdate:
{
Description: Approval required for endpoint update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointDeletion:
{
Description: Approval required for endpoint deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionCreation:
{
Description: Approval required for enclave connection creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionUpdate:
{
Description: Approval required for enclave connection update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionDeletion:
{
Description: Approval required for enclave connection deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveCreation:
{
Description: Approval required for virtual enclave creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveDeletion:
{
Description: Approval required for virtual enclave deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
maintenanceMode:
{
Description: Approval required for toggling maintenance mode (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
serviceCatalogDeployment:
{
Description: Approval required for deploying service catalog templates (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalCreation:
{
Description: Notification will be sent on creation of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalAction:
{
Description: Notification will be sent on any action taken (Approve/Reject) on an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalDeletion:
{
Description: Notification will be sent on deletion of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
mandatoryApprovers:
{
Description: List of mandatory approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: EntraId of the approver ,
Required: True ,
}
string ,
}
,
]
,
minimumApproversRequired:
{
Description: Minimum number of approvers required for the approval request ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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 ,
}
,
]
,
}
,
}
Community_CreateOrUpdate (new)
Description :  Create a CommunityResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addressSpace:
{
Description: Address Space. ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids created by communities. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
governedServiceList:
{
Description: List of services governed by a community. ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyOverride:
{
Description: Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement. ,
Enum:
{
Enclave: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
communityRoleAssignments:
{
Description: Community role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
firewallSku:
{
Description: SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default ,
Enum:
{
Basic: FirewallSKU Basic ,
Standard: FirwallSKU Standard ,
Premium: FirewallSKU Premium ,
}
,
Required: False ,
}
enum ,
approvalSettings:
{
Description: Approval requirements for various actions on the community's resources. ,
Required: False ,
}
{
endpointCreation:
{
Description: Approval required for endpoint creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointUpdate:
{
Description: Approval required for endpoint update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointDeletion:
{
Description: Approval required for endpoint deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionCreation:
{
Description: Approval required for enclave connection creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionUpdate:
{
Description: Approval required for enclave connection update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionDeletion:
{
Description: Approval required for enclave connection deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveCreation:
{
Description: Approval required for virtual enclave creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveDeletion:
{
Description: Approval required for virtual enclave deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
maintenanceMode:
{
Description: Approval required for toggling maintenance mode (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
serviceCatalogDeployment:
{
Description: Approval required for deploying service catalog templates (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalCreation:
{
Description: Notification will be sent on creation of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalAction:
{
Description: Notification will be sent on any action taken (Approve/Reject) on an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalDeletion:
{
Description: Notification will be sent on deletion of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
mandatoryApprovers:
{
Description: List of mandatory approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: EntraId of the approver ,
Required: True ,
}
string ,
}
,
]
,
minimumApproversRequired:
{
Description: Minimum number of approvers required for the approval request ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addressSpace:
{
Description: Address Space. ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids created by communities. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
governedServiceList:
{
Description: List of services governed by a community. ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyOverride:
{
Description: Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement. ,
Enum:
{
Enclave: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
communityRoleAssignments:
{
Description: Community role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
firewallSku:
{
Description: SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default ,
Enum:
{
Basic: FirewallSKU Basic ,
Standard: FirwallSKU Standard ,
Premium: FirewallSKU Premium ,
}
,
Required: False ,
}
enum ,
approvalSettings:
{
Description: Approval requirements for various actions on the community's resources. ,
Required: False ,
}
{
endpointCreation:
{
Description: Approval required for endpoint creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointUpdate:
{
Description: Approval required for endpoint update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointDeletion:
{
Description: Approval required for endpoint deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionCreation:
{
Description: Approval required for enclave connection creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionUpdate:
{
Description: Approval required for enclave connection update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionDeletion:
{
Description: Approval required for enclave connection deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveCreation:
{
Description: Approval required for virtual enclave creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveDeletion:
{
Description: Approval required for virtual enclave deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
maintenanceMode:
{
Description: Approval required for toggling maintenance mode (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
serviceCatalogDeployment:
{
Description: Approval required for deploying service catalog templates (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalCreation:
{
Description: Notification will be sent on creation of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalAction:
{
Description: Notification will be sent on any action taken (Approve/Reject) on an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalDeletion:
{
Description: Notification will be sent on deletion of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
mandatoryApprovers:
{
Description: List of mandatory approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: EntraId of the approver ,
Required: True ,
}
string ,
}
,
]
,
minimumApproversRequired:
{
Description: Minimum number of approvers required for the approval request ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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: Community Model Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addressSpace:
{
Description: Address Space. ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids created by communities. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
governedServiceList:
{
Description: List of services governed by a community. ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyOverride:
{
Description: Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement. ,
Enum:
{
Enclave: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
communityRoleAssignments:
{
Description: Community role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
firewallSku:
{
Description: SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default ,
Enum:
{
Basic: FirewallSKU Basic ,
Standard: FirwallSKU Standard ,
Premium: FirewallSKU Premium ,
}
,
Required: False ,
}
enum ,
approvalSettings:
{
Description: Approval requirements for various actions on the community's resources. ,
Required: False ,
}
{
endpointCreation:
{
Description: Approval required for endpoint creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointUpdate:
{
Description: Approval required for endpoint update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointDeletion:
{
Description: Approval required for endpoint deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionCreation:
{
Description: Approval required for enclave connection creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionUpdate:
{
Description: Approval required for enclave connection update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionDeletion:
{
Description: Approval required for enclave connection deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveCreation:
{
Description: Approval required for virtual enclave creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveDeletion:
{
Description: Approval required for virtual enclave deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
maintenanceMode:
{
Description: Approval required for toggling maintenance mode (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
serviceCatalogDeployment:
{
Description: Approval required for deploying service catalog templates (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalCreation:
{
Description: Notification will be sent on creation of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalAction:
{
Description: Notification will be sent on any action taken (Approve/Reject) on an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalDeletion:
{
Description: Notification will be sent on deletion of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
mandatoryApprovers:
{
Description: List of mandatory approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: EntraId of the approver ,
Required: True ,
}
string ,
}
,
]
,
minimumApproversRequired:
{
Description: Minimum number of approvers required for the approval request ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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 ,
}
,
]
,
}
,
}
Community_Update (new)
Description :  Update a CommunityResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Community Patch properties ,
Required: False ,
}
{
dnsServers:
{
Description: DNS Servers. ,
Required: False ,
}
[
string ,
]
,
governedServiceList:
{
Description: List of services governed by a community. ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyOverride:
{
Description: Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement. ,
Enum:
{
Enclave: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
communityRoleAssignments:
{
Description: Community role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
firewallSku:
{
Description: SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default ,
Enum:
{
Basic: FirewallSKU Basic ,
Standard: FirwallSKU Standard ,
Premium: FirewallSKU Premium ,
}
,
Required: False ,
}
enum ,
approvalSettings:
{
Description: Approval requirements for various actions on the community's resources. ,
Required: False ,
}
{
mandatoryApprovers:
{
Description: List of mandatory approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: EntraId of the approver ,
Required: True ,
}
string ,
}
,
]
,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: False ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addressSpace:
{
Description: Address Space. ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids created by communities. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
governedServiceList:
{
Description: List of services governed by a community. ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
policyOverride:
{
Description: Policy override setting for the community. Specifies whether to apply enclave-specific policies or disable policy enforcement. ,
Enum:
{
Enclave: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
communityRoleAssignments:
{
Description: Community role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
firewallSku:
{
Description: SKU of the community's Azure Firewall (Basic, Standard, Premium). Standard is the default ,
Enum:
{
Basic: FirewallSKU Basic ,
Standard: FirwallSKU Standard ,
Premium: FirewallSKU Premium ,
}
,
Required: False ,
}
enum ,
approvalSettings:
{
Description: Approval requirements for various actions on the community's resources. ,
Required: False ,
}
{
endpointCreation:
{
Description: Approval required for endpoint creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointUpdate:
{
Description: Approval required for endpoint update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
endpointDeletion:
{
Description: Approval required for endpoint deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionCreation:
{
Description: Approval required for enclave connection creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionUpdate:
{
Description: Approval required for enclave connection update (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
connectionDeletion:
{
Description: Approval required for enclave connection deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveCreation:
{
Description: Approval required for virtual enclave creation (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
enclaveDeletion:
{
Description: Approval required for virtual enclave deletion (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
maintenanceMode:
{
Description: Approval required for toggling maintenance mode (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
serviceCatalogDeployment:
{
Description: Approval required for deploying service catalog templates (Required or NotRequired). ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalCreation:
{
Description: Notification will be sent on creation of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalAction:
{
Description: Notification will be sent on any action taken (Approve/Reject) on an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
notificationOnApprovalDeletion:
{
Description: Notification will be sent on deletion of an Approval Request ,
Enum:
{
Required: Approval will be required for the specified action. ,
NotRequired: Approval will not be required for the specified action. ,
}
,
Required: False ,
}
enum ,
mandatoryApprovers:
{
Description: List of mandatory approvers for the approval request ,
Required: False ,
}
[
{
approverEntraId:
{
Description: EntraId of the approver ,
Required: True ,
}
string ,
}
,
]
,
minimumApproversRequired:
{
Description: Minimum number of approvers required for the approval request ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 (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 ,
}
,
]
,
}
,
}
Community_Delete (new)
Description :  Delete a CommunityResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}
{
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 ,
communityName:
{
Description: The name of the communityResource 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 ,
}
,
]
,
}
,
}
Community_CheckAddressSpaceAvailability (new)
Description :  Checks that the IP Address Space to be allocated for this Community is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/checkAddressSpaceAvailability
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
checkAddressSpaceAvailabilityRequest:
{
Description: Check IP Address Space request body. ,
Required: True ,
}
{
communityResourceId:
{
Description: Resource Id of the Community ,
Format: arm-id ,
Required: True ,
}
string ,
enclaveVirtualNetwork:
{
Description: Information about the enclave virtual network ,
Required: True ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Description: Boolean representing whether the address space is available. ,
Required: True ,
}
boolean ,
}

⚐ 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 ,
}
,
]
,
}
,
}
CommunityEndpoints_ListByCommunityResource (new)
Description :  List CommunityEndpointResource resources by CommunityResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CommunityEndpointResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Community Endpoint Rule Collection. ,
Required: True ,
}
[
{
destinationType:
{
Description: Destination Type. ,
Enum:
{
FQDN: DestinationType Type FQDN ,
FQDNTag: DestinationType Type FQDNTag ,
IPAddress: DestinationType Type IPAddress ,
PrivateNetwork: DestinationType Type PrivateNetwork ,
}
,
Required: False ,
}
enum ,
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
transitHubResourceId:
{
Description: Transit Hub Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
CommunityEndpoints_Get (new)
Description :  Get a CommunityEndpointResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
communityEndpointName:
{
Description: The name of the Community Endpoint Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Community Endpoint Rule Collection. ,
Required: True ,
}
[
{
destinationType:
{
Description: Destination Type. ,
Enum:
{
FQDN: DestinationType Type FQDN ,
FQDNTag: DestinationType Type FQDNTag ,
IPAddress: DestinationType Type IPAddress ,
PrivateNetwork: DestinationType Type PrivateNetwork ,
}
,
Required: False ,
}
enum ,
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
transitHubResourceId:
{
Description: Transit Hub Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CommunityEndpoints_CreateOrUpdate (new)
Description :  Create a CommunityEndpointResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
communityEndpointName:
{
Description: The name of the Community Endpoint Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Community Endpoint Rule Collection. ,
Required: True ,
}
[
{
destinationType:
{
Description: Destination Type. ,
Enum:
{
FQDN: DestinationType Type FQDN ,
FQDNTag: DestinationType Type FQDNTag ,
IPAddress: DestinationType Type IPAddress ,
PrivateNetwork: DestinationType Type PrivateNetwork ,
}
,
Required: False ,
}
enum ,
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
transitHubResourceId:
{
Description: Transit Hub Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Community Endpoint Rule Collection. ,
Required: True ,
}
[
{
destinationType:
{
Description: Destination Type. ,
Enum:
{
FQDN: DestinationType Type FQDN ,
FQDNTag: DestinationType Type FQDNTag ,
IPAddress: DestinationType Type IPAddress ,
PrivateNetwork: DestinationType Type PrivateNetwork ,
}
,
Required: False ,
}
enum ,
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
transitHubResourceId:
{
Description: Transit Hub Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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: CommunityEndpoint Model Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Community Endpoint Rule Collection. ,
Required: True ,
}
[
{
destinationType:
{
Description: Destination Type. ,
Enum:
{
FQDN: DestinationType Type FQDN ,
FQDNTag: DestinationType Type FQDNTag ,
IPAddress: DestinationType Type IPAddress ,
PrivateNetwork: DestinationType Type PrivateNetwork ,
}
,
Required: False ,
}
enum ,
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
transitHubResourceId:
{
Description: Transit Hub Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
CommunityEndpoints_Update (new)
Description :  Update a CommunityEndpointResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
communityEndpointName:
{
Description: The name of the Community Endpoint Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Community Endpoint Patch properties ,
Required: False ,
}
{
ruleCollection:
{
Description: Community Endpoint Rule Collection. ,
Required: False ,
}
[
{
destinationType:
{
Description: Destination Type. ,
Enum:
{
FQDN: DestinationType Type FQDN ,
FQDNTag: DestinationType Type FQDNTag ,
IPAddress: DestinationType Type IPAddress ,
PrivateNetwork: DestinationType Type PrivateNetwork ,
}
,
Required: False ,
}
enum ,
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
transitHubResourceId:
{
Description: Transit Hub Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Community Endpoint Rule Collection. ,
Required: True ,
}
[
{
destinationType:
{
Description: Destination Type. ,
Enum:
{
FQDN: DestinationType Type FQDN ,
FQDNTag: DestinationType Type FQDNTag ,
IPAddress: DestinationType Type IPAddress ,
PrivateNetwork: DestinationType Type PrivateNetwork ,
}
,
Required: False ,
}
enum ,
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
transitHubResourceId:
{
Description: Transit Hub Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 (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 ,
}
,
]
,
}
,
}
CommunityEndpoints_Delete (new)
Description :  Delete a CommunityEndpointResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
communityEndpointName:
{
Description: The name of the Community Endpoint 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 ,
}
,
]
,
}
,
}
CommunityEndpoints_HandleApprovalCreation (new)
Description :  Callback that triggers on approval state change.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}/handleApprovalCreation
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
communityEndpointName:
{
Description: The name of the Community Endpoint Resource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceRequestAction:
{
Description: Resource request action indicating action which needed to be performed upon calling approval-callback post action ,
Enum:
{
Create: No description available. ,
Delete: No description available. ,
Update: No description available. ,
Reset: No description available. ,
}
,
Required: True ,
}
enum ,
approvalStatus:
{
Description: Approval status indicating 'Approved' or 'Rejected' ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: True ,
}
enum ,
approvalCallbackPayload:
{
Description: Payload requested by client upon approval action ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
CommunityEndpoints_HandleApprovalDeletion (new)
Description :  Callback that triggers on approval deletion state change.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/communityEndpoints/{communityEndpointName}/handleApprovalDeletion
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
communityEndpointName:
{
Description: The name of the Community Endpoint Resource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceRequestAction:
{
Description: Resource request action indicating action which needed to be performed upon calling approval-deletion-callback post action ,
Enum:
{
Create: No description available. ,
Delete: No description available. ,
Update: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
TransitHub_ListByCommunityResource (new)
Description :  List TransitHubResource resources by CommunityResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TransitHubResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the transitHub. ,
Enum:
{
PendingApproval: TransitHubState Type PendingApproval ,
Approved: TransitHubState Type Approved ,
PendingUpdate: TransitHubState Type PendingUpdate ,
Active: TransitHubState Type Active ,
Failed: TransitHubState Type Failed ,
}
,
Required: False ,
}
enum ,
transitOption:
{
Description: The TransitOption of the transitHub. ,
Required: False ,
}
{
type:
{
Description: Transit Option Type. ,
Enum:
{
ExpressRoute: TransitOptionType ExpressRoute ,
Gateway: TransitOptionType Gateway ,
Peering: TransitOptionType Peering ,
}
,
Required: False ,
}
enum ,
params:
{
Description: Transit Option Params ,
Required: False ,
}
{
scaleUnits:
{
Description: Transit Option Params scaleUnits. ,
Format: int64 ,
Required: False ,
}
integer ,
remoteVirtualNetworkId:
{
Description: Transit Option Params remoteVirtualNetworkId. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
resourceCollection:
{
Description: List of resource ids modified by transitHubs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
TransitHub_Get (new)
Description :  Get a TransitHubResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs/{transitHubName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
transitHubName:
{
Description: The name of the TransitHub Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the transitHub. ,
Enum:
{
PendingApproval: TransitHubState Type PendingApproval ,
Approved: TransitHubState Type Approved ,
PendingUpdate: TransitHubState Type PendingUpdate ,
Active: TransitHubState Type Active ,
Failed: TransitHubState Type Failed ,
}
,
Required: False ,
}
enum ,
transitOption:
{
Description: The TransitOption of the transitHub. ,
Required: False ,
}
{
type:
{
Description: Transit Option Type. ,
Enum:
{
ExpressRoute: TransitOptionType ExpressRoute ,
Gateway: TransitOptionType Gateway ,
Peering: TransitOptionType Peering ,
}
,
Required: False ,
}
enum ,
params:
{
Description: Transit Option Params ,
Required: False ,
}
{
scaleUnits:
{
Description: Transit Option Params scaleUnits. ,
Format: int64 ,
Required: False ,
}
integer ,
remoteVirtualNetworkId:
{
Description: Transit Option Params remoteVirtualNetworkId. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
resourceCollection:
{
Description: List of resource ids modified by transitHubs. ,
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 ,
}
,
]
,
}
,
}
TransitHub_CreateOrUpdate (new)
Description :  Create a TransitHubResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs/{transitHubName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
transitHubName:
{
Description: The name of the TransitHub 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 status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the transitHub. ,
Enum:
{
PendingApproval: TransitHubState Type PendingApproval ,
Approved: TransitHubState Type Approved ,
PendingUpdate: TransitHubState Type PendingUpdate ,
Active: TransitHubState Type Active ,
Failed: TransitHubState Type Failed ,
}
,
Required: False ,
}
enum ,
transitOption:
{
Description: The TransitOption of the transitHub. ,
Required: False ,
}
{
type:
{
Description: Transit Option Type. ,
Enum:
{
ExpressRoute: TransitOptionType ExpressRoute ,
Gateway: TransitOptionType Gateway ,
Peering: TransitOptionType Peering ,
}
,
Required: False ,
}
enum ,
params:
{
Description: Transit Option Params ,
Required: False ,
}
{
scaleUnits:
{
Description: Transit Option Params scaleUnits. ,
Format: int64 ,
Required: False ,
}
integer ,
remoteVirtualNetworkId:
{
Description: Transit Option Params remoteVirtualNetworkId. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
resourceCollection:
{
Description: List of resource ids modified by transitHubs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the transitHub. ,
Enum:
{
PendingApproval: TransitHubState Type PendingApproval ,
Approved: TransitHubState Type Approved ,
PendingUpdate: TransitHubState Type PendingUpdate ,
Active: TransitHubState Type Active ,
Failed: TransitHubState Type Failed ,
}
,
Required: False ,
}
enum ,
transitOption:
{
Description: The TransitOption of the transitHub. ,
Required: False ,
}
{
type:
{
Description: Transit Option Type. ,
Enum:
{
ExpressRoute: TransitOptionType ExpressRoute ,
Gateway: TransitOptionType Gateway ,
Peering: TransitOptionType Peering ,
}
,
Required: False ,
}
enum ,
params:
{
Description: Transit Option Params ,
Required: False ,
}
{
scaleUnits:
{
Description: Transit Option Params scaleUnits. ,
Format: int64 ,
Required: False ,
}
integer ,
remoteVirtualNetworkId:
{
Description: Transit Option Params remoteVirtualNetworkId. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
resourceCollection:
{
Description: List of resource ids modified by transitHubs. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ 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: TransitHub Model Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the transitHub. ,
Enum:
{
PendingApproval: TransitHubState Type PendingApproval ,
Approved: TransitHubState Type Approved ,
PendingUpdate: TransitHubState Type PendingUpdate ,
Active: TransitHubState Type Active ,
Failed: TransitHubState Type Failed ,
}
,
Required: False ,
}
enum ,
transitOption:
{
Description: The TransitOption of the transitHub. ,
Required: False ,
}
{
type:
{
Description: Transit Option Type. ,
Enum:
{
ExpressRoute: TransitOptionType ExpressRoute ,
Gateway: TransitOptionType Gateway ,
Peering: TransitOptionType Peering ,
}
,
Required: False ,
}
enum ,
params:
{
Description: Transit Option Params ,
Required: False ,
}
{
scaleUnits:
{
Description: Transit Option Params scaleUnits. ,
Format: int64 ,
Required: False ,
}
integer ,
remoteVirtualNetworkId:
{
Description: Transit Option Params remoteVirtualNetworkId. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
resourceCollection:
{
Description: List of resource ids modified by transitHubs. ,
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 ,
}
,
]
,
}
,
}
TransitHub_Update (new)
Description :  Update a TransitHubResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs/{transitHubName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
transitHubName:
{
Description: The name of the TransitHub Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The TransitHub resource. ,
Required: False ,
}
{
state:
{
Description: The state of the transitHub. ,
Enum:
{
PendingApproval: TransitHubState Type PendingApproval ,
Approved: TransitHubState Type Approved ,
PendingUpdate: TransitHubState Type PendingUpdate ,
Active: TransitHubState Type Active ,
Failed: TransitHubState Type Failed ,
}
,
Required: False ,
}
enum ,
transitOption:
{
Description: The TransitOption of the transitHub. ,
Required: False ,
}
{
type:
{
Description: Transit Option Type. ,
Enum:
{
ExpressRoute: TransitOptionType ExpressRoute ,
Gateway: TransitOptionType Gateway ,
Peering: TransitOptionType Peering ,
}
,
Required: False ,
}
enum ,
params:
{
Description: Transit Option Params ,
Required: False ,
}
{
scaleUnits:
{
Description: Transit Option Params scaleUnits. ,
Format: int64 ,
Required: False ,
}
integer ,
remoteVirtualNetworkId:
{
Description: Transit Option Params remoteVirtualNetworkId. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The state of the transitHub. ,
Enum:
{
PendingApproval: TransitHubState Type PendingApproval ,
Approved: TransitHubState Type Approved ,
PendingUpdate: TransitHubState Type PendingUpdate ,
Active: TransitHubState Type Active ,
Failed: TransitHubState Type Failed ,
}
,
Required: False ,
}
enum ,
transitOption:
{
Description: The TransitOption of the transitHub. ,
Required: False ,
}
{
type:
{
Description: Transit Option Type. ,
Enum:
{
ExpressRoute: TransitOptionType ExpressRoute ,
Gateway: TransitOptionType Gateway ,
Peering: TransitOptionType Peering ,
}
,
Required: False ,
}
enum ,
params:
{
Description: Transit Option Params ,
Required: False ,
}
{
scaleUnits:
{
Description: Transit Option Params scaleUnits. ,
Format: int64 ,
Required: False ,
}
integer ,
remoteVirtualNetworkId:
{
Description: Transit Option Params remoteVirtualNetworkId. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
resourceCollection:
{
Description: List of resource ids modified by transitHubs. ,
Required: False ,
}
[
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 (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 ,
}
,
]
,
}
,
}
TransitHub_Delete (new)
Description :  Delete a TransitHubResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/communities/{communityName}/transitHubs/{transitHubName}
{
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 ,
communityName:
{
Description: The name of the communityResource Resource ,
Required: True ,
}
string ,
transitHubName:
{
Description: The name of the TransitHub 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 ,
}
,
]
,
}
,
}
EnclaveConnection_ListByResourceGroup (new)
Description :  List EnclaveConnectionResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections
{
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 EnclaveConnectionResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
state:
{
Description: The state of the enclaveConnection. ,
Enum:
{
PendingApproval: EnclaveConnectionState Type Pending Approval ,
PendingUpdate: EnclaveConnectionState Type Pending Update ,
Approved: EnclaveConnectionState Type Approved ,
Active: EnclaveConnectionState Type Active ,
Failed: EnclaveConnectionState Type Failed ,
Connected: EnclaveConnectionState Type Connected ,
Disconnected: EnclaveConnectionState Type Disconnected ,
}
,
Required: False ,
}
enum ,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Source Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceCidr:
{
Description: Source CIDR. ,
Required: False ,
}
string ,
destinationEndpointId:
{
Description: Destination Endpoint Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids modified by enclave Connections. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
EnclaveConnection_Get (new)
Description :  Get a EnclaveConnectionResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}
{
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 ,
enclaveConnectionName:
{
Description: The name of the Enclave Connection Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
state:
{
Description: The state of the enclaveConnection. ,
Enum:
{
PendingApproval: EnclaveConnectionState Type Pending Approval ,
PendingUpdate: EnclaveConnectionState Type Pending Update ,
Approved: EnclaveConnectionState Type Approved ,
Active: EnclaveConnectionState Type Active ,
Failed: EnclaveConnectionState Type Failed ,
Connected: EnclaveConnectionState Type Connected ,
Disconnected: EnclaveConnectionState Type Disconnected ,
}
,
Required: False ,
}
enum ,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Source Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceCidr:
{
Description: Source CIDR. ,
Required: False ,
}
string ,
destinationEndpointId:
{
Description: Destination Endpoint Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids modified by enclave Connections. ,
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 ,
}
,
]
,
}
,
}
EnclaveConnection_CreateOrUpdate (new)
Description :  Create a EnclaveConnectionResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}
{
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 ,
enclaveConnectionName:
{
Description: The name of the Enclave Connection Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
state:
{
Description: The state of the enclaveConnection. ,
Enum:
{
PendingApproval: EnclaveConnectionState Type Pending Approval ,
PendingUpdate: EnclaveConnectionState Type Pending Update ,
Approved: EnclaveConnectionState Type Approved ,
Active: EnclaveConnectionState Type Active ,
Failed: EnclaveConnectionState Type Failed ,
Connected: EnclaveConnectionState Type Connected ,
Disconnected: EnclaveConnectionState Type Disconnected ,
}
,
Required: False ,
}
enum ,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Source Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceCidr:
{
Description: Source CIDR. ,
Required: False ,
}
string ,
destinationEndpointId:
{
Description: Destination Endpoint Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids modified by enclave Connections. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
state:
{
Description: The state of the enclaveConnection. ,
Enum:
{
PendingApproval: EnclaveConnectionState Type Pending Approval ,
PendingUpdate: EnclaveConnectionState Type Pending Update ,
Approved: EnclaveConnectionState Type Approved ,
Active: EnclaveConnectionState Type Active ,
Failed: EnclaveConnectionState Type Failed ,
Connected: EnclaveConnectionState Type Connected ,
Disconnected: EnclaveConnectionState Type Disconnected ,
}
,
Required: False ,
}
enum ,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Source Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceCidr:
{
Description: Source CIDR. ,
Required: False ,
}
string ,
destinationEndpointId:
{
Description: Destination Endpoint Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids modified by enclave Connections. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ 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: EnclaveConnection Model Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
state:
{
Description: The state of the enclaveConnection. ,
Enum:
{
PendingApproval: EnclaveConnectionState Type Pending Approval ,
PendingUpdate: EnclaveConnectionState Type Pending Update ,
Approved: EnclaveConnectionState Type Approved ,
Active: EnclaveConnectionState Type Active ,
Failed: EnclaveConnectionState Type Failed ,
Connected: EnclaveConnectionState Type Connected ,
Disconnected: EnclaveConnectionState Type Disconnected ,
}
,
Required: False ,
}
enum ,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Source Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceCidr:
{
Description: Source CIDR. ,
Required: False ,
}
string ,
destinationEndpointId:
{
Description: Destination Endpoint Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids modified by enclave Connections. ,
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 ,
}
,
]
,
}
,
}
EnclaveConnection_Update (new)
Description :  Update a EnclaveConnectionResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}
{
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 ,
enclaveConnectionName:
{
Description: The name of the Enclave Connection Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Enclave Connection Patch properties ,
Required: False ,
}
{
sourceCidr:
{
Description: Source CIDR. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
state:
{
Description: The state of the enclaveConnection. ,
Enum:
{
PendingApproval: EnclaveConnectionState Type Pending Approval ,
PendingUpdate: EnclaveConnectionState Type Pending Update ,
Approved: EnclaveConnectionState Type Approved ,
Active: EnclaveConnectionState Type Active ,
Failed: EnclaveConnectionState Type Failed ,
Connected: EnclaveConnectionState Type Connected ,
Disconnected: EnclaveConnectionState Type Disconnected ,
}
,
Required: False ,
}
enum ,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: Source Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceCidr:
{
Description: Source CIDR. ,
Required: False ,
}
string ,
destinationEndpointId:
{
Description: Destination Endpoint Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceCollection:
{
Description: List of resource ids modified by enclave Connections. ,
Required: False ,
}
[
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 (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 ,
}
,
]
,
}
,
}
EnclaveConnection_Delete (new)
Description :  Delete a EnclaveConnectionResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}
{
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 ,
enclaveConnectionName:
{
Description: The name of the Enclave Connection 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 ,
}
,
]
,
}
,
}
EnclaveConnection_HandleApprovalCreation (new)
Description :  Callback that triggers on approval state change.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}/handleApprovalCreation
{
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 ,
enclaveConnectionName:
{
Description: The name of the Enclave Connection Resource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceRequestAction:
{
Description: Resource request action indicating action which needed to be performed upon calling approval-callback post action ,
Enum:
{
Create: No description available. ,
Delete: No description available. ,
Update: No description available. ,
Reset: No description available. ,
}
,
Required: True ,
}
enum ,
approvalStatus:
{
Description: Approval status indicating 'Approved' or 'Rejected' ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: True ,
}
enum ,
approvalCallbackPayload:
{
Description: Payload requested by client upon approval action ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
EnclaveConnection_HandleApprovalDeletion (new)
Description :  Callback that triggers on approval deletion state change.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/enclaveConnections/{enclaveConnectionName}/handleApprovalDeletion
{
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 ,
enclaveConnectionName:
{
Description: The name of the Enclave Connection Resource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceRequestAction:
{
Description: Resource request action indicating action which needed to be performed upon calling approval-deletion-callback post action ,
Enum:
{
Create: No description available. ,
Delete: No description available. ,
Update: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
VirtualEnclave_ListByResourceGroup (new)
Description :  List EnclaveResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves
{
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 EnclaveResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
enclaveVirtualNetwork:
{
Description: Virtual Network. ,
Required: True ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
enclaveAddressSpaces:
{
Description: Enclave Address Spaces ,
Required: False ,
}
{
enclaveAddressSpace:
{
Description: Enclave Address Space ,
Required: False ,
}
string ,
managedAddressSpace:
{
Description: Managed Address Space ,
Required: False ,
}
string ,
}
,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
resourceCollection:
{
Description: List of resource ids created by Virtual Enclave. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
bastionEnabled:
{
Description: Deploy Bastion service (True or False). ,
Required: False ,
}
boolean ,
enclaveRoleAssignments:
{
Description: Enclave role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
workloadRoleAssignments:
{
Description: Workload role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
governedServiceList:
{
Description: Enclave specific policies ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
enclaveDefaultSettings:
{
Description: Enclave default settings. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Key Vault Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage Account Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsResourceIdCollection:
{
Description: Log Analytics Resource Ids. ,
Required: False ,
}
[
string ,
]
,
diagnosticDestination:
{
Description: Diagnostic Destination. ,
Enum:
{
CommunityOnly: DiagnosticDestination Type CommunityOnly ,
EnclaveOnly: DiagnosticDestination Type EnclaveOnly ,
Both: DiagnosticDestination Type Both ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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 ,
}
,
]
,
}
,
}
VirtualEnclave_Get (new)
Description :  Get a EnclaveResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
enclaveVirtualNetwork:
{
Description: Virtual Network. ,
Required: True ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
enclaveAddressSpaces:
{
Description: Enclave Address Spaces ,
Required: False ,
}
{
enclaveAddressSpace:
{
Description: Enclave Address Space ,
Required: False ,
}
string ,
managedAddressSpace:
{
Description: Managed Address Space ,
Required: False ,
}
string ,
}
,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
resourceCollection:
{
Description: List of resource ids created by Virtual Enclave. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
bastionEnabled:
{
Description: Deploy Bastion service (True or False). ,
Required: False ,
}
boolean ,
enclaveRoleAssignments:
{
Description: Enclave role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
workloadRoleAssignments:
{
Description: Workload role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
governedServiceList:
{
Description: Enclave specific policies ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
enclaveDefaultSettings:
{
Description: Enclave default settings. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Key Vault Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage Account Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsResourceIdCollection:
{
Description: Log Analytics Resource Ids. ,
Required: False ,
}
[
string ,
]
,
diagnosticDestination:
{
Description: Diagnostic Destination. ,
Enum:
{
CommunityOnly: DiagnosticDestination Type CommunityOnly ,
EnclaveOnly: DiagnosticDestination Type EnclaveOnly ,
Both: DiagnosticDestination Type Both ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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 ,
}
,
]
,
}
,
}
VirtualEnclave_CreateOrUpdate (new)
Description :  Create a EnclaveResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
enclaveVirtualNetwork:
{
Description: Virtual Network. ,
Required: True ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
enclaveAddressSpaces:
{
Description: Enclave Address Spaces ,
Required: False ,
}
{
enclaveAddressSpace:
{
Description: Enclave Address Space ,
Required: False ,
}
string ,
managedAddressSpace:
{
Description: Managed Address Space ,
Required: False ,
}
string ,
}
,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
resourceCollection:
{
Description: List of resource ids created by Virtual Enclave. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
bastionEnabled:
{
Description: Deploy Bastion service (True or False). ,
Required: False ,
}
boolean ,
enclaveRoleAssignments:
{
Description: Enclave role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
workloadRoleAssignments:
{
Description: Workload role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
governedServiceList:
{
Description: Enclave specific policies ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
enclaveDefaultSettings:
{
Description: Enclave default settings. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Key Vault Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage Account Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsResourceIdCollection:
{
Description: Log Analytics Resource Ids. ,
Required: False ,
}
[
string ,
]
,
diagnosticDestination:
{
Description: Diagnostic Destination. ,
Enum:
{
CommunityOnly: DiagnosticDestination Type CommunityOnly ,
EnclaveOnly: DiagnosticDestination Type EnclaveOnly ,
Both: DiagnosticDestination Type Both ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
enclaveVirtualNetwork:
{
Description: Virtual Network. ,
Required: True ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
enclaveAddressSpaces:
{
Description: Enclave Address Spaces ,
Required: False ,
}
{
enclaveAddressSpace:
{
Description: Enclave Address Space ,
Required: False ,
}
string ,
managedAddressSpace:
{
Description: Managed Address Space ,
Required: False ,
}
string ,
}
,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
resourceCollection:
{
Description: List of resource ids created by Virtual Enclave. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
bastionEnabled:
{
Description: Deploy Bastion service (True or False). ,
Required: False ,
}
boolean ,
enclaveRoleAssignments:
{
Description: Enclave role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
workloadRoleAssignments:
{
Description: Workload role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
governedServiceList:
{
Description: Enclave specific policies ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
enclaveDefaultSettings:
{
Description: Enclave default settings. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Key Vault Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage Account Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsResourceIdCollection:
{
Description: Log Analytics Resource Ids. ,
Required: False ,
}
[
string ,
]
,
diagnosticDestination:
{
Description: Diagnostic Destination. ,
Enum:
{
CommunityOnly: DiagnosticDestination Type CommunityOnly ,
EnclaveOnly: DiagnosticDestination Type EnclaveOnly ,
Both: DiagnosticDestination Type Both ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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: Virtual Enclave Model Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
enclaveVirtualNetwork:
{
Description: Virtual Network. ,
Required: True ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
enclaveAddressSpaces:
{
Description: Enclave Address Spaces ,
Required: False ,
}
{
enclaveAddressSpace:
{
Description: Enclave Address Space ,
Required: False ,
}
string ,
managedAddressSpace:
{
Description: Managed Address Space ,
Required: False ,
}
string ,
}
,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
resourceCollection:
{
Description: List of resource ids created by Virtual Enclave. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
bastionEnabled:
{
Description: Deploy Bastion service (True or False). ,
Required: False ,
}
boolean ,
enclaveRoleAssignments:
{
Description: Enclave role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
workloadRoleAssignments:
{
Description: Workload role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
governedServiceList:
{
Description: Enclave specific policies ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
enclaveDefaultSettings:
{
Description: Enclave default settings. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Key Vault Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage Account Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsResourceIdCollection:
{
Description: Log Analytics Resource Ids. ,
Required: False ,
}
[
string ,
]
,
diagnosticDestination:
{
Description: Diagnostic Destination. ,
Enum:
{
CommunityOnly: DiagnosticDestination Type CommunityOnly ,
EnclaveOnly: DiagnosticDestination Type EnclaveOnly ,
Both: DiagnosticDestination Type Both ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
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 ,
}
,
]
,
}
,
}
VirtualEnclave_Update (new)
Description :  Update a EnclaveResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Virtual Enclave Patch properties ,
Required: False ,
}
{
enclaveVirtualNetwork:
{
Description: Virtual Network. ,
Required: False ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
bastionEnabled:
{
Description: Deploy Bastion service (True or False). ,
Required: False ,
}
boolean ,
enclaveRoleAssignments:
{
Description: Enclave role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
workloadRoleAssignments:
{
Description: Workload role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
governedServiceList:
{
Description: Enclave specific policies ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
enclaveDefaultSettings:
{
Description: Enclave default settings. ,
Required: False ,
}
{
diagnosticDestination:
{
Description: Diagnostic Destination. ,
Enum:
{
CommunityOnly: DiagnosticDestination Type CommunityOnly ,
EnclaveOnly: DiagnosticDestination Type EnclaveOnly ,
Both: DiagnosticDestination Type Both ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: False ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
type:
{
Description: The type of managed identity assigned to this resource. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The identities assigned to this resource by the user. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
enclaveVirtualNetwork:
{
Description: Virtual Network. ,
Required: True ,
}
{
networkName:
{
Description: Network Name. ,
Required: False ,
}
string ,
networkSize:
{
Description: Network Size. ,
Required: False ,
}
string ,
customCidrRange:
{
Description: Custom CIDR Range. ,
Required: False ,
}
string ,
subnetConfigurations:
{
Description: Subnet Configurations. ,
Required: False ,
}
[
{
subnetName:
{
Description: Subnet name. ,
Required: True ,
}
string ,
subnetResourceId:
{
Description: Subnet Resource ID. ,
Format: arm-id ,
Required: False ,
}
string ,
networkPrefixSize:
{
Description: Network prefix size. ,
Format: int32 ,
Required: True ,
}
integer ,
subnetDelegation:
{
Description: Subnet delegation. ,
Required: False ,
}
string ,
addressPrefix:
{
Description: Address prefix. ,
Required: False ,
}
string ,
networkSecurityGroupResourceId:
{
Description: Network security group ID. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
allowSubnetCommunication:
{
Description: Allow Subnet Communication. ,
Required: False ,
}
boolean ,
}
,
enclaveAddressSpaces:
{
Description: Enclave Address Spaces ,
Required: False ,
}
{
enclaveAddressSpace:
{
Description: Enclave Address Space ,
Required: False ,
}
string ,
managedAddressSpace:
{
Description: Managed Address Space ,
Required: False ,
}
string ,
}
,
communityResourceId:
{
Description: Community Resource Id. ,
Format: arm-id ,
Required: True ,
}
string ,
resourceCollection:
{
Description: List of resource ids created by Virtual Enclave. ,
Required: False ,
}
[
string ,
]
,
managedResourceGroupName:
{
Description: Managed resource group name. ,
Required: False ,
}
string ,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
bastionEnabled:
{
Description: Deploy Bastion service (True or False). ,
Required: False ,
}
boolean ,
enclaveRoleAssignments:
{
Description: Enclave role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
workloadRoleAssignments:
{
Description: Workload role assignments ,
Required: False ,
}
[
{
roleDefinitionId:
{
Description: Role definition identifier ,
Required: True ,
}
string ,
principals:
{
Description: List of principal IDs to which to assign this role definition ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
governedServiceList:
{
Description: Enclave specific policies ,
Required: False ,
}
[
{
serviceId:
{
Description: Service ID ,
Enum:
{
AKS: Service identifier for AKS ,
AppService: Service identifier for App Service ,
AzureFirewalls: Service identifier for Azure Firewalls ,
ContainerRegistry: Service identifier for Container Registry ,
CosmosDB: Service identifier for CosmosDB ,
DataConnectors: Service identifier for Data Connectors ,
Insights: Service identifier for Insights ,
KeyVault: Service identifier for Key Vault ,
Logic: Service identifier for Logic ,
MicrosoftSQL: Service identifier for Microsoft SQL ,
Monitoring: Service identifier for Monitoring ,
PostgreSQL: Service identifier for PostgreSQL ,
PrivateDNSZones: Service identifier for Private DNS Zones ,
ServiceBus: Service identifier for Service Bus ,
Storage: Service identifier for Storage ,
}
,
Required: True ,
}
enum ,
serviceName:
{
Description: Service name. ,
Required: False ,
}
string ,
option:
{
Description: Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
ExceptionOnly: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
enforcement:
{
Description: Initiative enforcement (Enabled or Disabled). ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
policyAction:
{
Description: Enforcement mode for policy. AuditOnly, Enforce, or None. ,
Enum:
{
AuditOnly: No description available. ,
Enforce: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
initiatives:
{
Description: Initiatives associated with this service. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
enclaveDefaultSettings:
{
Description: Enclave default settings. ,
Required: False ,
}
{
keyVaultResourceId:
{
Description: Key Vault Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
storageAccountResourceId:
{
Description: Storage Account Resource Id. ,
Format: arm-id ,
Required: False ,
}
string ,
logAnalyticsResourceIdCollection:
{
Description: Log Analytics Resource Ids. ,
Required: False ,
}
[
string ,
]
,
diagnosticDestination:
{
Description: Diagnostic Destination. ,
Enum:
{
CommunityOnly: DiagnosticDestination Type CommunityOnly ,
EnclaveOnly: DiagnosticDestination Type EnclaveOnly ,
Both: DiagnosticDestination Type Both ,
}
,
Required: False ,
}
enum ,
}
,
maintenanceModeConfiguration:
{
Description: Maintenance Mode configuration. ,
Required: False ,
}
{
mode:
{
Description: Current mode of Maintenance Mode Configuration ,
Enum:
{
On: No description available. ,
CanNotDelete: No description available. ,
Off: No description available. ,
General: No description available. ,
Advanced: No description available. ,
}
,
Required: True ,
}
enum ,
principals:
{
Description: The user, group or service principal object affected by Maintenance Mode ,
Required: False ,
}
[
{
id:
{
Description: The object id associated with the principal ,
Required: True ,
}
string ,
type:
{
Description: The type of the object id. We currently allow users, groups, and service principals ,
Enum:
{
User: No description available. ,
Group: No description available. ,
ServicePrincipal: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
justification:
{
Description: Justification for entering or exiting Maintenance Mode ,
Enum:
{
Networking: No description available. ,
Governance: No description available. ,
Off: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 (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 ,
}
,
]
,
}
,
}
VirtualEnclave_Delete (new)
Description :  Delete a EnclaveResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource 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 ,
}
,
]
,
}
,
}
EnclaveEndpoints_ListByEnclaveResource (new)
Description :  List EnclaveEndpointResource resources by EnclaveResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EnclaveEndpointResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Enclave Endpoint Rule Collection. ,
Required: True ,
}
[
{
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
EnclaveEndpoints_Get (new)
Description :  Get a EnclaveEndpointResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
enclaveEndpointName:
{
Description: The name of the Enclave Endpoint Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Enclave Endpoint Rule Collection. ,
Required: True ,
}
[
{
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
EnclaveEndpoints_CreateOrUpdate (new)
Description :  Create a EnclaveEndpointResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
enclaveEndpointName:
{
Description: The name of the Enclave Endpoint Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Enclave Endpoint Rule Collection. ,
Required: True ,
}
[
{
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Enclave Endpoint Rule Collection. ,
Required: True ,
}
[
{
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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: EnclaveEndpoint Model Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Enclave Endpoint Rule Collection. ,
Required: True ,
}
[
{
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
EnclaveEndpoints_Update (new)
Description :  Update a EnclaveEndpointResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
enclaveEndpointName:
{
Description: The name of the Enclave Endpoint Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Enclave Endpoint Patch properties ,
Required: False ,
}
{
ruleCollection:
{
Description: Enclave Endpoint Rule Collection. ,
Required: False ,
}
[
{
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ruleCollection:
{
Description: Enclave Endpoint Rule Collection. ,
Required: True ,
}
[
{
protocols:
{
Description: Protocols. Options specified by Endpoint Protocol Enum. ,
Required: False ,
}
[
string ,
]
,
endpointRuleName:
{
Description: Endpoint Rule Name. ,
Required: False ,
}
string ,
destination:
{
Description: Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. ,
Required: False ,
}
string ,
ports:
{
Description: Port. Can include multiple ports separated by commas or a range indicated by a hyphen. ,
Required: False ,
}
string ,
}
,
]
,
resourceCollection:
{
Description: List of resource ids created by community endpoint. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 (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 ,
}
,
]
,
}
,
}
EnclaveEndpoints_Delete (new)
Description :  Delete a EnclaveEndpointResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
enclaveEndpointName:
{
Description: The name of the Enclave Endpoint 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 ,
}
,
]
,
}
,
}
EnclaveEndpoints_HandleApprovalCreation (new)
Description :  Callback that triggers on approval state change.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}/handleApprovalCreation
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
enclaveEndpointName:
{
Description: The name of the Enclave Endpoint Resource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceRequestAction:
{
Description: Resource request action indicating action which needed to be performed upon calling approval-callback post action ,
Enum:
{
Create: No description available. ,
Delete: No description available. ,
Update: No description available. ,
Reset: No description available. ,
}
,
Required: True ,
}
enum ,
approvalStatus:
{
Description: Approval status indicating 'Approved' or 'Rejected' ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: True ,
}
enum ,
approvalCallbackPayload:
{
Description: Payload requested by client upon approval action ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
EnclaveEndpoints_HandleApprovalDeletion (new)
Description :  Callback that triggers on approval deletion state change.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/enclaveEndpoints/{enclaveEndpointName}/handleApprovalDeletion
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
enclaveEndpointName:
{
Description: The name of the Enclave Endpoint Resource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceRequestAction:
{
Description: Resource request action indicating action which needed to be performed upon calling approval-deletion-callback post action ,
Enum:
{
Create: No description available. ,
Delete: No description available. ,
Update: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
VirtualEnclave_HandleApprovalCreation (new)
Description :  Callback that triggers on approval state change.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/handleApprovalCreation
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceRequestAction:
{
Description: Resource request action indicating action which needed to be performed upon calling approval-callback post action ,
Enum:
{
Create: No description available. ,
Delete: No description available. ,
Update: No description available. ,
Reset: No description available. ,
}
,
Required: True ,
}
enum ,
approvalStatus:
{
Description: Approval status indicating 'Approved' or 'Rejected' ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: True ,
}
enum ,
approvalCallbackPayload:
{
Description: Payload requested by client upon approval action ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
VirtualEnclave_HandleApprovalDeletion (new)
Description :  Callback that triggers on approval deletion state change.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/handleApprovalDeletion
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
resourceRequestAction:
{
Description: Resource request action indicating action which needed to be performed upon calling approval-deletion-callback post action ,
Enum:
{
Create: No description available. ,
Delete: No description available. ,
Update: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
message:
{
Description: Confirmation message indicating the result of the operation. ,
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 (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 ,
}
,
]
,
}
,
}
Workload_ListByEnclaveResource (new)
Description :  List WorkloadResource resources by EnclaveResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceGroupCollection:
{
Description: List of resource group ids. ,
Required: False ,
}
[
string ,
]
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Workload_Get (new)
Description :  Get a WorkloadResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads/{workloadName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
workloadName:
{
Description: The name of the workloadResource Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceGroupCollection:
{
Description: List of resource group ids. ,
Required: False ,
}
[
string ,
]
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
Workload_CreateOrUpdate (new)
Description :  Create a WorkloadResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads/{workloadName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
workloadName:
{
Description: The name of the workloadResource Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceGroupCollection:
{
Description: List of resource group ids. ,
Required: False ,
}
[
string ,
]
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceGroupCollection:
{
Description: List of resource group ids. ,
Required: False ,
}
[
string ,
]
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ 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: Workload Model Resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceGroupCollection:
{
Description: List of resource group ids. ,
Required: False ,
}
[
string ,
]
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
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 ,
}
,
]
,
}
,
}
Workload_Update (new)
Description :  Update a WorkloadResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads/{workloadName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
workloadName:
{
Description: The name of the workloadResource Resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: Workload Patch properties ,
Required: False ,
}
{
resourceGroupCollection:
{
Description: List of resource group ids. ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Provisioning State Type Accepted ,
Creating: Provisioning State Type Creating ,
Deleting: Provisioning State Type Deleting ,
NotSpecified: Provisioning State Type NotSpecified ,
Running: Provisioning State Type Running ,
Updating: Provisioning State Type Updating ,
}
,
Required: False ,
}
enum ,
resourceGroupCollection:
{
Description: List of resource group ids. ,
Required: False ,
}
[
string ,
]
,
managedOnBehalfOfConfiguration:
{
Description: Managed On Behalf Of Configuration. ,
Required: False ,
}
{
moboBrokerResources:
{
Description: Managed-On-Behalf-Of broker resources ,
Required: False ,
}
[
{
id:
{
Description: Resource identifier of a Managed-On-Behalf-Of broker resource ,
Format: arm-id ,
Required: False ,
}
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 (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 ,
}
,
]
,
}
,
}
Workload_Delete (new)
Description :  Delete a WorkloadResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Mission/virtualEnclaves/{virtualEnclaveName}/workloads/{workloadName}
{
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 ,
virtualEnclaveName:
{
Description: The name of the enclaveResource Resource ,
Required: True ,
}
string ,
workloadName:
{
Description: The name of the workloadResource 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 ,
}
,
]
,
}
,
}