@datafire/azure_containerservices_containerservice v5.0.0
@datafire/azure_containerservices_containerservice
Client library for ContainerServiceClient
Installation and Usage
npm install --save @datafire/azure_containerservices_containerservice
let azure_containerservices_containerservice = require('@datafire/azure_containerservices_containerservice').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
The Container Service Client.
Actions
ContainerServices_List
Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
azure_containerservices_containerservice.ContainerServices_List({
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- api-version required
Output
- output ContainerServiceListResult
ContainerServices_ListByResourceGroup
Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
azure_containerservices_containerservice.ContainerServices_ListByResourceGroup({
"resourceGroupName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ContainerServiceListResult
ContainerServices_Delete
Deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually.
azure_containerservices_containerservice.ContainerServices_Delete({
"resourceGroupName": "",
"containerServiceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - containerServiceName required
string
: The name of the container service in the specified subscription and resource group. - api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
Output schema unknown
ContainerServices_Get
Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.
azure_containerservices_containerservice.ContainerServices_Get({
"resourceGroupName": "",
"containerServiceName": "",
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - containerServiceName required
string
: The name of the container service in the specified subscription and resource group. - api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ContainerService
ContainerServices_CreateOrUpdate
Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.
azure_containerservices_containerservice.ContainerServices_CreateOrUpdate({
"resourceGroupName": "",
"containerServiceName": "",
"parameters": null,
"api-version": "",
"subscriptionId": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group. - containerServiceName required
string
: The name of the container service in the specified subscription and resource group. - parameters required ContainerService
- api-version required
string
: Client Api Version. - subscriptionId required
string
: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- resourceGroupName required
Output
- output ContainerService
Definitions
ContainerService
- ContainerService: Container service.
- id
string
: Resource Id - location required
string
: Resource location - name
string
: Resource name - tags
object
: Resource tags - type
string
: Resource type - properties ContainerServiceProperties
- id
ContainerServiceAgentPoolProfile
- ContainerServiceAgentPoolProfile
object
: Profile for the container service agent pool.- count
integer
: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. - dnsPrefix
string
: DNS prefix to be used to create the FQDN for the agent pool. - fqdn
string
: FQDN for the agent pool. - name required
string
: Unique name of the agent pool profile in the context of the subscription and resource group. - osDiskSizeGB ContainerServiceOSDisk
- osType OSType
- ports
array
: Ports number array used to expose on this agent pool. The default opened ports are different based on your choice of orchestrator.- items
integer
- items
- storageProfile ContainerServiceStorageProfile
- vmSize required ContainerServiceVMSize
- vnetSubnetID ContainerServiceVnetSubnetID
- count
ContainerServiceCustomProfile
- ContainerServiceCustomProfile
object
: Properties to configure a custom container service cluster.- orchestrator required
string
: The name of the custom orchestrator to use.
- orchestrator required
ContainerServiceDiagnosticsProfile
- ContainerServiceDiagnosticsProfile
object
: Profile for diagnostics on the container service cluster.- vmDiagnostics required ContainerServiceVMDiagnostics
ContainerServiceLinuxProfile
- ContainerServiceLinuxProfile
object
: Profile for Linux VMs in the container service cluster.- adminUsername required
string
: The administrator username to use for Linux VMs. - ssh required ContainerServiceSshConfiguration
- adminUsername required
ContainerServiceListResult
- ContainerServiceListResult
object
: The response from the List Container Services operation.- nextLink
string
: The URL to get the next set of container service results. - value
array
: The list of container services.- items ContainerService
- nextLink
ContainerServiceMasterProfile
- ContainerServiceMasterProfile
object
: Profile for the container service master.- count
integer
(values: 1, 3, 5): Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. - dnsPrefix required
string
: DNS prefix to be used to create the FQDN for the master pool. - firstConsecutiveStaticIP
string
: FirstConsecutiveStaticIP used to specify the first static ip of masters. - fqdn
string
: FQDN for the master pool. - osDiskSizeGB ContainerServiceOSDisk
- storageProfile ContainerServiceStorageProfile
- vmSize required ContainerServiceVMSize
- vnetSubnetID ContainerServiceVnetSubnetID
- count
ContainerServiceOSDisk
- ContainerServiceOSDisk
integer
: OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.
ContainerServiceOrchestratorProfile
- ContainerServiceOrchestratorProfile
object
: Profile for the container service orchestrator.- orchestratorType required
string
(values: Kubernetes, Swarm, DCOS, DockerCE, Custom): The orchestrator to use to manage container service cluster resources. Valid values are Kubernetes, Swarm, DCOS, DockerCE and Custom. - orchestratorVersion
string
: The version of the orchestrator to use. You can specify the major.minor.patch part of the actual version.For example, you can specify version as "1.6.11".
- orchestratorType required
ContainerServiceProperties
- ContainerServiceProperties
object
: Properties of the container service.- agentPoolProfiles
array
: Properties of the agent pool. - customProfile ContainerServiceCustomProfile
- diagnosticsProfile ContainerServiceDiagnosticsProfile
- linuxProfile required ContainerServiceLinuxProfile
- masterProfile required ContainerServiceMasterProfile
- orchestratorProfile required ContainerServiceOrchestratorProfile
- provisioningState
string
: The current deployment or provisioning state, which only appears in the response. - servicePrincipalProfile ContainerServiceServicePrincipalProfile
- windowsProfile ContainerServiceWindowsProfile
- agentPoolProfiles
ContainerServiceServicePrincipalProfile
- ContainerServiceServicePrincipalProfile
object
: Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified.- clientId required
string
: The ID for the service principal. - keyVaultSecretRef KeyVaultSecretRef
- secret
string
: The secret password associated with the service principal in plain text.
- clientId required
ContainerServiceSshConfiguration
- ContainerServiceSshConfiguration
object
: SSH configuration for Linux-based VMs running on Azure.- publicKeys required
array
: The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified.
- publicKeys required
ContainerServiceSshPublicKey
- ContainerServiceSshPublicKey
object
: Contains information about SSH certificate public key data.- keyData required
string
: Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.
- keyData required
ContainerServiceStorageProfile
- ContainerServiceStorageProfile
string
(values: StorageAccount, ManagedDisks): Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice.
ContainerServiceVMDiagnostics
- ContainerServiceVMDiagnostics
object
: Profile for diagnostics on the container service VMs.- enabled required
boolean
: Whether the VM diagnostic agent is provisioned on the VM. - storageUri
string
: The URI of the storage account where diagnostics are stored.
- enabled required
ContainerServiceVMSize
- ContainerServiceVMSize
string
(values: Standard_A1, Standard_A10, Standard_A11, Standard_A1_v2, Standard_A2, Standard_A2_v2, Standard_A2m_v2, Standard_A3, Standard_A4, Standard_A4_v2, Standard_A4m_v2, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A8_v2, Standard_A8m_v2, Standard_A9, Standard_B2ms, Standard_B2s, Standard_B4ms, Standard_B8ms, Standard_D1, Standard_D11, Standard_D11_v2, Standard_D11_v2_Promo, Standard_D12, Standard_D12_v2, Standard_D12_v2_Promo, Standard_D13, Standard_D13_v2, Standard_D13_v2_Promo, Standard_D14, Standard_D14_v2, Standard_D14_v2_Promo, Standard_D15_v2, Standard_D16_v3, Standard_D16s_v3, Standard_D1_v2, Standard_D2, Standard_D2_v2, Standard_D2_v2_Promo, Standard_D2_v3, Standard_D2s_v3, Standard_D3, Standard_D32_v3, Standard_D32s_v3, Standard_D3_v2, Standard_D3_v2_Promo, Standard_D4, Standard_D4_v2, Standard_D4_v2_Promo, Standard_D4_v3, Standard_D4s_v3, Standard_D5_v2, Standard_D5_v2_Promo, Standard_D64_v3, Standard_D64s_v3, Standard_D8_v3, Standard_D8s_v3, Standard_DS1, Standard_DS11, Standard_DS11_v2, Standard_DS11_v2_Promo, Standard_DS12, Standard_DS12_v2, Standard_DS12_v2_Promo, Standard_DS13, Standard_DS13-2_v2, Standard_DS13-4_v2, Standard_DS13_v2, Standard_DS13_v2_Promo, Standard_DS14, Standard_DS14-4_v2, Standard_DS14-8_v2, Standard_DS14_v2, Standard_DS14_v2_Promo, Standard_DS15_v2, Standard_DS1_v2, Standard_DS2, Standard_DS2_v2, Standard_DS2_v2_Promo, Standard_DS3, Standard_DS3_v2, Standard_DS3_v2_Promo, Standard_DS4, Standard_DS4_v2, Standard_DS4_v2_Promo, Standard_DS5_v2, Standard_DS5_v2_Promo, Standard_E16_v3, Standard_E16s_v3, Standard_E2_v3, Standard_E2s_v3, Standard_E32-16s_v3, Standard_E32-8s_v3, Standard_E32_v3, Standard_E32s_v3, Standard_E4_v3, Standard_E4s_v3, Standard_E64-16s_v3, Standard_E64-32s_v3, Standard_E64_v3, Standard_E64s_v3, Standard_E8_v3, Standard_E8s_v3, Standard_F1, Standard_F16, Standard_F16s, Standard_F16s_v2, Standard_F1s, Standard_F2, Standard_F2s, Standard_F2s_v2, Standard_F32s_v2, Standard_F4, Standard_F4s, Standard_F4s_v2, Standard_F64s_v2, Standard_F72s_v2, Standard_F8, Standard_F8s, Standard_F8s_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS4-4, Standard_GS4-8, Standard_GS5, Standard_GS5-16, Standard_GS5-8, Standard_H16, Standard_H16m, Standard_H16mr, Standard_H16r, Standard_H8, Standard_H8m, Standard_L16s, Standard_L32s, Standard_L4s, Standard_L8s, Standard_M128-32ms, Standard_M128-64ms, Standard_M128ms, Standard_M128s, Standard_M64-16ms, Standard_M64-32ms, Standard_M64ms, Standard_M64s, Standard_NC12, Standard_NC12s_v2, Standard_NC12s_v3, Standard_NC24, Standard_NC24r, Standard_NC24rs_v2, Standard_NC24rs_v3, Standard_NC24s_v2, Standard_NC24s_v3, Standard_NC6, Standard_NC6s_v2, Standard_NC6s_v3, Standard_ND12s, Standard_ND24rs, Standard_ND24s, Standard_ND6s, Standard_NV12, Standard_NV24, Standard_NV6): Size of agent VMs.
ContainerServiceVnetSubnetID
- ContainerServiceVnetSubnetID
string
: VNet SubnetID specifies the VNet's subnet identifier.
ContainerServiceWindowsProfile
- ContainerServiceWindowsProfile
object
: Profile for Windows VMs in the container service cluster.- adminPassword required
string
: The administrator password to use for Windows VMs. - adminUsername required
string
: The administrator username to use for Windows VMs.
- adminPassword required
KeyVaultSecretRef
- KeyVaultSecretRef
object
: Reference to a secret stored in Azure Key Vault.- secretName required
string
: The secret name. - vaultID required
string
: Key vault identifier. - version
string
: The secret version.
- secretName required
OSType
- OSType
string
(values: Linux, Windows): OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
Resource
- Resource
object
: The Resource model definition.- id
string
: Resource Id - location required
string
: Resource location - name
string
: Resource name - tags
object
: Resource tags - type
string
: Resource type
- id