Microsoft.ServiceFabricMesh (preview:2018-09-01)

2025/09/19 • 36 new, 36 deleted methods

Operations_List (new)
Description :  Lists all the available operations provided by Service Fabric SeaBreeze resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceFabricMesh/operations
{
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Name of the operation provider. ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource on which the operation is available. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the available operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the available operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin result ,
Required: False ,
}
string ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
{
serviceSpecification:
{
Description: Resource metrics service provided by Microsoft.Insights resource provider. ,
Required: False ,
}
{
metricSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
displayDescription:
{
Required: False ,
}
string ,
unit:
{
Required: False ,
}
string ,
aggregationType:
{
Required: False ,
}
string ,
supportsInstanceLevelAggregation:
{
Required: False ,
}
boolean ,
enableRegionalMdmAccount:
{
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Required: False ,
}
string ,
sourceMdmNamespace:
{
Required: False ,
}
string ,
metricFilterPattern:
{
Required: False ,
}
string ,
fillGapWithZero:
{
Required: False ,
}
boolean ,
isInternal:
{
Required: False ,
}
boolean ,
dimensions:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
internalName:
{
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Required: False ,
}
boolean ,
}
,
]
,
category:
{
Required: False ,
}
string ,
availabilities:
{
Required: False ,
}
[
{
timeGrain:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
}
,
]
,
supportedTimeGrainTypes:
{
Required: False ,
}
[
string ,
]
,
supportedAggregationTypes:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
logSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
logFilterPattern:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_Create (new)
Description :  Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretResourceDescription:
{
Description: Description for creating a secret resource. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_Get (new)
Description :  Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_Delete (new)
Description :  Deletes the secret resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_ListByResourceGroup (new)
Description :  Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_ListBySubscription (new)
Description :  Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/secrets
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_Create (new)
Description :  Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretValueResourceName:
{
Description: The name of the secret resource value which is typically the version identifier for the value. ,
Required: True ,
}
string ,
secretValueResourceDescription:
{
Description: Description for creating a value of a secret resource. ,
Required: True ,
}
{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_Get (new)
Description :  Get the information about the specified named secret value resources. The information does not include the actual value of the secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretValueResourceName:
{
Description: The name of the secret resource value which is typically the version identifier for the value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_Delete (new)
Description :  Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretValueResourceName:
{
Description: The name of the secret resource value which is typically the version identifier for the value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_List (new)
Description :  Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_ListValue (new)
Description :  Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}/list_value
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretValueResourceName:
{
Description: The name of the secret resource value which is typically the version identifier for the value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The actual value of the secret. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_Create (new)
Description :  Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
volumeResourceName:
{
Description: The identity of the volume. ,
Required: True ,
}
string ,
volumeResourceDescription:
{
Description: Description for creating a Volume resource. ,
Required: True ,
}
{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_Get (new)
Description :  Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
volumeResourceName:
{
Description: The identity of the volume. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_Delete (new)
Description :  Deletes the volume resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
volumeResourceName:
{
Description: The identity of the volume. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_ListByResourceGroup (new)
Description :  Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_ListBySubscription (new)
Description :  Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_Create (new)
Description :  Creates a network resource with the specified name, description and properties. If a network resource with the same name exists, then it is updated with the specified description and properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
networkResourceName:
{
Description: The identity of the network. ,
Required: True ,
}
string ,
networkResourceDescription:
{
Description: Description for creating a Network resource. ,
Required: True ,
}
{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_Get (new)
Description :  Gets the information about the network resource with the given name. The information include the description and other properties of the network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
networkResourceName:
{
Description: The identity of the network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_Delete (new)
Description :  Deletes the network resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
networkResourceName:
{
Description: The identity of the network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_ListByResourceGroup (new)
Description :  Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_ListBySubscription (new)
Description :  Gets the information about all network resources in a given resource group. The information include the description and other properties of the network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_Create (new)
Description :  Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways/{gatewayResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
gatewayResourceName:
{
Description: The identity of the gateway. ,
Required: True ,
}
string ,
gatewayResourceDescription:
{
Description: Description for creating a Gateway resource. ,
Required: True ,
}
{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_Get (new)
Description :  Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways/{gatewayResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
gatewayResourceName:
{
Description: The identity of the gateway. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_Delete (new)
Description :  Deletes the gateway resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways/{gatewayResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
gatewayResourceName:
{
Description: The identity of the gateway. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_ListByResourceGroup (new)
Description :  Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_ListBySubscription (new)
Description :  Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/gateways
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_Create (new)
Description :  Creates an application resource with the specified name, description and properties. If an application resource with the same name exists, then it is updated with the specified description and properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
applicationResourceDescription:
{
Description: Description for creating a Application resource. ,
Required: True ,
}
{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_Get (new)
Description :  Gets the information about the application resource with the given name. The information include the description and other properties of the application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_Delete (new)
Description :  Deletes the application resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_ListByResourceGroup (new)
Description :  Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_ListBySubscription (new)
Description :  Gets the information about all application resources in a given resource group. The information include the description and other properties of the application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/applications
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Service_Get (new)
Description :  Gets the information about the service resource with the given name. The information include the description and other properties of the service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
serviceResourceName:
{
Description: The identity of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a service resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Service_List (new)
Description :  Gets the information about all services of an application resource. The information include the description and other properties of the Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a service resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
ServiceReplica_Get (new)
Description :  Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
serviceResourceName:
{
Description: The identity of the service. ,
Required: True ,
}
string ,
replicaName:
{
Description: Service Fabric replica name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
replicaName:
{
Description: Name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
ServiceReplica_List (new)
Description :  Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
serviceResourceName:
{
Description: The identity of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
replicaName:
{
Description: Name of the replica. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
CodePackage_GetContainerLogs (new)
Description :  Gets the logs for the container of the specified code package of the service replica.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
serviceResourceName:
{
Description: The identity of the service. ,
Required: True ,
}
string ,
replicaName:
{
Description: Service Fabric replica name. ,
Required: True ,
}
string ,
codePackageName:
{
Description: The name of code package of the service. ,
Required: True ,
}
string ,
tail:
{
Description: Number of lines to show from the end of the logs. Default is 100. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
content:
{
Description: Container logs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all the available operations provided by Service Fabric SeaBreeze resource provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ServiceFabricMesh/operations
{
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider. ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Name of the operation provider. ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource on which the operation is available. ,
Required: False ,
}
string ,
operation:
{
Description: Name of the available operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the available operation. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin result ,
Required: False ,
}
string ,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
{
serviceSpecification:
{
Description: Resource metrics service provided by Microsoft.Insights resource provider. ,
Required: False ,
}
{
metricSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
displayDescription:
{
Required: False ,
}
string ,
unit:
{
Required: False ,
}
string ,
aggregationType:
{
Required: False ,
}
string ,
supportsInstanceLevelAggregation:
{
Required: False ,
}
boolean ,
enableRegionalMdmAccount:
{
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Required: False ,
}
string ,
sourceMdmNamespace:
{
Required: False ,
}
string ,
metricFilterPattern:
{
Required: False ,
}
string ,
fillGapWithZero:
{
Required: False ,
}
boolean ,
isInternal:
{
Required: False ,
}
boolean ,
dimensions:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
internalName:
{
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Required: False ,
}
boolean ,
}
,
]
,
category:
{
Required: False ,
}
string ,
availabilities:
{
Required: False ,
}
[
{
timeGrain:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
}
,
]
,
supportedTimeGrainTypes:
{
Required: False ,
}
[
string ,
]
,
supportedAggregationTypes:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
logSpecifications:
{
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
displayName:
{
Required: False ,
}
string ,
blobDuration:
{
Required: False ,
}
string ,
logFilterPattern:
{
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_Create (removed)
Description :  Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretResourceDescription:
{
Description: Description for creating a secret resource. ,
Required: True ,
}
{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_Get (removed)
Description :  Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_Delete (removed)
Description :  Deletes the secret resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_ListByResourceGroup (removed)
Description :  Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Secret_ListBySubscription (removed)
Description :  Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/secrets
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: Describes the properties of a secret resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the secret. ,
Required: False ,
}
string ,
status:
{
Description: Status of the resource. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the secret. ,
Required: False ,
}
string ,
contentType:
{
Description: The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_Create (removed)
Description :  Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretValueResourceName:
{
Description: The name of the secret resource value which is typically the version identifier for the value. ,
Required: True ,
}
string ,
secretValueResourceDescription:
{
Description: Description for creating a value of a secret resource. ,
Required: True ,
}
{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_Get (removed)
Description :  Get the information about the specified named secret value resources. The information does not include the actual value of the secret.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretValueResourceName:
{
Description: The name of the secret resource value which is typically the version identifier for the value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_Delete (removed)
Description :  Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretValueResourceName:
{
Description: The name of the secret resource value which is typically the version identifier for the value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_List (removed)
Description :  Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a secret value resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
SecretValue_ListValue (removed)
Description :  Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}/list_value
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
secretResourceName:
{
Description: The name of the secret resource. ,
Required: True ,
}
string ,
secretValueResourceName:
{
Description: The name of the secret resource value which is typically the version identifier for the value. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The actual value of the secret. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_Create (removed)
Description :  Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
volumeResourceName:
{
Description: The identity of the volume. ,
Required: True ,
}
string ,
volumeResourceDescription:
{
Description: Description for creating a Volume resource. ,
Required: True ,
}
{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_Get (removed)
Description :  Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
volumeResourceName:
{
Description: The identity of the volume. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_Delete (removed)
Description :  Deletes the volume resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
volumeResourceName:
{
Description: The identity of the volume. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_ListByResourceGroup (removed)
Description :  Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Volume_ListBySubscription (removed)
Description :  Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a volume resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_Create (removed)
Description :  Creates a network resource with the specified name, description and properties. If a network resource with the same name exists, then it is updated with the specified description and properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
networkResourceName:
{
Description: The identity of the network. ,
Required: True ,
}
string ,
networkResourceDescription:
{
Description: Description for creating a Network resource. ,
Required: True ,
}
{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_Get (removed)
Description :  Gets the information about the network resource with the given name. The information include the description and other properties of the network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
networkResourceName:
{
Description: The identity of the network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_Delete (removed)
Description :  Deletes the network resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
networkResourceName:
{
Description: The identity of the network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_ListByResourceGroup (removed)
Description :  Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Network_ListBySubscription (removed)
Description :  Gets the information about all network resources in a given resource group. The information include the description and other properties of the network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: Describes properties of a network resource. ,
Required: True ,
}
{
description:
{
Description: User readable description of the network. ,
Required: False ,
}
string ,
status:
{
Description: Status of the network. ,
Enum:
{
Unknown: Indicates the resource status is unknown. The value is zero. ,
Ready: Indicates the resource is ready. The value is 1. ,
Upgrading: Indicates the resource is upgrading. The value is 2. ,
Creating: Indicates the resource is being created. The value is 3. ,
Deleting: Indicates the resource is being deleted. The value is 4. ,
Failed: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Gives additional information about the current status of the network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_Create (removed)
Description :  Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways/{gatewayResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
gatewayResourceName:
{
Description: The identity of the gateway. ,
Required: True ,
}
string ,
gatewayResourceDescription:
{
Description: Description for creating a Gateway resource. ,
Required: True ,
}
{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_Get (removed)
Description :  Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways/{gatewayResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
gatewayResourceName:
{
Description: The identity of the gateway. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_Delete (removed)
Description :  Deletes the gateway resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways/{gatewayResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
gatewayResourceName:
{
Description: The identity of the gateway. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_ListByResourceGroup (removed)
Description :  Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Gateway_ListBySubscription (removed)
Description :  Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/gateways
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a gateway resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_Create (removed)
Description :  Creates an application resource with the specified name, description and properties. If an application resource with the same name exists, then it is updated with the specified description and properties.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
applicationResourceDescription:
{
Description: Description for creating a Application resource. ,
Required: True ,
}
{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_Get (removed)
Description :  Gets the information about the application resource with the given name. The information include the description and other properties of the application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_Delete (removed)
Description :  Deletes the application resource identified by the name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_ListByResourceGroup (removed)
Description :  Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Application_ListBySubscription (removed)
Description :  Gets the information about all application resources in a given resource group. The information include the description and other properties of the application.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/applications
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of an application resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Service_Get (removed)
Description :  Gets the information about the service resource with the given name. The information include the description and other properties of the service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
serviceResourceName:
{
Description: The identity of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: This type describes properties of a service resource. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
Service_List (removed)
Description :  Gets the information about all services of an application resource. The information include the description and other properties of the Service.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
properties:
{
Description: This type describes properties of a service resource. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
ServiceReplica_Get (removed)
Description :  Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
serviceResourceName:
{
Description: The identity of the service. ,
Required: True ,
}
string ,
replicaName:
{
Description: Service Fabric replica name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
replicaName:
{
Description: Name of the replica. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
ServiceReplica_List (removed)
Description :  Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
serviceResourceName:
{
Description: The identity of the service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: One page of the list. ,
Required: False ,
}
[
{
replicaName:
{
Description: Name of the replica. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: URI to fetch the next page of the list. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
CodePackage_GetContainerLogs (removed)
Description :  Gets the logs for the container of the specified code package of the service replica.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs
{
subscriptionId:
{
Description: The customer subscription identifier ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Azure resource group name ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`. ,
Required: True ,
}
string ,
applicationResourceName:
{
Description: The identity of the application. ,
Required: True ,
}
string ,
serviceResourceName:
{
Description: The identity of the service. ,
Required: True ,
}
string ,
replicaName:
{
Description: Service Fabric replica name. ,
Required: True ,
}
string ,
codePackageName:
{
Description: The name of code package of the service. ,
Required: True ,
}
string ,
tail:
{
Description: Number of lines to show from the end of the logs. Default is 100. ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
content:
{
Description: Container logs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error model information ,
Required: True ,
}
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
details:
{
Description: List of error message details. ,
Required: False ,
}
[
{
code:
{
Required: True ,
}
string ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}