managed_namespaces

Creates, updates, deletes, gets or lists a managed_namespaces resource.

Overview

Name	`managed_namespaces`
Type	Resource
Id	`azure.container_service.managed_namespaces`

Fields

The following fields are returned by SELECT queries:

get
list_by_managed_cluster

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`adoptionPolicy`	`string`	Action if Kubernetes namespace with same name already exists. Known values are: "Never", "IfIdentical", and "Always". (Never, IfIdentical, Always)
`annotations`	`object`	The annotations of managed namespace.
`defaultNetworkPolicy`	`object`	The default network policy enforced upon the namespace. Customers can have other Kubernetes network policy objects under the namespace. Network policies are additive; if a policy or policies apply to a given pod for a given direction, the connections allowed in that direction for the pod is the union of what all applicable policies allow.
`defaultResourceQuota`	`object`	The default resource quota enforced upon the namespace. Customers can have other Kubernetes resource quota objects under the namespace. Resource quotas are additive; if multiple resource quotas are applied to a given namespace, then the effective limit will be one such that all quotas on the namespace can be satisfied.
`deletePolicy`	`string`	Delete options of a namespace. Known values are: "Keep" and "Delete". (Keep, Delete)
`eTag`	`string`	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
`labels`	`object`	The labels of managed namespace.
`location`	`string`	The geo-location where the resource lives. Required.
`portalFqdn`	`string`	The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients. The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.
`provisioningState`	`string`	The current provisioning state of the namespace. Known values are: "Updating", "Deleting", "Creating", "Succeeded", "Failed", and "Canceled". (Updating, Deleting, Creating, Succeeded, Failed, Canceled)
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`adoptionPolicy`	`string`	Action if Kubernetes namespace with same name already exists. Known values are: "Never", "IfIdentical", and "Always". (Never, IfIdentical, Always)
`annotations`	`object`	The annotations of managed namespace.
`defaultNetworkPolicy`	`object`	The default network policy enforced upon the namespace. Customers can have other Kubernetes network policy objects under the namespace. Network policies are additive; if a policy or policies apply to a given pod for a given direction, the connections allowed in that direction for the pod is the union of what all applicable policies allow.
`defaultResourceQuota`	`object`	The default resource quota enforced upon the namespace. Customers can have other Kubernetes resource quota objects under the namespace. Resource quotas are additive; if multiple resource quotas are applied to a given namespace, then the effective limit will be one such that all quotas on the namespace can be satisfied.
`deletePolicy`	`string`	Delete options of a namespace. Known values are: "Keep" and "Delete". (Keep, Delete)
`eTag`	`string`	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
`labels`	`object`	The labels of managed namespace.
`location`	`string`	The geo-location where the resource lives. Required.
`portalFqdn`	`string`	The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients. The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.
`provisioningState`	`string`	The current provisioning state of the namespace. Known values are: "Updating", "Deleting", "Creating", "Succeeded", "Failed", and "Canceled". (Updating, Deleting, Creating, Succeeded, Failed, Canceled)
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`get`	`select`	`resource_group_name`, `resource_name`, `managed_namespace_name`, `subscription_id`	Gets the specified namespace of a managed cluster.
`list_by_managed_cluster`	`select`	`resource_group_name`, `resource_name`, `subscription_id`	Gets a list of managed namespaces in the specified managed cluster.
`create_or_update`	`insert`	`resource_group_name`, `resource_name`, `managed_namespace_name`, `subscription_id`, `location`	Creates or updates a namespace managed by ARM for the specified managed cluster. Users can configure aspects like resource quotas, network ingress/egress policies, and more. See aka.ms/aks/managed-namespaces for more details.
`update`	`update`	`resource_group_name`, `resource_name`, `managed_namespace_name`, `subscription_id`	Updates tags on a managed namespace.
`create_or_update`	`replace`	`resource_group_name`, `resource_name`, `managed_namespace_name`, `subscription_id`, `location`	Creates or updates a namespace managed by ARM for the specified managed cluster. Users can configure aspects like resource quotas, network ingress/egress policies, and more. See aka.ms/aks/managed-namespaces for more details.
`delete`	`delete`	`resource_group_name`, `resource_name`, `managed_namespace_name`, `subscription_id`	Deletes a namespace.
`list_credential`	`exec`	`resource_group_name`, `resource_name`, `managed_namespace_name`, `subscription_id`	Lists the credentials of a namespace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`managed_namespace_name`	`string`	The name of the managed namespace. Required.
`resource_group_name`	`string`	The name of the resource group. The name is case insensitive. Required.
`resource_name`	`string`	The name of the managed cluster resource. Required.
`subscription_id`	`string`

`SELECT` examples

get
list_by_managed_cluster

Gets the specified namespace of a managed cluster.

SELECT
id,
name,
adoptionPolicy,
annotations,
defaultNetworkPolicy,
defaultResourceQuota,
deletePolicy,
eTag,
labels,
location,
portalFqdn,
provisioningState,
systemData,
tags,
type
FROM azure.container_service.managed_namespaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND managed_namespace_name = '{{ managed_namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Gets a list of managed namespaces in the specified managed cluster.

SELECT
id,
name,
adoptionPolicy,
annotations,
defaultNetworkPolicy,
defaultResourceQuota,
deletePolicy,
eTag,
labels,
location,
portalFqdn,
provisioningState,
systemData,
tags,
type
FROM azure.container_service.managed_namespaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

`INSERT` examples

create_or_update
Manifest

Creates or updates a namespace managed by ARM for the specified managed cluster. Users can configure aspects like resource quotas, network ingress/egress policies, and more. See aka.ms/aks/managed-namespaces for more details.

INSERT INTO azure.container_service.managed_namespaces (
tags,
location,
properties,
resource_group_name,
resource_name,
managed_namespace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ managed_namespace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type
;

# Description fields are for documentation purposes
- name: managed_namespaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_namespaces resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the managed_namespaces resource.
  - name: managed_namespace_name
    value: "{{ managed_namespace_name }}"
    description: Required parameter for the managed_namespaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_namespaces resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of a namespace.
    value:
      provisioningState: "{{ provisioningState }}"
      labels: "{{ labels }}"
      annotations: "{{ annotations }}"
      portalFqdn: "{{ portalFqdn }}"
      defaultResourceQuota:
        cpuRequest: "{{ cpuRequest }}"
        cpuLimit: "{{ cpuLimit }}"
        memoryRequest: "{{ memoryRequest }}"
        memoryLimit: "{{ memoryLimit }}"
      defaultNetworkPolicy:
        ingress: "{{ ingress }}"
        egress: "{{ egress }}"
      adoptionPolicy: "{{ adoptionPolicy }}"
      deletePolicy: "{{ deletePolicy }}"

`UPDATE` examples

update

Updates tags on a managed namespace.

UPDATE azure.container_service.managed_namespaces
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND managed_namespace_name = '{{ managed_namespace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type;

`REPLACE` examples

create_or_update

REPLACE azure.container_service.managed_namespaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND managed_namespace_name = '{{ managed_namespace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type;

`DELETE` examples

delete

Deletes a namespace.

DELETE FROM azure.container_service.managed_namespaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND managed_namespace_name = '{{ managed_namespace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_credential

Lists the credentials of a namespace.

EXEC azure.container_service.managed_namespaces.list_credential 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@managed_namespace_name='{{ managed_namespace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​