Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit159f69c

Browse files
Merge pull request#614 from cloudops/feature/MC-24453-update-api-docs-azure-resource-groups
MC-24453: Update API-docs for Azure plugin, support for resource groups
2 parents381d9ed +61fc0b7 commit159f69c

File tree

7 files changed

+38
-1
lines changed

7 files changed

+38
-1
lines changed

‎source/includes/azure/_clusters.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ curl -X GET \
2323
"id":"/subscriptions/9e548d49-7d56-452c-8fc8-e81a25d05ddf/resourcegroups/azure-connect-system-ssamadh-mean-env/providers/Microsoft.ContainerService/managedClusters/ssamadh-aks-mean",
2424
"name":"ssamadh-basic",
2525
"version":"premium_lrs",
26+
"resourceGroupName":"rg-name",
2627
"region":"southeastasia",
2728
"nodePools":"4",
2829
"totalNodes":"7",
@@ -31,6 +32,7 @@ curl -X GET \
3132
"id":"/subscriptions/ 803c8d4a-80ca-4793-8def-89b5f55d1091/resourcegroups/azure-connect-system-ssamadh-mean-env/providers/Microsoft.ContainerService/managedClusters/ssamadh-aks-mean",
3233
"name":"ssamadh-basic",
3334
"version":"premium_lrs",
35+
"resourceGroupName":"rg-name",
3436
"region":"southeastasia",
3537
"nodePools":"2",
3638
"totalNodes":"3",
@@ -77,6 +79,7 @@ curl -X GET \
7779
"id":"/subscriptions/9e548d49-7d56-452c-8fc8-e81a25d05ddf/resourcegroups/azure-connect-system-ssamadh-mean-env/providers/Microsoft.ContainerService/managedClusters/ssamadh-aks-mean",
7880
"name":"ssamadh-basic",
7981
"version":"premium_lrs",
82+
"resourceGroupName":"rg-name",
8083
"region":"southeastasia",
8184
"nodePools":"4",
8285
"totalNodes":"7",
@@ -98,6 +101,7 @@ Attributes |  
98101
`totalNodes`<br/>*int* | The total number of nodes across all nodePools
99102
`rbacEnabled`<br/>*boolean* | Indicates of RBAC is enabled for this kubernetes cluster
100103
`endpoint`<br/>*string* | The fully qualified domain name (fqdn) for the master pool
104+
`resourceGroupName` <br/>*string* | The resource group name.
101105
`region`<br/>*string* | The resource location
102106
`version` <br/>*string* | The version of kubernetes running in the cluster
103107

@@ -124,6 +128,7 @@ curl -X POST \
124128
"primaryPoolNodeCount":1,
125129
"vmScaleSetsEnabled":false,
126130
"rbacEnabled":false,
131+
"resourceGroupName":"rg-name",
127132
"region":"canadacentral",
128133
"name":"kub_root_nzk",
129134
"sshkey":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCguvgDRuUF/wijOJCNmYlQHujCmUHl/i0Ubos4nHy5uCBdn1LGF+PG3TpJqO1LUWqpHaPl4yN7bpsdXyq6a9nxe0C1bQ4FK6P5qm0X320uvqv34jwTPsIbnhw9I317df+xJyXXsL/P5vS4ULPMC5UZjWm4BYe7did4zmXXhA/zmLY6cUg19sZp5r5SUQcf5xHAqO3cQVZwzBhBMwroflZZ59zNpxy+xXPBqC3IdusF2yTDW7bwCQHESUOsd9XhwrzCB+1wETKjLpk0wkWj8G2j1pkKGRpv60QcG85lbZvQAg54v3HYD7fVJCaz9gJJoiyRBnqQ6XVxam5bZgiMKa0J johndoe@machine.local"
@@ -170,6 +175,7 @@ Required | &nbsp;
170175
`primaryPoolNodeCount`<br/>*string* | The number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive).
171176
`primaryPoolNodeType`<br/>*string* | The size type of each virtual machine in the agent pool.
172177
`rbacEnabled`<br/>*boolean* | A boolean to indicate whether RBAC should be enabled on this cluster or not.
178+
`resourceGroupName` <br/>*string* | The resource group name.
173179
`region`<br/>*string* | The name of the region for the cluster.
174180
`sshkey`<br/>*string* | The ssh key public portion that will be used to access cluster.
175181
`version` <br/>*string* | The version for the Kubernetes cluster.

‎source/includes/azure/_disks.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ curl -X GET \
2323
"id":"/subscriptions/6b6a1f27-55c1-4b1d-969b-60a3c9eebe64/resourceGroups/azure-connect-system-ssamadh-mean-env/providers/Microsoft.Compute/disks/ssamadh-basic",
2424
"name":"ssamadh-basic",
2525
"type":"premium_lrs",
26+
"resourceGroupName":"rg-name",
2627
"region":"southeastasia",
2728
"state":"unattached",
2829
"provisioningState":"succeeded",
@@ -38,6 +39,7 @@ curl -X GET \
3839
"name":"the-sheep_disk1_e93bd2519aac4c0cbe27c49aa928525e",
3940
"type":"premium_lrs",
4041
"osType":"Linux",
42+
"resourceGroupName":"rg-name",
4143
"region":"eastasia",
4244
"instanceId":"/subscriptions/6b6a1f27-55c1-4b1d-969b-60a3c9eebe64/resourceGroups/azure-connect-system-ssamadh-mean-env/providers/Microsoft.Compute/virtualMachines/the-sheep",
4345
"instance":"the-sheep",
@@ -84,6 +86,7 @@ curl -X GET \
8486
"name":"the-sheep_disk1_e93bd2519aac4c0cbe27c49aa928525e",
8587
"type":"premium_lrs",
8688
"osType":"Linux",
89+
"resourceGroupName":"rg-name",
8790
"region":"eastasia",
8891
"instanceId":"/subscriptions/6b6a1f27-55c1-4b1d-969b-60a3c9eebe64/resourceGroups/azure-connect-system-ssamadh-mean-env/providers/Microsoft.Compute/virtualMachines/the-sheep",
8992
"instance":"the-sheep",
@@ -107,6 +110,7 @@ Attributes | &nbsp;
107110
`id`<br/>*string* | The id of the disk. This is a canonized id from azure which is the form of`/subscriptions/${subscriptionid}/resourceGroups/${resourcegroup}/providers/Microsoft.Compute/disks/${diskName}`
108111
`name`<br/>*string* | The display name of the disk
109112
`type`<br/>*string* | The managed disk type. Can be one of the following:`premium_lrs`_(Premium SSD)_,`standard_lrs`_(Standard HDD)_,`standardssd_lrs`_(Standard SSD)_ or`ultrassd_lrs`_(Ultra SSD)_
113+
`resourceGroupName` <br/>*string* | The resource group name.
110114
`region`<br/>*string* | The regional location in which the disk was instantiated
111115
`instanceId`<br/>*string* | The id of the instance to which the disk is attached to. This is a canonized id from azure which is the form of`/subscriptions/${subscriptionid}/resourceGroups/${resourcegroup}/providers/Microsoft.Compute/virtualMachines/${instanceName}`
112116
`instance`<br/>*string* | The name of the instance to which the disk is attached to_(available only if the disk is attached to an instance)_
@@ -135,6 +139,7 @@ curl -X POST \
135139
```json
136140
{
137141
"name":"ad_root_smean",
142+
"resourceGroupName":"rg-name",
138143
"region":"northeurope",
139144
"type":"ultrassd_lrs",
140145
"sizeGb":"200",
@@ -161,6 +166,7 @@ Create a disk in an [environment](#administration-environments).
161166
Attributes |&nbsp;
162167
---------- | -----
163168
`name`<br/>*string* | The name of the azure disk. Supported characters for the name are`a-z`,`A-Z`,`0-9` and`_`; The maximum name length is 80 characters
169+
`resourceGroupName` <br/>*string* | The resource group name.
164170
`region`<br/>*string* | The azure region in which the disk is to be created. See list of regions[here](https://azure.microsoft.com/en-ca/global-infrastructure/regions/)
165171
`type`<br/>*string* | The managed disk type. Can be one of the following:<br>`premium_lrs`,`standard_lrs`,`standardssd_lrs`,`ultrassd_lrs`
166172
`sizeGb`<br/>*string* | The size of the disk

‎source/includes/azure/_instances.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ curl -X GET \
2929
"imageVersion":"1000.0.0",
3030
"osType":"Linux",
3131
"displayImage":"CoreOS - Alpha",
32+
"resourceGroupName":"rg-name",
3233
"region":"canadacentral",
3334
"privateIp":"10.0.0.4",
3435
"macAddress":"00-0D-3A-84-0B-EF",
@@ -72,6 +73,7 @@ Attributes | &nbsp;
7273
`imageVersion`<br/>*string* | The image version that was used to create the instance.
7374
`displayImage`<br/>*string* | Displayable value of the image information.
7475
`osType`<br/>*string* | The OS type of the instance. This can be either Windows or Linux.
76+
`resourceGroupName` <br/>*string* | The resource group name.
7577
`region`<br/>*string* | The region in which the instance is located.
7678
`privateIp`<br/>*string* | The private ip address assigned to the instance.
7779
`internalFqdn`<br/>*string* | The internal FQDN assigned to the instance.
@@ -113,6 +115,7 @@ curl -X GET \
113115
"imageVersion":"1000.0.0",
114116
"osType":"Linux",
115117
"displayImage":"CoreOS - Alpha",
118+
"resourceGroupName":"rg-name",
116119
"region":"canadacentral",
117120
"privateIp":"10.0.0.4",
118121
"macAddress":"00-0D-3A-0B-F2-96",
@@ -152,6 +155,7 @@ Attributes | &nbsp;
152155
`imageVersion`<br/>*string* | The image version that was used to create the instance.
153156
`osType`<br/>*string* | The OS type of the instance. This can be either Windows or Linux.
154157
`displayImage`<br/>*string* | Displayable value of the image information.
158+
`resourceGroupName` <br/>*string* | The resource group name.
155159
`region`<br/>*string* | The region in which the instance is located.
156160
`privateIp`<br/>*string* | The private ip address assigned to the instance.
157161
`internalFqdn`<br/>*string* | The internal FQDN assigned to the instance.
@@ -190,6 +194,7 @@ curl -X POST \
190194
"imageOffer":"CoreOS",
191195
"imageSku":"Stable",
192196
"imageVersion":"1010.5.0",
197+
"resourceGroupName":"rg-name",
193198
"region":"canadacentral",
194199
"subnet":"/subscriptions/subscriptionId/resourceGroups/cmc-example/providers/Microsoft.Network/virtualNetworks/vn_example_lud/subnets/default",
195200
"username":"johndoe",
@@ -204,6 +209,7 @@ curl -X POST \
204209
"imageOffer":"CoreOS",
205210
"imageSku":"Stable",
206211
"imageVersion":"1010.5.0",
212+
"resourceGroupName":"rg-name",
207213
"region":"canadacentral",
208214
"subnet":"/subscriptions/subscriptionId/resourceGroups/cmc-example/providers/Microsoft.Network/virtualNetworks/vn_example_lud/subnets/default",
209215
"username":"johndoe",
@@ -252,6 +258,7 @@ Required | &nbsp;
252258
`imageOffer`<br/>*string* | The image offer that was used to create the instance.
253259
`imageSku`<br/>*string* | The image SKU that was used to create the instance.
254260
`imageVersion`<br/>*string* | The image version that was used to create the instance.
261+
`resourceGroupName` <br/>*string* | The resource group name.
255262
`region`<br/>*string* | The region in which the instance is located.
256263
`subnet`<br/>*string* | The subnet id that the instance will be part of.
257264
`username`<br/>*string* | The administrator username which will be created on the instance. It cannot be a reserve user such as admin, root or administrator and must not be more than 20 characters.

‎source/includes/azure/_network_security_groups.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ curl -X GET \
1919
{
2020
"id":"/subscriptions/subscription/resourceGroups/example-system-azure-example/providers/Microsoft.Network/networksecuritygroups/sample-network-security-group",
2121
"name":"sample-network-security-group",
22+
"resourceGroupName":"rg-name",
2223
"region":"canadacentral",
2324
"provisioningState":"Succeeded",
2425
"defaultSecurityRules": [
@@ -48,6 +49,7 @@ Attributes | &nbsp;
4849
---------- | -----
4950
`id`<br/>*string* | The id associated to the network security group. This is a canonized id from azure which is the form of`/subscriptions/:subscriptionid/resourceGroups/:resourcegroup/providers/Microsoft.Network/networksecuritygroups/:networkSecurityGroupName`
5051
`name`<br/>*string* | The name of the network security group.
52+
`resourceGroupName` <br/>*string* | The resource group name.
5153
`region`<br/>*string* | The region in which the network security group is located
5254
`provisioningState`<br/>*string* | The provisioning state of the network security group. Possible values are : Succeeded, Updating, Deleting and Failed
5355
`defaultSecurityRules`<br/>*List* | The default security rules of network security group
@@ -66,7 +68,8 @@ curl -X POST \
6668
'http://cloudmc_endpoint/v1/services/azure/my-azure/networkSecurityGroups' \
6769
-H'mc-api-key: your_api_key' \
6870
-d'{
69-
"name": "network-security-group",
71+
"name": "network-security-group",
72+
"resourceGroupName": "rg-name",
7073
"region": "eastus"
7174
}'
7275
```
@@ -78,6 +81,7 @@ Create a new network security group.
7881
Required |&nbsp;
7982
------- | -----------
8083
`name` <br/>*string* | The name of the network security group. The name cannot exceed 64 characters
84+
`resourceGroupName` <br/>*string* | The resource group name.
8185
`region`<br/>*string* | The region in which the network security group is located
8286

8387
####Delete a network security group

‎source/includes/azure/_networks.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ curl -X GET \
1919
{
2020
"id":"/subscriptions/subscription/resourceGroups/example-system-azure-example/providers/Microsoft.Network/virtualNetworks/sample-network",
2121
"name":"sample-network",
22+
"resourceGroupName":"rg-name",
2223
"region":"canadacentral",
2324
"provisioningState":"Succeeded",
2425
"addressSpace": [
@@ -45,6 +46,7 @@ Attributes | &nbsp;
4546
---------- | -----
4647
`id`<br/>*string* | The id associated to the virtual network. This is a canonized id from azure which is the form of`/subscriptions/:subscriptionid/resourceGroups/:resourcegroup/providers/Microsoft.Network/virtualNetworks/:networkName`
4748
`name`<br/>*string* | The name of the virtual network
49+
`resourceGroupName` <br/>*string* | The resource group name.
4850
`region`<br/>*string* | The region in which the virtual network is located
4951
`provisioningState`<br/>*string* | The provisioning state of the virtual network. Possible values are : Succeeded, Updating, Deleting and Failed
5052
`addressSpace`<br/>*list* | List of address space that are covered by this virtual network
@@ -65,6 +67,7 @@ curl -X POST \
6567
```json
6668
{
6769
"name":"simpleNetwork",
70+
"resourceGroupName":"rg-name",
6871
"region" :"canadaeast",
6972
"addressSpace":"10.0.0.0/16",
7073
"subnetName":"default",
@@ -79,6 +82,7 @@ Create a virtual network in an [environment](#administration-environments).
7982
Attributes |&nbsp;
8083
---------- | -----
8184
`name`<br/>*string* | The name of the virtual network
85+
`resourceGroupName` <br/>*string* | The resource group name.
8286
`region`<br/>*string* | The region in which the virtual network is located
8387
`addressSpace`<br/>*string* | The first address range (IPV4 CIDR format) that will be covered by this virtual network
8488
`subnetName`<br/>*string* | The first subnet name within this virtual network

‎source/includes/azure/_public_ip_addresses.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ curl -X GET \
2121
"name":"some-public-ip",
2222
"state":"DETACHED",
2323
"ipAddress":"52.122.12.1",
24+
"resourceGroupName":"rg-name",
2425
"region":"eastus",
2526
"domainName":"somepublicip",
2627
"fqdn":"somepublicip.eastus.cloudapp.azure.com",
@@ -46,6 +47,7 @@ Attributes | &nbsp;
4647
`name` <br/>*string* | The name of the public IP address.
4748
`state` <br/>*string* | The state of the public IP address. Possible state:`ATTACHED`,`DETACHED`,`UPDATING`,`DELETING`.
4849
`ipAddress` <br/>*string* | The IP address of the public IP. If the public IP has never been associated before, then you won't have an ip address yet.
50+
`resourceGroupName` <br/>*string* | The resource group name.
4951
`region` <br/>*string* | The region where the public IP address is located.
5052
`sku` <br />*string* | The sku of the public IP. Possible values:`BASIC`,`STANDARD`.
5153
`domainName` <br/>*string* | The subdomain part of the fqdn. This is only present if one is defined.
@@ -72,6 +74,7 @@ curl -X GET \
7274
"name":"some-public-ip",
7375
"state":"DETACHED",
7476
"ipAddress":"52.122.12.1",
77+
"resourceGroupName":"rg-name",
7578
"region":"eastus",
7679
"domainName":"somepublicip",
7780
"fqdn":"somepublicip.eastus.cloudapp.azure.com",
@@ -93,6 +96,7 @@ Attributes | &nbsp;
9396
`name` <br/>*string* | The name of the public IP address.
9497
`state` <br/>*string* | The state of the public IP address. Possible state:`ATTACHED`,`DETACHED`,`UPDATING`,`DELETING`.
9598
`ipAddress` <br/>*string* | The IP address of the public IP. If the public IP has never been associated before, then you won't have an ip address yet.
99+
`resourceGroupName` <br/>*string* | The resource group name.
96100
`region` <br/>*string* | The region where the public IP address is located.
97101
`sku` <br />*string* | The sku of the public IP. Possible values:`BASIC`,`STANDARD`.
98102
`domainName` <br/>*string* | The subdomain part of the fqdn. This is only present if one is defined.
@@ -116,6 +120,7 @@ curl -X POST \
116120
```json
117121
{
118122
"name":"samplePublicIP",
123+
"resourceGroupName":"rg-name",
119124
"region" :"canadacentral",
120125
"sku":"BASIC",
121126
"allocationMethod" :"DYNAMIC",
@@ -131,6 +136,7 @@ Create a public IP address in a given [environment](#administration-environments
131136
Required |&nbsp;
132137
------- | -----------
133138
`name` <br/>*string* | The name of the public IP address.
139+
`resourceGroupName` <br/>*string* | The resource group name.
134140
`region` <br/>*string* | The region where the public IP address is located.
135141

136142
Optional |&nbsp;

‎source/includes/azure/_subnets.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ curl -X GET \
2424
"availableAddresses":248,
2525
"totalNumberIps":251,
2626
"id":"/subscriptions/:subscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/example-vnet/subnets/example-subnet",
27+
"resourceGroupName":"rg-name",
2728
"region":"eastus",
2829
"name":"example-subnet"
2930
}
@@ -48,6 +49,7 @@ Attributes | &nbsp;
4849
`parentNetworkId` <br/>*string* | The id for the parent network.
4950
`parentNetworkName` <br/>*string* | The name for the parent network.
5051
`name`<br/>*string* | The name of the subnet.
52+
`resourceGroupName` <br/>*string* | The resource group name.
5153
`region`<br/>*string* | The region in which the parent of the subnet is located.
5254
`allocatedAddresses`<br/>*int* | The number of allocated addresses in the subnet.
5355
`availableAddresses`<br/>*int* | The number of available ip addresses in the subnet.
@@ -86,6 +88,7 @@ curl -X GET \
8688
"availableAddresses":248,
8789
"totalNumberIps":251,
8890
"id":"/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/example-vnet/subnets/example-subnet",
91+
"resourceGroupName":"rg-name",
8992
"region":"eastus",
9093
"name":"example-subnet",
9194
"networkSecurityGroupName":"test-rg",
@@ -113,6 +116,7 @@ Attributes | &nbsp;
113116
`parentNetworkId` <br/>*string* | The id for the parent network.
114117
`parentNetworkName` <br/>*string* | The name for the parent network.
115118
`name`<br/>*string* | The name of the subnet.
119+
`resourceGroupName` <br/>*string* | The resource group name.
116120
`region`<br/>*string* | The region in which the parent of the subnet is located.
117121
`allocatedAddresses`<br/>*int* | The number of allocated addresses in the subnet.
118122
`availableAddresses`<br/>*int* | The number of available ip addresses in the subnet.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp