Create Azure File Share Instance

Select

SaaS

This API creates an Azure File Share Instance.

application/json

Request Body

oneOf

• CreateAzureFileInstance-Saas
• CreateAzureFileInstance-CustomerManaged

---

name string required

ObjectStorage instance name.

plan object required

id integer

name string

credential object required

id integer

name string

contents object

path array

Optional list of files and folders to be added as content. Defaults to /

exclusions array

Optional list of files and folders to exclude

exceptions array

Optional list of files and folders to be added to the exceptions list

hostURL string

Optional. Defaults to file.core.windows.net

region object required

id integer

name string

accessNodes array

id integer

Id of ObjectStorage access node. This could be a Client id or Client Group id.

name string

Name of ObjectStorage access node. This could be a Client name or Client Group name.

type string

Possible values - "client" for Access nodes and "clientGroup" for Access node group. If not passed, it is defaulted to "client".

name string required

ObjectStorage instance name.

plan object required

id integer

name string

credential object required

id integer

name string

contents object

path array

Optional list of files and folders to be added as content. Defaults to /

exclusions array

Optional list of files and folders to exclude

exceptions array

Optional list of files and folders to be added to the exceptions list

hostURL string

Optional. Defaults to file.core.windows.net

accessNodes array required

id integer

Id of ObjectStorage access node. This could be a Client id or Client Group id.

name string

Name of ObjectStorage access node. This could be a Client name or Client Group name.

type string

Possible values - "client" for Access nodes and "clientGroup" for Access node group. If not passed, it is defaulted to "client".

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• id integer
• name string

{
  "id": 0,
  "name": "string"
}

POST /v4/azurefile/instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "name": "string",
  "plan": {
    "id": 0,
    "name": "string"
  },
  "credential": {
    "id": 0,
    "name": "string"
  },
  "contents": {
    "path": [
      null
    ],
    "exclusions": [
      null
    ],
    "exceptions": [
      null
    ]
  },
  "hostURL": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "accessNodes": [
    null
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azurefile/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "plan": {
    "id": 0,
    "name": "string"
  },
  "credential": {
    "id": 0,
    "name": "string"
  },
  "contents": {
    "path": [
      null
    ],
    "exclusions": [
      null
    ],
    "exceptions": [
      null
    ]
  },
  "hostURL": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "accessNodes": [
    null
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azurefile/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "plan": {
    "id": 0,
    "name": "string"
  },
  "credential": {
    "id": 0,
    "name": "string"
  },
  "contents": {
    "path": [
      null
    ],
    "exclusions": [
      null
    ],
    "exceptions": [
      null
    ]
  },
  "hostURL": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "accessNodes": [
    null
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azurefile/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "plan": {
    "id": 0,
    "name": "string"
  },
  "credential": {
    "id": 0,
    "name": "string"
  },
  "contents": {
    "path": [
      null
    ],
    "exclusions": [
      null
    ],
    "exceptions": [
      null
    ]
  },
  "hostURL": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "accessNodes": [
    null
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azurefile/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "plan": {
    "id": 0,
    "name": "string"
  },
  "credential": {
    "id": 0,
    "name": "string"
  },
  "contents": {
    "path": [
      null
    ],
    "exclusions": [
      null
    ],
    "exceptions": [
      null
    ]
  },
  "hostURL": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "accessNodes": [
    null
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azurefile/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "plan": {
    "id": 0,
    "name": "string"
  },
  "credential": {
    "id": 0,
    "name": "string"
  },
  "contents": {
    "path": [
      null
    ],
    "exclusions": [
      null
    ],
    "exceptions": [
      null
    ]
  },
  "hostURL": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "accessNodes": [
    null
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azurefile/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "plan": {
    "id": 0,
    "name": "string"
  },
  "credential": {
    "id": 0,
    "name": "string"
  },
  "contents": {
    "path": [
      null
    ],
    "exclusions": [
      null
    ],
    "exceptions": [
      null
    ]
  },
  "hostURL": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "accessNodes": [
    null
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azurefile/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "plan": {
    "id": 0,
    "name": "string"
  },
  "credential": {
    "id": 0,
    "name": "string"
  },
  "contents": {
    "path": [
      null
    ],
    "exclusions": [
      null
    ],
    "exceptions": [
      null
    ]
  },
  "hostURL": "string",
  "region": {
    "id": 0,
    "name": "string"
  },
  "accessNodes": [
    null
  ]
}'